include/KDIS/PDU/Simulation_Management/Start_Resume_PDU.hpp

   1 /*********************************************************************
   2 Copyright 2013 Karl Jones
   3 All rights reserved.
   4
   5 Redistribution and use in source and binary forms, with or without
   6 modification, are permitted provided that the following conditions are met:
   7
   8 1. Redistributions of source code must retain the above copyright notice, this
   9    list of conditions and the following disclaimer.
  10 2. Redistributions in binary form must reproduce the above copyright notice,
  11    this list of conditions and the following disclaimer in the documentation
  12    and/or other materials provided with the distribution.
  13
  14 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
  15 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  16 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  17 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
  18 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  19 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  20 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  21 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  23 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24
  25 For Further Information Please Contact me at
  26 Karljj1@yahoo.com
  27 http://p.sf.net/kdis/UserGuide
  28 *********************************************************************/
  29
  30 /********************************************************************
  31     class:      Start_Resume_PDU
  32     DIS:        (5) 1278.1 - 1995
  33     created:    22/09/2008
  34     author:     Karl Jones
  35
  36     purpose:    Indicates a start resume status to the entity/exercise
  37     size:       352 bits / 44 octets
  38 *********************************************************************/
  39
  40 #pragma once
  41
  42 #include "./Simulation_Management_Header.h"
  43 #include "./../../DataTypes/ClockTime.h"
  44
  45 namespace KDIS {
  46 namespace PDU {
  47
  48 class KDIS_EXPORT Start_Resume_PDU : public Simulation_Management_Header
  49 {
  50 protected:
  51
  52     KDIS::DATA_TYPE::ClockTime m_RealWorldTime;
  53
  54     KDIS::DATA_TYPE::ClockTime m_SimTime;
  55
  56     KUINT32 m_ui32RequestID;
  57
  58 public:
  59
  60     static const KUINT16 START_RESUME_PDU_SIZE = 44;
  61
  62     Start_Resume_PDU();
  63
  64     explicit Start_Resume_PDU( const Header & H );
  65
  66     Start_Resume_PDU( KDataStream & stream ) ;
  67
  68     Start_Resume_PDU( const Header & H, KDataStream & stream ) ;
  69
  70     Start_Resume_PDU( const KDIS::DATA_TYPE::EntityIdentifier & ReceivingEntity, const KDIS::DATA_TYPE::EntityIdentifier & SupplyingEntity,
  71                       const KDIS::DATA_TYPE::ClockTime & RealWorldTime, const KDIS::DATA_TYPE::ClockTime & SimTime, KUINT32 ReqID );
  72
  73     Start_Resume_PDU( const Simulation_Management_Header & SimMgrHeader, const KDIS::DATA_TYPE::ClockTime & RealWorldTime,
  74                       const KDIS::DATA_TYPE::ClockTime & SimTime, KUINT32 ReqID  );
  75
  76     virtual ~Start_Resume_PDU();
  77
  78     //************************************
  79     // FullName:    KDIS::PDU::Start_Resume_PDU::SetRealWorldTime
  80     //              KDIS::PDU::Start_Resume_PDU::GetRealWorldTime
  81     // Description: specify the real-world time at which the entity
  82     //              is to start/resume in the exercise.
  83     // Parameter:   const ClockTime & T
  84     //************************************
  85     void  SetRealWorldTime( const KDIS::DATA_TYPE::ClockTime & T );
  86     const KDIS::DATA_TYPE::ClockTime & GetRealWorldTime() const;
  87     KDIS::DATA_TYPE::ClockTime & GetRealWorldTime();
  88
  89     //************************************
  90     // FullName:    KDIS::PDU::Start_Resume_PDU::SetSimulationTime
  91     //              KDIS::PDU::Start_Resume_PDU::GetSimulationTime
  92     // Description: specify the simulation time at which the entity
  93     //              is to start/resume in the exercises.
  94     // Parameter:   const ClockTime & T
  95     //************************************
  96     void SetSimulationTime( const KDIS::DATA_TYPE::ClockTime & T );
  97     const KDIS::DATA_TYPE::ClockTime & GetSimulationTime() const;
  98     KDIS::DATA_TYPE::ClockTime & GetSimulationTime();
  99
 100     //************************************
 101     // FullName:    KDIS::PDU::Start_Resume_PDU::SetRequestID
 102     //              KDIS::PDU::Start_Resume_PDU::GetRequestID
 103     // Description: Request ID
 104     // Parameter:   KUINT32 ID
 105     //************************************
 106     void SetRequestID( KUINT32 ID );
 107     KUINT32 GetRequestID() const;
 108
 109     //************************************
 110     // FullName:    KDIS::PDU::Start_Resume_PDU::GetAsString
 111     // Description: Returns a string representation of the PDU.
 112     //************************************
 113     virtual KString GetAsString() const;
 114
 115     //************************************
 116     // FullName:    KDIS::PDU::Start_Resume_PDU::Decode
 117     // Description: Convert From Network Data.
 118     // Parameter:   KDataStream & stream
 119     // Parameter:   bool ignoreHeader = false - Decode the header from the stream?
 120     //************************************
 121     virtual void Decode( KDataStream & stream, bool ignoreHeader = false ) ;
 122
 123     //************************************
 124     // FullName:    KDIS::PDU::Start_Resume_PDU::Encode
 125     // Description: Convert To Network Data.
 126     //************************************
 127     virtual KDataStream Encode() const;
 128     virtual void Encode( KDataStream & stream ) const;
 129
 130     KBOOL operator == ( const Start_Resume_PDU & Value ) const;
 131     KBOOL operator != ( const Start_Resume_PDU & Value ) const;
 132 };
 133
 134 } // END namespace PDU
 135 } // END namespace KDIS