VR-Link API Documentation for DIS
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Attributes
DtUnderwaterAcousticBeam Class Reference

DtUnderwaterAcousticBeam is a class which contains the beam fundamental data parameters for the underwater acoustics PDU. More...

+ Collaboration diagram for DtUnderwaterAcousticBeam:

Public Member Functions

 DtUnderwaterAcousticBeam ()
 Constructors.
 DtUnderwaterAcousticBeam (const DtUnderwaterAcousticBeam &orig)
DtUnderwaterAcousticBeamoperator= (const DtUnderwaterAcousticBeam &orig)
 Assignment operator.
DtUnderwaterAcousticBeamoperator= (const DtNetUnderwaterAcousticBeam &orig)
virtual ~DtUnderwaterAcousticBeam ()
 Destructor.
virtual void setBeamDataLength (DtU8 length)
 Set/Get the beam data length.
virtual DtU8 beamDataLength () const
virtual void setBeamID_Number (DtU8 num)
 Set/Get the beam ID number.
virtual DtU8 beamID_Number () const
virtual void setActiveEmissionParmIndex (DtUnderwaterAcousticActiveEmissionParmIndex ind)
 Set/Get the active emission parameter index.
virtual
DtUnderwaterAcousticActiveEmissionParmIndex 
activeEmissionParmIndex () const
virtual void setScanPattern (DtUnderwaterAcousticScanPattern value)
 Set/Get the acoustic scan pattern.
virtual
DtUnderwaterAcousticScanPattern 
scanPattern () const
virtual void setBeamCenterAzimuth (DtFloat32 value)
 Set/Get the beam center azimuth.
virtual DtFloat32 beamCenterAzimuth () const
virtual void setAzimuthalBeamwidth (DtFloat32 value)
 Set/Get the azimuthal beam width.
virtual DtFloat32 azimuthalBeamwidth () const
virtual void setBeamCenterD_E (DtFloat32 value)
 Set/Get the beam center D/E.
virtual DtFloat32 beamCenterD_E () const
virtual void setD_E_Beamwidth (DtFloat32 value)
 Set/Get the D/E beam width.
virtual DtFloat32 D_E_Beamwidth () const
virtual void print () const
 Print the information contained in the record.
virtual void printDataToStream (std::ostream &stream) const
virtual void unloadNetRecord (const DtNetUnderwaterAcousticBeam &record)
 Load/unload data from a packet record.
virtual void loadNetRecord (DtNetUnderwaterAcousticBeam &record) const

Protected Attributes

DtU8 myBeamDataLength
 Data members:
DtU8 myBeamID_Number
DtUnderwaterAcousticActiveEmissionParmIndex myActiveEmissionParmIndex
DtUnderwaterAcousticScanPattern myScanPattern
DtFloat32 myBeamCenterAzimuth
DtFloat32 myAzimuthalBeamwidth
DtFloat32 myBeamCenterD_E
DtFloat32 myD_E_Beamwidth

Detailed Description

DtUnderwaterAcousticBeam is a class which contains the beam fundamental data parameters for the underwater acoustics PDU.

Constructor & Destructor Documentation

DtUnderwaterAcousticBeam::DtUnderwaterAcousticBeam ( )

Constructors.

DtUnderwaterAcousticBeam::DtUnderwaterAcousticBeam ( const DtUnderwaterAcousticBeam orig)
virtual DtUnderwaterAcousticBeam::~DtUnderwaterAcousticBeam ( )
virtual

Destructor.

Member Function Documentation

virtual DtUnderwaterAcousticActiveEmissionParmIndex DtUnderwaterAcousticBeam::activeEmissionParmIndex ( ) const
virtual
virtual DtFloat32 DtUnderwaterAcousticBeam::azimuthalBeamwidth ( ) const
virtual
virtual DtFloat32 DtUnderwaterAcousticBeam::beamCenterAzimuth ( ) const
virtual
virtual DtFloat32 DtUnderwaterAcousticBeam::beamCenterD_E ( ) const
virtual
virtual DtU8 DtUnderwaterAcousticBeam::beamDataLength ( ) const
virtual
virtual DtU8 DtUnderwaterAcousticBeam::beamID_Number ( ) const
virtual
virtual DtFloat32 DtUnderwaterAcousticBeam::D_E_Beamwidth ( ) const
virtual
virtual void DtUnderwaterAcousticBeam::loadNetRecord ( DtNetUnderwaterAcousticBeam record) const
virtual
DtUnderwaterAcousticBeam& DtUnderwaterAcousticBeam::operator= ( const DtUnderwaterAcousticBeam orig)

Assignment operator.

DtUnderwaterAcousticBeam& DtUnderwaterAcousticBeam::operator= ( const DtNetUnderwaterAcousticBeam orig)
virtual void DtUnderwaterAcousticBeam::print ( ) const
virtual

Print the information contained in the record.

virtual void DtUnderwaterAcousticBeam::printDataToStream ( std::ostream &  stream) const
virtual
virtual DtUnderwaterAcousticScanPattern DtUnderwaterAcousticBeam::scanPattern ( ) const
virtual
virtual void DtUnderwaterAcousticBeam::setActiveEmissionParmIndex ( DtUnderwaterAcousticActiveEmissionParmIndex  ind)
virtual

Set/Get the active emission parameter index.

virtual void DtUnderwaterAcousticBeam::setAzimuthalBeamwidth ( DtFloat32  value)
virtual

Set/Get the azimuthal beam width.

virtual void DtUnderwaterAcousticBeam::setBeamCenterAzimuth ( DtFloat32  value)
virtual

Set/Get the beam center azimuth.

virtual void DtUnderwaterAcousticBeam::setBeamCenterD_E ( DtFloat32  value)
virtual

Set/Get the beam center D/E.

virtual void DtUnderwaterAcousticBeam::setBeamDataLength ( DtU8  length)
virtual

Set/Get the beam data length.

virtual void DtUnderwaterAcousticBeam::setBeamID_Number ( DtU8  num)
virtual

Set/Get the beam ID number.

virtual void DtUnderwaterAcousticBeam::setD_E_Beamwidth ( DtFloat32  value)
virtual

Set/Get the D/E beam width.

virtual void DtUnderwaterAcousticBeam::setScanPattern ( DtUnderwaterAcousticScanPattern  value)
virtual

Set/Get the acoustic scan pattern.

virtual void DtUnderwaterAcousticBeam::unloadNetRecord ( const DtNetUnderwaterAcousticBeam record)
virtual

Load/unload data from a packet record.

Member Data Documentation

DtUnderwaterAcousticActiveEmissionParmIndex DtUnderwaterAcousticBeam::myActiveEmissionParmIndex
protected
DtFloat32 DtUnderwaterAcousticBeam::myAzimuthalBeamwidth
protected
DtFloat32 DtUnderwaterAcousticBeam::myBeamCenterAzimuth
protected
DtFloat32 DtUnderwaterAcousticBeam::myBeamCenterD_E
protected
DtU8 DtUnderwaterAcousticBeam::myBeamDataLength
protected

Data members:

DtU8 DtUnderwaterAcousticBeam::myBeamID_Number
protected
DtFloat32 DtUnderwaterAcousticBeam::myD_E_Beamwidth
protected
DtUnderwaterAcousticScanPattern DtUnderwaterAcousticBeam::myScanPattern
protected

The documentation for this class was generated from the following file:

Document ID: Generated on Mon Jun 22 21:18:40 EDT 2020 from SVN revision 213785
Copyright © 2005-2018 MAK Technologies. All Rights Reserved (www.mak.com)