DtSubsurfaceLayerRecord Class Reference

Inheritance diagram for DtSubsurfaceLayerRecord:

Collaboration diagram for DtSubsurfaceLayerRecord:

Public Member Functions
	DtSubsurfaceLayerRecord ()
	Constructor. More...
	DtSubsurfaceLayerRecord (const DtSubsurfaceLayerRecord &orig)
	Copy Constructor. More...
	DtSubsurfaceLayerRecord (void *netBuffer, unsigned int size)
	Net Constructor. More...
virtual DtSubsurfaceLayerRecord &	operator= (const DtSubsurfaceLayerRecord &record)
	Assignment Operator. More...
virtual DtStandardVariableRecord &	operator= (const DtStandardVariableRecord &other)
	Assignment operator. More...
virtual bool	operator== (const DtSubsurfaceLayerRecord &record)
	Equals Operator. More...
virtual bool	operator== (const DtStandardVariableRecord &other)
	Equals operator. More...
virtual void	setLayerStruct (const DtLayerStruct &layer)
	Set the Layer Struct. More...
virtual const DtLayerStruct	layerStruct () const
	Get the Layer 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	setSalinity (const DtFloat32 &val)
	Set the Salinity. More...
virtual const DtFloat32	salinity () const
	Get the Salinity. More...
virtual void	setBottomType (const DtSedimentTypeEnum32 &val)
	Set the BottomType. More...
virtual const DtSedimentTypeEnum32	bottomType () const
	Get the BottomType. More...
virtual void	setPermeability (const DtFloat32 &val)
	Set the Permeability. More...
virtual const DtFloat32	permeability () const
	Get the Permeability. 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 subsurfaceLayer 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
DtNetSubsurfaceLayerRecord *	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

DtSubsurfaceLayerRecord::DtSubsurfaceLayerRecord

(

)

Constructor.

DtSubsurfaceLayerRecord::DtSubsurfaceLayerRecord

(

const DtSubsurfaceLayerRecord &

orig

)

Copy Constructor.

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

Net Constructor.

Member Function Documentation

virtual const DtSedimentTypeEnum32 DtSubsurfaceLayerRecord::bottomType ( ) const

virtual

Get the BottomType.

virtual DtStandardVariableRecord* DtSubsurfaceLayerRecord::clone ( ) const

virtual

Clone.

Reimplemented from DtMetocLayerRecord.

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

static

Creator of an unknown record for registering in a factory.

virtual const DtWaterCurrentStruct DtSubsurfaceLayerRecord::currentStruct ( ) const

virtual

Get the WaterCurrent Struct.

virtual const DtLayerStruct DtSubsurfaceLayerRecord::layerStruct ( ) const

virtual

Get the Layer Struct.

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

virtual

Assignment Operator.

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

virtual

Assignment operator.

Reimplemented from DtMetocLayerRecord.

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

virtual

Equals Operator.

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

virtual

Equals operator.

Reimplemented from DtMetocLayerRecord.

virtual unsigned int DtSubsurfaceLayerRecord::paddedNetSize ( ) const

virtual

This is the network size of the record with padding.

virtual const DtFloat32 DtSubsurfaceLayerRecord::permeability ( ) const

virtual

Get the Permeability.

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

virtual

Prints the data to the specified stream.

Reimplemented from DtMetocLayerRecord.

static unsigned int DtSubsurfaceLayerRecord::recordTypeToUse ( )

static

Return the subsurfaceLayer record type.

virtual const DtFloat32 DtSubsurfaceLayerRecord::salinity ( ) const

virtual

Get the Salinity.

virtual void DtSubsurfaceLayerRecord::setBottomType ( const DtSedimentTypeEnum32 &  val )

virtual

Set the BottomType.

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

virtual

Set the WaterCurrent Struct.

virtual void DtSubsurfaceLayerRecord::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 DtSubsurfaceLayerRecord::setLayerStruct ( const DtLayerStruct &  layer )

virtual

Set the Layer Struct.

virtual void DtSubsurfaceLayerRecord::setPermeability ( const DtFloat32 &  val )

virtual

Set the Permeability.

static void DtSubsurfaceLayerRecord::setRecordTypeToUse ( unsigned int  typeToUse )

static

Set the record type to use.

virtual void DtSubsurfaceLayerRecord::setSalinity ( const DtFloat32 &  val )

virtual

Set the Salinity.

virtual unsigned int DtSubsurfaceLayerRecord::unpaddedNetsize ( ) const

virtual

This is the network size of the record without padding.

Reimplemented from DtMetocLayerRecord.

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

virtual

Reimplemented from DtMetocLayerRecord.

Member Data Documentation

DtNetSubsurfaceLayerRecord* DtSubsurfaceLayerRecord::myRecordPtr

protected

const unsigned int DtSubsurfaceLayerRecord::theMinimumSize

staticprotected

---

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

• subsurfaceLayerRecord.h