Linear_Object_State_PDU.h

Go to the documentation of this file.

/*********************************************************************
Copyright 2013 Karl Jones
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 

1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer. 
2. Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution. 

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

For Further Information Please Contact me at
Karljj1@yahoo.com
http://p.sf.net/kdis/UserGuide
*********************************************************************/

/********************************************************************
    class:      Linear_Object_State_PDU
    DIS:        (6) 1278.1a - 1998
    created:    15/03/2010
    author:     Karl Jones

    purpose:    Contains detailed information about the addition/modification of a
                synthetic environment object that is geometrically anchored to the
                terrain with one point and has size and orientation.

    size:       320 bits / 40 octets - Min size.
*********************************************************************/

#pragma once

#include "./Object_State_Header.h"
#include "./../../DataTypes/SimulationIdentifier.h"
#include "./../../DataTypes/ObjectType.h"
#include "./../../DataTypes/LinearSegmentParameter.h"
#include <vector>

namespace KDIS {
namespace PDU {

class KDIS_EXPORT Linear_Object_State_PDU : public Object_State_Header
{
protected:

    KUINT8 m_ui8NumSegment;

    KDIS::DATA_TYPE::SimulationIdentifier m_ReqID;

    KDIS::DATA_TYPE::SimulationIdentifier m_RecvID;

    KDIS::DATA_TYPE::ObjectType m_ObjTyp;

    std::vector<KDIS::DATA_TYPE::LinearSegmentParameter> m_vSegments;

public:

    static const KUINT16 LINEAR_OBJECT_STATE_PDU_SIZE = 40;

    Linear_Object_State_PDU();

    Linear_Object_State_PDU( KDataStream & stream ) throw( KException );

        Linear_Object_State_PDU( const Header & H, KDataStream & stream ) throw( KException );

    Linear_Object_State_PDU( const KDIS::DATA_TYPE::EntityIdentifier & ObjID, const KDIS::DATA_TYPE::EntityIdentifier & RefObjID , KUINT16 UpdateNum,
                                     KDIS::DATA_TYPE::ENUMS::ForceID FI, const KDIS::DATA_TYPE::SimulationIdentifier & ReqID, const KDIS::DATA_TYPE::SimulationIdentifier & RecvID,
                             const KDIS::DATA_TYPE::ObjectType & O );

    Linear_Object_State_PDU( const KDIS::DATA_TYPE::EntityIdentifier & ObjID, const KDIS::DATA_TYPE::EntityIdentifier & RefObjID , KUINT16 UpdateNum,
                             KDIS::DATA_TYPE::ENUMS::ForceID FI, const KDIS::DATA_TYPE::SimulationIdentifier & ReqID, const KDIS::DATA_TYPE::SimulationIdentifier & RecvID,
                                                         const KDIS::DATA_TYPE::ObjectType & O, std::vector<KDIS::DATA_TYPE::LinearSegmentParameter> & Segments );

    virtual ~Linear_Object_State_PDU();

    //************************************
    // FullName:    KDIS::PDU::Linear_Object_State_PDU::GetNumberOfSegments
    //!Description: The number of Linear Segment Parameter records contained within this PDU.
    //************************************
    KUINT8 GetNumberOfSegments() const;

    //************************************
    // FullName:    KDIS::PDU::Linear_Object_State_PDU::SetRequestorSimulationID
    //              KDIS::PDU::Linear_Object_State_PDU::GetRequestorSimulationID
    //!Description: The simulation application sending the PDU.
    // Parameter:   const SimulationIdentifier & ID
    //************************************
    void SetRequestorSimulationID( const KDIS::DATA_TYPE::SimulationIdentifier & ID );
    const KDIS::DATA_TYPE::SimulationIdentifier & GetRequestorSimulationID() const;
    KDIS::DATA_TYPE::SimulationIdentifier & GetRequestorSimulationID();

    //************************************
    // FullName:    KDIS::PDU::Linear_Object_State_PDU::SetReceivingSimulationID
    //              KDIS::PDU::Linear_Object_State_PDU::GetReceivingSimulationID
    //!Description: The simulation application that is to receive the PDU.
    // Parameter:   const SimulationIdentifier & ID
    //************************************
    void SetReceivingSimulationID( const KDIS::DATA_TYPE::SimulationIdentifier & ID );
    const KDIS::DATA_TYPE::SimulationIdentifier & GetReceivingSimulationID() const;
    KDIS::DATA_TYPE::SimulationIdentifier & GetReceivingSimulationID();

    //************************************
    // FullName:    KDIS::PDU::Linear_Object_State_PDU::SetObjectType
    //              KDIS::PDU::Linear_Object_State_PDU::GetObjectType
    //!Description: The type of object. Represented as DIS enumeration(domain, kind, Category and sub category).
    // Parameter:   const ObjectType & O
    //************************************
    void SetObjectType( const KDIS::DATA_TYPE::ObjectType & O );
    const KDIS::DATA_TYPE::ObjectType & GetObjectType() const;
    KDIS::DATA_TYPE::ObjectType & GetObjectType();

    //************************************
    // FullName:    KDIS::PDU::Linear_Object_State_PDU::AddLinearSegmentParameter
    //              KDIS::PDU::Linear_Object_State_PDU::SetLinearSegmentParameters
    //              KDIS::PDU::Linear_Object_State_PDU::GetLinearSegmentParameters
    //!Description: Specifies the parameter values for representing each linear segment.
    // Parameter:   const LinearSegmentParameter & L, const vector<LinearSegmentParameter> & L
    //************************************
    void AddLinearSegmentParameter( const KDIS::DATA_TYPE::LinearSegmentParameter & L );
    void SetLinearSegmentParameters( const std::vector<KDIS::DATA_TYPE::LinearSegmentParameter> & L );
    const std::vector<KDIS::DATA_TYPE::LinearSegmentParameter> & GetLinearSegmentParameters() const;

    //************************************
    // FullName:    KDIS::PDU::Linear_Object_State_PDU::GetAsString
    //!Description: Returns a string representation of the PDU.
    //************************************
    virtual KString GetAsString() const;

    //************************************
    // FullName:    KDIS::PDU::Linear_Object_State_PDU::Decode
    //!Description: Convert From Network Data.
    // Parameter:   KDataStream & stream
    // Parameter:   bool ignoreHeader = false - Decode the header from the stream? 
    //************************************
    virtual void Decode( KDataStream & stream, bool ignoreHeader = false ) throw( KException );

    //************************************
    // FullName:    KDIS::PDU::Linear_Object_State_PDU::Encode
    //!Description: Convert To Network Data.
    // Parameter:   KDataStream & stream
    //************************************
    virtual KDataStream Encode() const;
    virtual void Encode( KDataStream & stream ) const;

    KBOOL operator == ( const Linear_Object_State_PDU & Value ) const;
    KBOOL operator != ( const Linear_Object_State_PDU & Value ) const;
};

} // END namespace PDU
} // END namespace KDIS