Transmitter_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:      Transmitter_PDU
    DIS:        (5) 1278.1 - 1995
    created:    21/10/2008
    author:     Karl Jones

    purpose:    Used to communicate the state of a particular radio 
                                transmitter or simple intercom.

    size:       832 bits / 104 octets - min size
*********************************************************************/

#pragma once

#include "./Radio_Communications_Header.h"
#include "./../../DataTypes/RadioEntityType.h"
#include "./../../DataTypes/AntennaLocation.h"
#include "./../../DataTypes/ModulationType.h"
#include "./../../DataTypes/CryptoSystem.h"
#include <vector>

namespace KDIS {
namespace PDU {

class KDIS_EXPORT Transmitter_PDU : public Radio_Communications_Header
{
protected:

    KDIS::DATA_TYPE::RadioEntityType m_RadioEntityType;

    KUINT8 m_ui8TransmitterState;

    KUINT8 m_ui8InputSource;

    KUINT16 m_ui16Padding1;

    KDIS::DATA_TYPE::AntennaLocation m_AntennaLocation;

    KUINT16 m_ui16AntennaPatternType;

    KUINT16 m_ui16AntennaPatternLength;

    KUINT64 m_ui64Freq;

    KFLOAT32 m_f32TransmitFreqBW;

    KFLOAT32 m_f32Power;

    KDIS::DATA_TYPE::ModulationType m_ModulationType;

    KDIS::DATA_TYPE::CryptoSystem m_CryptoSystem;

    KUINT8 m_ui8LengthOfModulationParam;

    KUINT16 m_ui16Padding2;

    KUINT8 m_ui8Padding3;

        std::vector<KOCTET> m_vModulationParams;

        std::vector<KOCTET> m_vAntennaPattern;

public:

    static const KUINT16 TRANSMITTER_PDU_SIZE = 104; // Min Size

    Transmitter_PDU();

    Transmitter_PDU( KDataStream & stream ) throw( KException );

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

        Transmitter_PDU( const KDIS::DATA_TYPE::RadioEntityType & Type, KDIS::DATA_TYPE::ENUMS::TransmitState TS, KDIS::DATA_TYPE::ENUMS::RadioInputSource IS,
                     const KDIS::DATA_TYPE::AntennaLocation & AL, KDIS::DATA_TYPE::ENUMS::AntennaPatternType APT, KUINT64 Freq,
                     KFLOAT32 FreqBW, KFLOAT32 Power, const KDIS::DATA_TYPE::ModulationType & MT,
                     const KDIS::DATA_TYPE::CryptoSystem & CS, const KOCTET * ModulationParams,
                     KUINT8 ModulationParamsLength, const KOCTET * AntennaPattern,
                     KUINT16 AntennaPatternLength );

    virtual ~Transmitter_PDU();

    //************************************
    // FullName:    KDIS::PDU::Transmitter_PDU::SetRadioEntityType
    //              KDIS::PDU::Transmitter_PDU::GetRadioEntityType
    //!Description: Radio Entity Type
    // Parameter:   const RadioEntityType & Type
    //************************************
    void SetRadioEntityType( const KDIS::DATA_TYPE::RadioEntityType & Type );
    const KDIS::DATA_TYPE::RadioEntityType & GetRadioEntityType() const;
    KDIS::DATA_TYPE::RadioEntityType & GetRadioEntityType();

    //************************************
    // FullName:    KDIS::PDU::Transmitter_PDU::SetTransmitState
    //              KDIS::PDU::Transmitter_PDU::GetTransmitState
    //!Description: Radio Transmit State, on or off.
    // Parameter:   TransmitState TS
    //************************************
    void SetTransmitState( KDIS::DATA_TYPE::ENUMS::TransmitState TS );
    KDIS::DATA_TYPE::ENUMS::TransmitState GetTransmitState() const;

    //************************************
    // FullName:    KDIS::PDU::Transmitter_PDU::SetInputSource
    //              KDIS::PDU::Transmitter_PDU::GetInputSource
    //!Description: Source of the radio in relation to the entity.
    // Parameter:   RadioInputSource IS
    //************************************
    void SetInputSource( KDIS::DATA_TYPE::ENUMS::RadioInputSource IS );
    KDIS::DATA_TYPE::ENUMS::RadioInputSource GetInputSource() const;

    //************************************
    // FullName:    KDIS::PDU::Transmitter_PDU::SetAntennaLocation
    //              KDIS::PDU::Transmitter_PDU::GetAntennaLocation
    //!Description: Location of the Antenna in world coordinates
    //!             and entity coordinates.
    // Parameter:   const AntennaLocation AL
    //************************************
    void SetAntennaLocation( const KDIS::DATA_TYPE::AntennaLocation & AL );
    const KDIS::DATA_TYPE::AntennaLocation & GetAntennaLocation() const;
    KDIS::DATA_TYPE::AntennaLocation & GetAntennaLocation();

    //************************************
    // FullName:    KDIS::PDU::Transmitter_PDU::SetAntennaPatternType
    //              KDIS::PDU::Transmitter_PDU::GetAntennaPatternType
    //!Description: Type of representation used for radiation pattern
    //!             from antenna.
    // Parameter:   AntennaPatternType APT
    //************************************
    void SetAntennaPatternType( KDIS::DATA_TYPE::ENUMS::AntennaPatternType APT );
    KDIS::DATA_TYPE::ENUMS::AntennaPatternType GetAntennaPatternType() const;

    //************************************
    // FullName:    KDIS::PDU::Transmitter_PDU::GetAntennaPatternLength
    //!Description: Length of Antenna pattern parameters in
    //!             octets. Antenna Parameters must end on a 64 bit
    //!             boundary, so this value will be a multiple of 8.
    //************************************
    KUINT16 GetAntennaPatternLength() const;

    //************************************
    // FullName:    KDIS::PDU::Transmitter_PDU::SetFrequency
    //              KDIS::PDU::Transmitter_PDU::GetFrequency
    //!Description: Center frequency of radio transmission in hertz.
    // Parameter:   KUINT64 F, void
    //************************************
    void SetFrequency( KUINT64 F );
    KUINT64 GetFrequency() const;

    //************************************
    // FullName:    KDIS::PDU::Transmitter_PDU::SetTransmitFrequencyBandWidth
    //              KDIS::PDU::Transmitter_PDU::GetTransmitFrequencyBandWidth
    //!Description: Band Width
    // Parameter:   KFLOAT32 TFBW, void
    //************************************
    void SetTransmitFrequencyBandWidth( KFLOAT32 TFBW );
    KFLOAT32 GetTransmitFrequencyBandWidth() const;

    //************************************
    // FullName:    KDIS::PDU::Transmitter_PDU::SetPower
    //              KDIS::PDU::Transmitter_PDU::GetPower
    //!Description: Power in decibel-milliwatts
    // Parameter:   KFLOAT32 P
    //************************************
    void SetPower( KFLOAT32 P );
    KFLOAT32 GetPower() const;

    //************************************
    // FullName:    KDIS::PDU::Transmitter_PDU::SetModulationType
    //              KDIS::PDU::Transmitter_PDU::GetModulationType
    //!Description: Modulation Type
    // Parameter:   const ModulationType & MT
    //************************************
    void SetModulationType( const KDIS::DATA_TYPE::ModulationType & MT );
    const KDIS::DATA_TYPE::ModulationType & GetModulationType() const;
    KDIS::DATA_TYPE::ModulationType & GetModulationType();

    //************************************
    // FullName:    KDIS::PDU::Transmitter_PDU::SetCryptoSystem
    //              KDIS::PDU::Transmitter_PDU::GetCryptoSystem
    //!Description: Identifies the crypto equipment and key
    //!             used in a transmission .
    // Parameter:   const CryptoSystem & CS
    //************************************
    void SetCryptoSystem( const KDIS::DATA_TYPE::CryptoSystem & CS );
    const KDIS::DATA_TYPE::CryptoSystem & GetCryptoSystem() const;
    KDIS::DATA_TYPE::CryptoSystem & GetCryptoSystem();

    //************************************
    // FullName:    KDIS::PDU::Transmitter_PDU::GetLengthOfModulationParameters
    //!Description: Returns length in octets of the modulation parameters
    //!             field. modulation parameters must end on a
    //!             64 bit parameter so this value will be a
    //!             multiple of 8.
    //************************************
    KUINT8 GetLengthOfModulationParameters() const;

    //************************************
    // FullName:    KDIS::PDU::Transmitter_PDU::SetModulationParameters
    //              KDIS::PDU::Transmitter_PDU::GetModulationParameters
    //!Description: Modulation parameter are interpreted in various ways so
    //!             a buffer is taken/returned. set function will add
    //!             padding if the size is not a multiple of 8.
    //!             copy data over.
    // Parameter:   KOCTET * MP - buffer for writing/reading
    // Parameter:   KUINT8 Length - size of buffer.
    //************************************
    void SetModulationParameters( const KOCTET * MP, KUINT8 Length );
    void GetModulationParameters( KOCTET * MP, KUINT8 Length ) const throw( KException );

    //************************************
    // FullName:    KDIS::PDU::Transmitter_PDU::SetAntennaPattern
    //              KDIS::PDU::Transmitter_PDU::GetAntennaPattern
    //!Description: For omni-direction this field is 0, for the other 2
    //!             types the size varies. set function will add
    //!             padding if the size is not a multiple of 8.
    //!             copy data over.
    // Parameter:   KOCTET * MP - buffer for writing/reading
    // Parameter:   KUINT8 Length - size of buffer.
    //************************************
    void SetAntennaPattern( const KOCTET * AP, KUINT16 Length );
    void GetAntennaPattern( KOCTET * AP, KUINT16 Length ) const throw( KException );

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

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

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

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