Underwater_Acoustic_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:      Underwater_Acoustic_PDU
    DIS:        (6) 1278.1A - 1998
    created:    2008/10/19
    author:     Karl Jones

    purpose:    Contains infomation about under water acoustic emissions
    Size:       272 bits / 34 octets - min size
*********************************************************************/

#pragma once

#include "./../Header.h"
#include "./../../DataTypes/EntityIdentifier.h"
#include "./../../DataTypes/EmissionSystem.h"
#include "./../../DataTypes/Shaft.h"
#include "./../../DataTypes/APA.h"
#include "./../../DataTypes/UnderwaterAcousticEmitterSystem.h"
#include <vector>

namespace KDIS {
namespace PDU {

class KDIS_EXPORT Underwater_Acoustic_PDU : public Header
{
protected:

    KDIS::DATA_TYPE::EntityIdentifier m_EmittingEntityID;

    KDIS::DATA_TYPE::EntityIdentifier m_EventID;

    KUINT8 m_ui8StateUpdateIndicator;

    KUINT8 m_ui8Padding1;

    KUINT16 m_ui16PassiveParamIndex;

    KUINT8 m_ui8PropPlantConfig;

    KUINT8 m_ui8NumShafts;

    KUINT8 m_ui8NumAPA;

    KUINT8 m_ui8NumEmitterSys;

        std::vector<KDIS::DATA_TYPE::Shaft> m_vShafts;

        std::vector<KDIS::DATA_TYPE::APA> m_vAPA;

        std::vector<KDIS::DATA_TYPE::UnderwaterAcousticEmitterSystem> m_vUAES;

public:

    static const KUINT16 UNDERWATER_ACOUSTIC_PDU_SIZE = 34; // Min Size

    Underwater_Acoustic_PDU();

    Underwater_Acoustic_PDU( KDataStream & stream ) throw( KException );

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

    virtual ~Underwater_Acoustic_PDU();

    //************************************
    // FullName:    KDIS::PDU::Underwater_Acoustic_PDU::SetEmittingEntityID
    //              KDIS::PDU::Underwater_Acoustic_PDU::GetEmittingEntityID
    //!Description: Emitting Entity ID
    // Parameter:   const EntityIdentifier & ID
    //************************************
    void SetEmittingEntityID ( const KDIS::DATA_TYPE::EntityIdentifier & ID );
    const KDIS::DATA_TYPE::EntityIdentifier & GetEmittingEntityID() const;
    KDIS::DATA_TYPE::EntityIdentifier & GetEmittingEntityID();

    //************************************
    // FullName:    KDIS::PDU::Underwater_Acoustic_PDU::SetEventID
    //              KDIS::PDU::Underwater_Acoustic_PDU::GetEventID
    //!Description: Event ID. For associated events.
    // Parameter:   const EntityIdentifier & ID
    //************************************
    void SetEventID( const KDIS::DATA_TYPE::EntityIdentifier & ID );
    const KDIS::DATA_TYPE::EntityIdentifier & GetEventID() const;
    KDIS::DATA_TYPE::EntityIdentifier & GetEventID();

    //************************************
    // FullName:    KDIS::PDU::Underwater_Acoustic_PDU::SetStateUpdateIndicator
    //              KDIS::PDU::Underwater_Acoustic_PDU::GetStateUpdateIndicator
    //!Description: Indicates if the data contained in the PDU represents a state update or
    //!             just data that has changed since issuance of the last Electromagnetic Emission
    //!             PDU.
    // Parameter:   StateUpdateIndicator SUI
        //************************************
        void SetStateUpdateIndicator( KDIS::DATA_TYPE::ENUMS::StateUpdateIndicator SUI );
        KDIS::DATA_TYPE::ENUMS::StateUpdateIndicator GetStateUpdateIndicator() const;

    //************************************
    // FullName:    KDIS::PDU::Underwater_Acoustic_PDU::SetPassiveParameterIndex
    //              KDIS::PDU::Underwater_Acoustic_PDU::GetPassiveParameterIndex
    //!Description: Indicates which database record ( or file ) shall
    //!             be used in the definition of passive signature (unintentional)
    //!             emissions of the entity. The indicated record/file shall
    //!             define all noise generated as a function of propulsion plant
    //!             configuration and associated auxiliaries.
    //!             E.G parameter indexex identifying a file in a common
    //!             acoustic database (CADB) would be used here.
    // Parameter:   PassiveParameterIndex PPI
    //************************************
        void SetPassiveParameterIndex( KDIS::DATA_TYPE::ENUMS::PassiveParameterIndex PPI );
        KDIS::DATA_TYPE::ENUMS::PassiveParameterIndex GetPassiveParameterIndex() const;

    //************************************
    // FullName:    KDIS::PDU::Underwater_Acoustic_PDU::SetPropulsionPlantConfiguration
    //              KDIS::PDU::Underwater_Acoustic_PDU::GetPropulsionPlantConfiguration
    //!Description: Used to determine the passive signature
    //!             characteristics of an entity
    // Parameter:   PropulsionPlantConfiguration PPC
    //************************************
        void SetPropulsionPlantConfiguration( KDIS::DATA_TYPE::ENUMS::PropulsionPlantConfiguration PPC );
        KDIS::DATA_TYPE::ENUMS::PropulsionPlantConfiguration GetPropulsionPlantConfiguration() const;

    //************************************
    // FullName:    KDIS::PDU::Underwater_Acoustic_PDU::GetNumberOfShafts
    //!Description: Returns number of shafts on platform
    //************************************
    KUINT8 GetNumberOfShafts() const;

    //************************************
    // FullName:    KDIS::PDU::Underwater_Acoustic_PDU::GetNumberOfAPA
    //!Description: Returns number of APA.
    //************************************
    KUINT8 GetNumberOfAPA() const;

    //************************************
    // FullName:    KDIS::PDU::Underwater_Acoustic_PDU::GetNumberOfUAEmitterSystems
    //!Description: Returns number of UA emitter systems.
    //************************************
    KUINT8 GetNumberOfUAEmitterSystems() const;

    //************************************
    // FullName:    KDIS::PDU::Underwater_Acoustic_PDU::AddShaft
    // FullName:    KDIS::PDU::Underwater_Acoustic_PDU::SetShafts
    //              KDIS::PDU::Underwater_Acoustic_PDU::GetShafts
    //!Description: Shafts belonging to the platform.
    // Parameter:   const vector<Shaft> & S
    //************************************
    void AddShaft( const KDIS::DATA_TYPE::Shaft & S );
        void SetShafts( const std::vector<KDIS::DATA_TYPE::Shaft> & S );
        const std::vector<KDIS::DATA_TYPE::Shaft> & GetShafts() const;

    //************************************
    // FullName:    KDIS::PDU::Underwater_Acoustic_PDU::AddAPA
    //              KDIS::PDU::Underwater_Acoustic_PDU::SetAPA
    //              KDIS::PDU::Underwater_Acoustic_PDU::GetAPA
    //!Description: Additional Passive Activity ( APA )
    // Parameter:   const APA & A, const vector<APA> & A
    //************************************
    void AddAPA( const KDIS::DATA_TYPE::APA & A );
        void SetAPA( const std::vector<KDIS::DATA_TYPE::APA> & A );
        const std::vector<KDIS::DATA_TYPE::APA> & GetAPA() const;

    //************************************
    // FullName:    KDIS::PDU::Underwater_Acoustic_PDU::AddUnderwaterAcousticEmitterSystem
    //              KDIS::PDU::Underwater_Acoustic_PDU::SetUnderwaterAcousticEmitterSystem
    //              KDIS::PDU::Underwater_Acoustic_PDU::GetUnderwaterAcousticEmitterSystem
    //!Description: Adds a system to the platform.
    // Parameter:   const UnderwaterAcousticEmitterSystem & UAES, const vector<UnderwaterAcousticEmitterSystem> & UAES
    //************************************
    void AddUnderwaterAcousticEmitterSystem( const KDIS::DATA_TYPE::UnderwaterAcousticEmitterSystem & UAES );
        void SetUnderwaterAcousticEmitterSystem( const std::vector<KDIS::DATA_TYPE::UnderwaterAcousticEmitterSystem> & UAES );
        const std::vector<KDIS::DATA_TYPE::UnderwaterAcousticEmitterSystem> & GetUnderwaterAcousticEmitterSystem() const;

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

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

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

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