include/KDIS/PDU/Simulation_Management/Action_Response_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:      Action_Response_PDU
  32     DIS:        (5) 1278.1 - 1995
  33     created:    2008/10/19
  34     author:     Karl Jones
  35
  36     purpose:    Communicates a response to a Action Request PDU
  37     size:       320 bits/ 40 octets - not including variable param sizes
  38 *********************************************************************/
  39
  40 #pragma once
  41
  42 #include "./Data_PDU.h"
  43 #include "./Action_Request_PDU.h"
  44
  45 namespace KDIS {
  46 namespace PDU {
  47
  48 class KDIS_EXPORT Action_Response_PDU : public Data_PDU
  49 {
  50 protected:
  51
  52     KUINT32 m_ui32RequestStatus;
  53
  54 public:
  55
  56     static const KUINT16 ACTION_RESPONSE_PDU_SIZE = 40;
  57
  58     Action_Response_PDU();
  59
  60     explicit Action_Response_PDU( const Header & H );
  61
  62     Action_Response_PDU( KDataStream & stream ) ;
  63
  64     Action_Response_PDU( const Header & H, KDataStream & stream ) ;
  65
  66     // Generate a response from a PDU.
  67     Action_Response_PDU( const Action_Request_PDU & pdu, KDIS::DATA_TYPE::ENUMS::RequestStatus RS );
  68
  69     virtual ~Action_Response_PDU();
  70
  71     //************************************
  72     // FullName:    KDIS::PDU::Action_Response_PDU::SetRequestStatus
  73     //              KDIS::PDU::Action_Response_PDU::GetRequestStatus
  74     // Description: Identifies the status of the request action
  75     // Parameter:   RequestStatus RS
  76     //************************************
  77     void SetRequestStatus( KDIS::DATA_TYPE::ENUMS::RequestStatus RS );
  78     KDIS::DATA_TYPE::ENUMS::RequestStatus GetRequestStatus() const;
  79
  80     //************************************
  81     // FullName:    KDIS::PDU::Action_Response_PDU::GetAsString
  82     // Description: Returns a string representation of the PDU.
  83     //************************************
  84     virtual KString GetAsString() const;
  85
  86     //************************************
  87     // FullName:    KDIS::PDU::Action_Response_PDU::Decode
  88     // Description: Convert From Network Data.
  89     // Parameter:   KDataStream & stream
  90     // Parameter:   bool ignoreHeader = false - Decode the header from the stream?
  91     //************************************
  92     virtual void Decode( KDataStream & stream, bool ignoreHeader = false ) ;
  93
  94     //************************************
  95     // FullName:    KDIS::PDU::Action_Response_PDU::Encode
  96     // Description: Convert To Network Data.
  97     // Parameter:   KDataStream & stream
  98     //************************************
  99     virtual KDataStream Encode() const;
 100     virtual void Encode( KDataStream & stream ) const;
 101
 102     KBOOL operator == ( const Action_Response_PDU & Value ) const;
 103     KBOOL operator != ( const Action_Response_PDU & Value ) const;
 104 };
 105
 106 } // END namespace PDU
 107 } // END namespace KDIS
 108