Designator_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:      Designator_PDU
    DIS:        (5) 1278.1 - 1995 & (7) 1278.1-2012
    created:    2008/10/21
    author:     Karl Jones

    purpose:    Communicates designating operations.
                E.G a laser designator for targeting.
    size:       704 bits / 88 octets
*********************************************************************/

#pragma once

#include "./../Header.h"
#include "./../../DataTypes/EntityIdentifier.h"
#include "./../../DataTypes/Vector.h"
#include "./../../DataTypes/WorldCoordinates.h"

namespace KDIS {
namespace PDU {

class KDIS_EXPORT Designator_PDU : public Header
{
protected:

    KDIS::DATA_TYPE::EntityIdentifier m_DesignatingEntityID;

    KUINT16 m_ui16CodeName;

    KDIS::DATA_TYPE::EntityIdentifier m_DesignatedEntityID;

    KUINT16 m_ui16Code;

    KFLOAT32 m_f32Power;

    KFLOAT32 m_f32WaveLength;

    KDIS::DATA_TYPE::Vector m_SpotRegardsToEntity;

    KDIS::DATA_TYPE::WorldCoordinates m_SpotLocation;

    KUINT8 m_ui8DeadReckoningAlgorithm;

    KUINT16 m_ui16Padding1;

    KUINT8 m_ui8Padding2;

    KDIS::DATA_TYPE::Vector m_EntityLinearAcceleration;

public:

    static const KUINT16 DESIGNATOR_PDU_SIZE = 88;

    Designator_PDU();

    Designator_PDU( KDataStream & stream ) throw( KException );

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

    Designator_PDU( const KDIS::DATA_TYPE::EntityIdentifier & DesignatingEntityID, KDIS::DATA_TYPE::ENUMS::DesignatorCodeName CodeName,
                    const KDIS::DATA_TYPE::EntityIdentifier & DesignatedEntityID, KDIS::DATA_TYPE::ENUMS::DesignatorCode Code, KFLOAT32 Power,
                    KFLOAT32 WaveLength, const KDIS::DATA_TYPE::Vector & SpotLocationRegardsToEntity,
                    const KDIS::DATA_TYPE::WorldCoordinates & SpotLocation, KDIS::DATA_TYPE::ENUMS::DeadReckoningAlgorithm DRA,
                    const KDIS::DATA_TYPE::Vector & EntityLinearAcceleration );

    virtual ~Designator_PDU();

    //************************************
    // FullName:    KDIS::PDU::Designator_PDU::SetDesignatingEntityID
    //              KDIS::PDU::Designator_PDU::GetDesignatingEntityID
    //!Description: Entity that is positioning the designator.
    // Parameter:   const EntityIdentifier & ID
    //************************************
    void SetDesignatingEntityID( const KDIS::DATA_TYPE::EntityIdentifier & ID );
    const KDIS::DATA_TYPE::EntityIdentifier & GetDesignatingEntityID() const;
    KDIS::DATA_TYPE::EntityIdentifier & GetDesignatingEntityID();

    //************************************
    // FullName:    KDIS::PDU::Designator_PDU::SetDesignatorCodeName
    //              KDIS::PDU::Designator_PDU::GetDesignatorCodeName
    //!Description: Code name for designator
    // Parameter:   DesignatorCodeName CN
    //************************************
    void SetDesignatorCodeName( KDIS::DATA_TYPE::ENUMS::DesignatorCodeName CN );
    KDIS::DATA_TYPE::ENUMS::DesignatorCodeName GetDesignatorCodeName() const;

    //************************************
    // FullName:    KDIS::PDU::Designator_PDU::SetDesignatedEntityID
    //              KDIS::PDU::Designator_PDU::GetDesignatedEntityID
    //!Description: Object that is being designated, if not an entity
    //!             the value shall be set to the symbolic name: D_SPOT_NO_ENTITY
    // Parameter:   const EntityIdentifier & ID
    //************************************
    void SetDesignatedEntityID( const KDIS::DATA_TYPE::EntityIdentifier & ID );
    const KDIS::DATA_TYPE::EntityIdentifier & GetDesignatedEntityID() const;
    KDIS::DATA_TYPE::EntityIdentifier & GetDesignatedEntityID();

    //************************************
    // FullName:    KDIS::PDU::Designator_PDU::SetDesignatorCode
    //              KDIS::PDU::Designator_PDU::GetDesignatorCode
    //!Description: Code used by designator
    // Parameter:   DesignatorCode C
    //************************************
    void SetDesignatorCode( KDIS::DATA_TYPE::ENUMS::DesignatorCode C );
    KDIS::DATA_TYPE::ENUMS::DesignatorCode GetDesignatorCode() const;

    //************************************
    // FullName:    KDIS::PDU::Designator_PDU::SetDesignatingPower
    //              KDIS::PDU::Designator_PDU::GetDesignatingPower
    //!Description: Output power in Watts
    // Parameter:   KFLOAT32 DP
    //************************************
    void SetDesignatingPower( KFLOAT32 DP );
    KFLOAT32 GetDesignatingPower() const;

    //************************************
    // FullName:    KDIS::PDU::Designator_PDU::SetDesignatingWaveLength
    //              KDIS::PDU::Designator_PDU::GetDesignatingWaveLength
    //!Description: Wave Length in units of microns
    // Parameter:   KFLOAT32 WL
    //************************************
    void SetDesignatingWaveLength( KFLOAT32 WL );
    KFLOAT32 GetDesignatingWaveLength() const;

    //************************************
    // FullName:    KDIS::PDU::Designator_PDU::SetDesignatorSpotRespectToDesignatedEntity
    //              KDIS::PDU::Designator_PDU::GetDesignatorSpotRespectToDesignatedEntity
    //!Description: Location of the designator spot with regards to the
    //!             designated entity coordinate system. If the designated
    //!             object is not an entity (I.E the Designated Entity ID contains
    //!             the symbolic value D_SPOT_NO_ENTITY) then the field shall contain
    //!             [0.0, 0.0, 0.0]. Represented as Entity Coordinate Vector
    // Parameter:   const Vector & DPL
    //************************************
    void SetDesignatorSpotRespectToDesignatedEntity( const KDIS::DATA_TYPE::Vector & DPL );
    const KDIS::DATA_TYPE::Vector & GetDesignatorSpotRespectToDesignatedEntity() const;
    KDIS::DATA_TYPE::Vector & GetDesignatorSpotRespectToDesignatedEntity();

    //************************************
    // FullName:    KDIS::PDU::Designator_PDU::SetSpotLocation
    //              KDIS::PDU::Designator_PDU::GetSpotLocation
    //!Description: Location of designator spot in world coordinates
    // Parameter:   const WorldCoordinates & SL
    //************************************
    void SetSpotLocation( const KDIS::DATA_TYPE::WorldCoordinates & SL );
    const KDIS::DATA_TYPE::WorldCoordinates & GetSpotLocation() const;
    KDIS::DATA_TYPE::WorldCoordinates & GetSpotLocation();

    //************************************
    // FullName:    KDIS::PDU::Designator_PDU::SetDeadReckoningAlgorithm
    //              KDIS::PDU::Designator_PDU::GetDeadReckoningAlgorithm
    //!Description: Used for dead reckoning the designator spot, also uses
    //!             entity linear acceleration in order to perform the dead
    //!             reckoning task.
    // Parameter:   DeadReckoningAlgorithm DRA
    //************************************
    void SetDeadReckoningAlgorithm( KDIS::DATA_TYPE::ENUMS::DeadReckoningAlgorithm DRA );
    KDIS::DATA_TYPE::ENUMS::DeadReckoningAlgorithm GetDeadReckoningAlgorithm() const;

    //************************************
    // FullName:    KDIS::PDU::Designator_PDU::SetEntityLinearAcceleration
    //              KDIS::PDU::Designator_PDU::GetEntityLinearAcceleration
    //!Description: Entity Linear Acceleration. Represented as Linear Acceleration Vector.
    // Parameter:   const Vector & ELA
    //************************************
    void SetEntityLinearAcceleration( const KDIS::DATA_TYPE::Vector & ELA );
    const KDIS::DATA_TYPE::Vector & GetEntityLinearAcceleration() const;
    KDIS::DATA_TYPE::Vector & GetEntityLinearAcceleration();

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

    //************************************
    // FullName:    KDIS::PDU::Designator_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::Designator_PDU::Encode
    //!Description: Convert To Network Data.
    //************************************
    virtual KDataStream Encode() const;
    virtual void Encode( KDataStream & stream ) const;

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

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