DtWaterSurfaceRecord Class Reference

Inheritance diagram for DtWaterSurfaceRecord:

Collaboration diagram for DtWaterSurfaceRecord:

Public Member Functions
	DtWaterSurfaceRecord ()
	Constructor. More...
	DtWaterSurfaceRecord (const DtWaterSurfaceRecord &orig)
	Copy Constructor. More...
	DtWaterSurfaceRecord (void *netBuffer, unsigned int size)
	Net Constructor. More...
virtual DtWaterSurfaceRecord &	operator= (const DtWaterSurfaceRecord &record)
	Assignment Operator. More...
virtual DtStandardVariableRecord &	operator= (const DtStandardVariableRecord &other)
	Assignment operator. More...
virtual bool	operator== (const DtWaterSurfaceRecord &record)
	Equals Operator. More...
virtual bool	operator== (const DtStandardVariableRecord &other)
	Equals operator. More...
virtual void	setSeaState (const DtSeaStateEnum16 &ss)
	Set the SeaState. More...
virtual const DtSeaStateEnum16	seaState () const
	Get the SeaState. More...
virtual void	setSalinity (const DtFloat32 &sal)
	Set the Salinity. More...
virtual const DtFloat32	salinity () const
	Get the Salinity. More...
virtual void	setTide (const DtFloat32 &tide)
	Set the Tide. More...
virtual const DtFloat32	tide () const
	Get the Tide. More...
virtual void	setIceStruct (const DtIceStruct &layer)
	Set the Ice Struct. More...
virtual const DtIceStruct	iceStruct () const
	Get the Ice Struct. More...
virtual void	setCurrentStruct (const DtWaterCurrentStruct &current)
	Set the WaterCurrent Struct. More...
virtual const DtWaterCurrentStruct	currentStruct () const
	Get the WaterCurrent Struct. More...
virtual void	setWaveStruct (const DtWaveStruct &current)
	Set the Wave Struct. More...
virtual const DtWaveStruct	waveStruct () const
	Get the Wave Struct. More...
virtual void	setSwellStruct (const DtWaveStruct &swell)
	Set the Swell Struct. More...
virtual const DtWaveStruct	swellStruct () const
	Get the Swell Struct. More...
virtual void	setChoppiness (const DtFloat32 &chop)
	Set the Choppiness. More...
virtual const DtFloat32	choppiness () const
	Get the Choppiness. More...
virtual void	setSurgeDepth (const DtFloat32 &sd)
	Set the SurgeDepth. More...
virtual const DtFloat32	surgeDepth () const
	Get the SurgeDepth. More...
virtual void	setSurfaceTransparency (const DtFloat32 &st)
	Set the SurfaceTransparency. More...
virtual const DtFloat32	surfaceTransparency () const
	Get the SurfaceTransparency. More...
virtual void	setDriveSeaStateFromWind (const bool &dssfw)
	Set the DriveSeaStateFromWind. More...
virtual const bool	driveSeaStateFromWind () const
	Get the DriveSeaStateFromWind. More...
virtual void	writeRecord (void *addr) const
virtual void	setFromNet (const void *netRecord, unsigned int length, DtStandardVariableRetCode *retCode=NULL)
	Sets the record from an address and length. More...
virtual void	printDataToStream (std::ostream &stream) const
	Prints the data to the specified stream. More...
virtual unsigned int	unpaddedNetsize () const
	This is the network size of the record without padding. More...
virtual unsigned int	paddedNetSize () const
	This is the network size of the record with padding. More...
virtual DtStandardVariableRecord *	clone () const
	Clone. More...
Public Member Functions inherited from DtMetocLayerRecord
	DtMetocLayerRecord ()
	Constructor. More...
	DtMetocLayerRecord (const DtMetocLayerRecord &orig)
	Copy Constructor. More...
	DtMetocLayerRecord (void *netBuffer, unsigned int size)
	Net Constructor. More...
virtual DtMetocLayerRecord &	operator= (const DtMetocLayerRecord &record)
	Assignment Operator. More...
virtual bool	operator== (const DtMetocLayerRecord &record)
	Equals Operator. More...
virtual void	setPriority (unsigned short priority)
virtual unsigned short	priority () const
virtual void	setVrfWeatherAreaIdentifier (const DtVrlUuid &vrfWeatherAreaId)
virtual DtVrlUuid	vrfWeatherAreaIdentifier () const
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 length)
	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	printData () const
	Prints the data to DtInfo. More...
virtual unsigned int	netSize ()
	Returns the size of the network representation (including padding bytes) 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 waterSurface record type. More...
static void	setRecordTypeToUse (unsigned int typeToUse)
	Set the record type to use. More...
Static Public Member Functions inherited from DtMetocLayerRecord
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 METOC Layer record type. More...
static void	setRecordTypeToUse (unsigned int typeToUse)
	Set the record type to use. More...

Protected Attributes
DtNetWaterSurfaceRecord *	myRecordPtr
Protected Attributes inherited from DtMetocLayerRecord
std::vector< char >	myRecordBuffer
Protected Attributes inherited from DtStandardVariableRecord
DtSimulationAddress	myOriginatingSimulationAddress

Static Protected Attributes
static const unsigned int	theMinimumSize
Static Protected Attributes inherited from DtMetocLayerRecord
static const unsigned int	theMinimumSize

Constructor & Destructor Documentation

DtWaterSurfaceRecord::DtWaterSurfaceRecord

(

)

Constructor.

DtWaterSurfaceRecord::DtWaterSurfaceRecord

(

const DtWaterSurfaceRecord &

orig

)

Copy Constructor.

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

Net Constructor.

Member Function Documentation

virtual const DtFloat32 DtWaterSurfaceRecord::choppiness ( ) const

virtual

Get the Choppiness.

virtual DtStandardVariableRecord* DtWaterSurfaceRecord::clone ( ) const

virtual

Clone.

Reimplemented from DtMetocLayerRecord.

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

static

Creator of an unknown record for registering in a factory.

virtual const DtWaterCurrentStruct DtWaterSurfaceRecord::currentStruct ( ) const

virtual

Get the WaterCurrent Struct.

virtual const bool DtWaterSurfaceRecord::driveSeaStateFromWind ( ) const

virtual

Get the DriveSeaStateFromWind.

virtual const DtIceStruct DtWaterSurfaceRecord::iceStruct ( ) const

virtual

Get the Ice Struct.

virtual DtWaterSurfaceRecord& DtWaterSurfaceRecord::operator= ( const DtWaterSurfaceRecord &  record )

virtual

Assignment Operator.

virtual DtStandardVariableRecord& DtWaterSurfaceRecord::operator= ( const DtStandardVariableRecord &  other )

virtual

Assignment operator.

Reimplemented from DtMetocLayerRecord.

virtual bool DtWaterSurfaceRecord::operator== ( const DtWaterSurfaceRecord &  record )

virtual

Equals Operator.

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

virtual

Equals operator.

Reimplemented from DtMetocLayerRecord.

virtual unsigned int DtWaterSurfaceRecord::paddedNetSize ( ) const

virtual

This is the network size of the record with padding.

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

virtual

Prints the data to the specified stream.

Reimplemented from DtMetocLayerRecord.

static unsigned int DtWaterSurfaceRecord::recordTypeToUse ( )

static

Return the waterSurface record type.

virtual const DtFloat32 DtWaterSurfaceRecord::salinity ( ) const

virtual

Get the Salinity.

virtual const DtSeaStateEnum16 DtWaterSurfaceRecord::seaState ( ) const

virtual

Get the SeaState.

virtual void DtWaterSurfaceRecord::setChoppiness ( const DtFloat32 &  chop )

virtual

Set the Choppiness.

virtual void DtWaterSurfaceRecord::setCurrentStruct ( const DtWaterCurrentStruct &  current )

virtual

Set the WaterCurrent Struct.

virtual void DtWaterSurfaceRecord::setDriveSeaStateFromWind ( const bool &  dssfw )

virtual

Set the DriveSeaStateFromWind.

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

virtual

Sets the record from an address and length.

Return code will be Valid if all goes well. Memory must exist for life of the variable record

Reimplemented from DtMetocLayerRecord.

virtual void DtWaterSurfaceRecord::setIceStruct ( const DtIceStruct &  layer )

virtual

Set the Ice Struct.

static void DtWaterSurfaceRecord::setRecordTypeToUse ( unsigned int  typeToUse )

static

Set the record type to use.

virtual void DtWaterSurfaceRecord::setSalinity ( const DtFloat32 &  sal )

virtual

Set the Salinity.

virtual void DtWaterSurfaceRecord::setSeaState ( const DtSeaStateEnum16 &  ss )

virtual

Set the SeaState.

virtual void DtWaterSurfaceRecord::setSurfaceTransparency ( const DtFloat32 &  st )

virtual

Set the SurfaceTransparency.

virtual void DtWaterSurfaceRecord::setSurgeDepth ( const DtFloat32 &  sd )

virtual

Set the SurgeDepth.

virtual void DtWaterSurfaceRecord::setSwellStruct ( const DtWaveStruct &  swell )

virtual

Set the Swell Struct.

virtual void DtWaterSurfaceRecord::setTide ( const DtFloat32 &  tide )

virtual

Set the Tide.

virtual void DtWaterSurfaceRecord::setWaveStruct ( const DtWaveStruct &  current )

virtual

Set the Wave Struct.

virtual const DtFloat32 DtWaterSurfaceRecord::surfaceTransparency ( ) const

virtual

Get the SurfaceTransparency.

virtual const DtFloat32 DtWaterSurfaceRecord::surgeDepth ( ) const

virtual

Get the SurgeDepth.

virtual const DtWaveStruct DtWaterSurfaceRecord::swellStruct ( ) const

virtual

Get the Swell Struct.

virtual const DtFloat32 DtWaterSurfaceRecord::tide ( ) const

virtual

Get the Tide.

virtual unsigned int DtWaterSurfaceRecord::unpaddedNetsize ( ) const

virtual

This is the network size of the record without padding.

Reimplemented from DtMetocLayerRecord.

virtual const DtWaveStruct DtWaterSurfaceRecord::waveStruct ( ) const

virtual

Get the Wave Struct.

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

virtual

Reimplemented from DtMetocLayerRecord.

Member Data Documentation

DtNetWaterSurfaceRecord* DtWaterSurfaceRecord::myRecordPtr

protected

const unsigned int DtWaterSurfaceRecord::theMinimumSize

staticprotected

---

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

• waterSurfaceRecord.h