DtAisDataRecord Class Reference

Attribute record for sending AIS Transponder information across the network. More...

Inheritance diagram for DtAisDataRecord:

Collaboration diagram for DtAisDataRecord:

Public Member Functions
	DtAisDataRecord ()
	Constructor. More...
	DtAisDataRecord (unsigned int dataType)
	Constructor with record type specified. More...
	DtAisDataRecord (const DtAisDataRecord &orig)
	Copy Constructor. More...
	DtAisDataRecord (void *netBuffer, unsigned int size)
	Net Constructor. More...
virtual	~DtAisDataRecord ()
	Destructor. More...
virtual bool	operator== (const DtAisDataRecord &other)
	Equals operator. More...
virtual bool	operator== (const DtStandardVariableRecord &other)
	Equals operator. More...
virtual void	setAisMmsi (DtU32 val)
	Set the MMSI number broadcast from the ships AIS tranceiver. More...
virtual DtU32	aisMmsi () const
	Get the MMSI number broadcast from the ships AIS tranceiver. More...
virtual void	setAisImo (DtU32 val)
	Set the IMO number broadcast from the ships AIS tranceiver. More...
virtual DtU32	aisImo () const
	Get the IMO number broadcast from the ships AIS tranceiver. More...
virtual void	setAisEta (DtInt32 val)
	Set the ETA broadcast from the ships AIS tranceiver. More...
virtual DtInt32	aisEta () const
	Get the ETA broadcast from the ships AIS tranceiver. More...
virtual void	setAisDestination (const DtString &val)
	Set the destination broadcast from the ships AIS tranceiver. More...
virtual const DtString &	aisDestination () const
	Get the destination broadcast from the ships AIS tranceiver. More...
virtual void	setAisStatus (DtAisNavigationStatus val)
	Set the navigation status value broadcast from the ships AIS tranceiver. More...
virtual DtAisNavigationStatus	aisStatus () const
	Get the navigation status value broadcast from the ships AIS tranceiver. More...
virtual void	printData () const
	Prints the data to DtInfo. More...
virtual void	printDataToStream (std::ostream &stream) const
	Prints the data to the specified stream. More...
virtual void	writeRecord (void *addr) const
virtual void	setFromNet (const void *netRecord, unsigned int length, DtStandardVariableRetCode *retCode=NULL)
	Sets the record from Network Representation from the given location. More...
virtual unsigned	unpaddedNetsize () const
	This is the network size of the record without padding. More...
virtual unsigned int	netSize ()
	Returns the size of the network representation (including padding bytes) More...
virtual DtStandardVariableRecord *	clone () const
	Clone. More...
virtual unsigned int	recordType () const
	Get/Set Record Type. More...
virtual void	setRecordType (unsigned int recordType)
	Get/Set Record Type. More...
virtual unsigned int	recordLength () const
	Get/Set Record Length. More...
virtual void	setRecordLength (unsigned int recordLength)
	Must include size of record header and padding to 8 bytes. More...
Public Member Functions inherited from DtStandardVariableRecord
	DtStandardVariableRecord ()
	Constructor. More...
virtual	~DtStandardVariableRecord ()
	Destructor. More...
virtual void	setOriginatingSimulationAddress (const DtSimulationAddress &)
virtual const DtSimulationAddress &	originatingSimulationAddress () const

Static Public Member Functions
static DtStandardVariableRecord *	create (void *addr, unsigned int length)
	Creator of an unknown record for registering in a factory. More...
static unsigned int	recordTypeToUse ()
	Return the AIS Data record type. More...
static void	setRecordTypeToUse (unsigned int typeToUse)
	Set the record type to use. More...

Protected Attributes
DtNetAisDataRecord	myNetAisDataRecord
DtString	myAisDestination
Protected Attributes inherited from DtStandardVariableRecord
DtSimulationAddress	myOriginatingSimulationAddress

Static Protected Attributes
static const unsigned int	theMinimumSize

Detailed Description

Attribute record for sending AIS Transponder information across the network.

Constructor & Destructor Documentation

DtAisDataRecord::DtAisDataRecord

(

)

Constructor.

DtAisDataRecord::DtAisDataRecord

(

unsigned int

dataType

)

Constructor with record type specified.

DtAisDataRecord::DtAisDataRecord

(

const DtAisDataRecord &

orig

)

Copy Constructor.

DtAisDataRecord::DtAisDataRecord	(	void *	netBuffer,
		unsigned int	size
	)

Net Constructor.

virtual DtAisDataRecord::~DtAisDataRecord ( )

virtual

Destructor.

Member Function Documentation

virtual const DtString& DtAisDataRecord::aisDestination ( ) const

virtual

Get the destination broadcast from the ships AIS tranceiver.

virtual DtInt32 DtAisDataRecord::aisEta ( ) const

virtual

Get the ETA broadcast from the ships AIS tranceiver.

virtual DtU32 DtAisDataRecord::aisImo ( ) const

virtual

Get the IMO number broadcast from the ships AIS tranceiver.

virtual DtU32 DtAisDataRecord::aisMmsi ( ) const

virtual

Get the MMSI number broadcast from the ships AIS tranceiver.

virtual DtAisNavigationStatus DtAisDataRecord::aisStatus ( ) const

virtual

Get the navigation status value broadcast from the ships AIS tranceiver.

virtual DtStandardVariableRecord* DtAisDataRecord::clone ( ) const

virtual

Clone.

Implements DtStandardVariableRecord.

static DtStandardVariableRecord* DtAisDataRecord::create ( void *  addr, unsigned int  length  )

static

Creator of an unknown record for registering in a factory.

virtual unsigned int DtAisDataRecord::netSize ( )

virtual

Returns the size of the network representation (including padding bytes)

Reimplemented from DtStandardVariableRecord.

virtual bool DtAisDataRecord::operator== ( const DtAisDataRecord &  other )

virtual

Equals operator.

virtual bool DtAisDataRecord::operator== ( const DtStandardVariableRecord &  other )

virtual

Equals operator.

Implements DtStandardVariableRecord.

virtual void DtAisDataRecord::printData ( ) const

virtual

Prints the data to DtInfo.

Reimplemented from DtStandardVariableRecord.

virtual void DtAisDataRecord::printDataToStream ( std::ostream &  stream ) const

virtual

Prints the data to the specified stream.

Implements DtStandardVariableRecord.

virtual unsigned int DtAisDataRecord::recordLength ( ) const

virtual

Get/Set Record Length.

Implements DtStandardVariableRecord.

virtual unsigned int DtAisDataRecord::recordType ( ) const

virtual

Get/Set Record Type.

Implements DtStandardVariableRecord.

static unsigned int DtAisDataRecord::recordTypeToUse ( )

static

Return the AIS Data record type.

virtual void DtAisDataRecord::setAisDestination ( const DtString &  val )

virtual

Set the destination broadcast from the ships AIS tranceiver.

virtual void DtAisDataRecord::setAisEta ( DtInt32  val )

virtual

Set the ETA broadcast from the ships AIS tranceiver.

virtual void DtAisDataRecord::setAisImo ( DtU32  val )

virtual

Set the IMO number broadcast from the ships AIS tranceiver.

virtual void DtAisDataRecord::setAisMmsi ( DtU32  val )

virtual

Set the MMSI number broadcast from the ships AIS tranceiver.

virtual void DtAisDataRecord::setAisStatus ( DtAisNavigationStatus  val )

virtual

Set the navigation status value broadcast from the ships AIS tranceiver.

virtual void DtAisDataRecord::setFromNet ( const void *  netRecord, unsigned int  length, DtStandardVariableRetCode *  retCode = NULL  )

virtual

Sets the record from Network Representation from the given location.

Memory must exist for life of the variable record

Implements DtStandardVariableRecord.

virtual void DtAisDataRecord::setRecordLength ( unsigned int  recordLength )

virtual

Must include size of record header and padding to 8 bytes.

Implements DtStandardVariableRecord.

virtual void DtAisDataRecord::setRecordType ( unsigned int  recordType )

virtual

Get/Set Record Type.

Implements DtStandardVariableRecord.

static void DtAisDataRecord::setRecordTypeToUse ( unsigned int  typeToUse )

static

Set the record type to use.

virtual unsigned DtAisDataRecord::unpaddedNetsize ( ) const

virtual

This is the network size of the record without padding.

Implements DtStandardVariableRecord.

virtual void DtAisDataRecord::writeRecord ( void *  addr ) const

virtual

Implements DtStandardVariableRecord.

Member Data Documentation

DtString DtAisDataRecord::myAisDestination

protected

DtNetAisDataRecord DtAisDataRecord::myNetAisDataRecord

protected

const unsigned int DtAisDataRecord::theMinimumSize

staticprotected

---

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

• aisDataRecord.h