DtWaterSurfaceStateRepository Class Reference

Instances of DtWaterSurfaceStateRepository are used to store state data for METOC_Root.EnvironmentCondition.Weather.WaterSurface objects. More...

Inheritance diagram for DtWaterSurfaceStateRepository:

Collaboration diagram for DtWaterSurfaceStateRepository:

Public Member Functions
	DtWaterSurfaceStateRepository ()
	Constructor. More...
virtual	~DtWaterSurfaceStateRepository ()
	Destructor. More...
	DtWaterSurfaceStateRepository (const DtWaterSurfaceStateRepository &orig)
	Copy Constructor. More...
DtWaterSurfaceStateRepository &	operator= (const DtWaterSurfaceStateRepository &orig)
	Assignment Operator. More...
virtual DtStateRepository *	clone (bool copy) const
	Return a copy/empty object of the same type as this. More...
virtual void	printData () const
	Print data to the DtInfo stream. More...
virtual void	printDataToStream (std::ostream &stream) const
	Print data to the specified stream. More...
virtual void	setSeaState (const DtSeaStateEnum16 &val)
	Set the SeaState. More...
virtual const DtSeaStateEnum16 &	seaState () const
	Get the SeaState. More...
virtual void	setSalinity (const DtFloat32 &val)
	Set the Salinity. More...
virtual const DtFloat32 &	salinity () const
	Get the Salinity. More...
virtual void	setTide (const DtFloat32 &val)
	Set the Tide. More...
virtual const DtFloat32 &	tide () const
	Get the Tide. More...
virtual void	setIce (const DtIceStruct &val)
	Set the Ice. More...
virtual const DtIceStruct &	ice () const
	Get the Ice. More...
virtual void	setCurrent (const DtWaterCurrentStruct &val)
	Set the Current. More...
virtual const DtWaterCurrentStruct &	current () const
	Get the Current. More...
virtual void	setWave (const DtWaveStruct &val)
	Set the Wave. More...
virtual const DtWaveStruct &	wave () const
	Get the Wave. More...
virtual void	setSwell (const DtWaveStruct &val)
	Set the Swell. More...
virtual const DtWaveStruct &	swell () const
	Get the Swell. More...
virtual void	setPriority (const DtU16 &val)
	Set the Priority. More...
virtual const DtU16 &	priority () const
	Get the Priority. More...
virtual void	setChoppiness (DtFloat32 val)
	Set the Choppiness. More...
virtual DtFloat32	choppiness () const
	Get the Choppiness. More...
virtual void	setSurgeDepth (DtFloat32 val)
	Set the SurgeDepth. More...
virtual DtFloat32	surgeDepth () const
	Get the SurgeDepth. More...
virtual void	setSurfaceTransparency (DtFloat32 val)
	Set the SurfaceTransparency. More...
virtual DtFloat32	surfaceTransparency () const
	Get the SurfaceTransparency. More...
virtual void	setDriveSeaStateFromWind (bool val)
	Set the DriveSeaStateFromWind. More...
virtual bool	driveSeaStateFromWind () const
	Get the DriveSeaStateFromWind. More...
Public Member Functions inherited from DtWeatherStateRepository
	DtWeatherStateRepository ()
	Constructor. More...
virtual	~DtWeatherStateRepository ()
	Destructor. More...
	DtWeatherStateRepository (const DtWeatherStateRepository &orig)
	Copy Constructor. More...
DtWeatherStateRepository &	operator= (const DtWeatherStateRepository &orig)
	Assignment Operator. More...
virtual void	setTemperature (DtFloat32 val)
	Set the Temperature. More...
virtual DtFloat32	temperature () const
	Get the Temperature.". More...
virtual void	setWind (const DtWindStruct &val)
	Set the Wind. More...
virtual const DtWindStruct &	wind () const
	Get the Wind.". More...
virtual void	setPrecipitation (const DtPrecipitationStruct &val)
	Set the Precipitation. More...
virtual const DtPrecipitationStruct &	precipitation () const
	Get the Precipitation.". More...
virtual void	setHaze (const DtHazeStruct &val)
	Set the Haze. More...
virtual const DtHazeStruct &	haze () const
	Get the Haze.". More...
virtual void	setHumidity (DtFloat32 val)
	Set the Humidity. More...
virtual DtFloat32	humidity () const
	Get the Humidity.". More...
virtual void	setBarometricPressure (DtFloat32 val)
	Set the BarometricPressure. More...
virtual DtFloat32	barometricPressure () const
	Get the BarometricPressure.". More...
virtual void	setVisibilityRange (DtFloat32 val)
	Set the VisibilityRange. More...
virtual DtFloat32	visibilityRange () const
	Get the VisibilityRange. More...
Public Member Functions inherited from DtEnvironmentConditionStateRepository
	DtEnvironmentConditionStateRepository ()
	Constructor. More...
virtual	~DtEnvironmentConditionStateRepository ()
	Destructor. More...
	DtEnvironmentConditionStateRepository (const DtEnvironmentConditionStateRepository &orig)
	Copy Constructor. More...
DtEnvironmentConditionStateRepository &	operator= (const DtEnvironmentConditionStateRepository &orig)
	Assignment Operator. More...
virtual void	setServiceId (const DtVrlUuid &val)
	Set the ServiceId. More...
virtual const DtVrlUuid &	serviceId () const
	Get the ServiceId. More...
virtual void	setGeoReference (const DtGeoReferenceVariant &val)
	Set the GeoReference. More...
virtual const DtGeoReferenceVariant &	geoReference () const
	Get the GeoReference. More...
virtual bool	isGlobalGeoreference () const
	returns true if the geo reference object is global. More...
virtual void	setIsMakMetocObject (bool val)
	Set if this object is a MAK extended class. More...
virtual bool	isMakMetocObject () const
	returns true if this object is a MAK Extended METOC object opposed to a NETN METOC object without MAK extensions More...
Public Member Functions inherited from DtMetocRootStateRepository
	DtMetocRootStateRepository ()
	Constructor. More...
virtual	~DtMetocRootStateRepository ()
	Destructor. More...
	DtMetocRootStateRepository (const DtMetocRootStateRepository &orig)
	Copy Constructor. More...
DtMetocRootStateRepository &	operator= (const DtMetocRootStateRepository &orig)
	Assignment Operator. More...
virtual void	setUniqueId (const DtVrlUuid &val)
	Set the UniqueId. More...
virtual const DtVrlUuid &	uniqueId () const
	Get the UniqueId. More...
virtual void	setName (const DtString &val)
	Set the Name. More...
virtual const DtString &	name () const
	Get the Name. More...
virtual void	setVrfWeatherAreaIdentifier (const DtVrlUuid &vrfWeatherAreaIdentifier)
	Set the UniqueId. More...
virtual DtVrlUuid	vrfWeatherAreaIdentifier () const
	Get the UniqueId. More...
Public Member Functions inherited from DtStateRepository
	DtStateRepository ()
	default constructor More...
	DtStateRepository (const DtStateRepository &orig)
	copy constructor More...
virtual	~DtStateRepository ()
	destructor More...
DtStateRepository &	operator= (const DtStateRepository &orig)
	assignment operator More...
virtual void	setGlobalId (const DtString &id)
	Get/Set global identifier, or name. More...
virtual const DtString &	globalId () const
virtual void	setLocalId (const DtObjectId &id)
	Get/Set local identifier, or handle. More...
virtual const DtObjectId &	localId () const
virtual bool	publishesAttribute (const RTI::AttributeHandle &val) const
	Returns true if the attribute is published. More...
virtual void	setAttributeByHandle (const RTI::AttributeHandle &attrHdl, const char *attrValue, unsigned size)
	Set the attribute with the given handle. More...
virtual const char *	getAttributeByHandle (const RTI::AttributeHandle &attrHdl, unsigned &size) const
	Get a pointer to attribute value for the attribute with the given handle. More...
virtual void	setAttributeByName (const DtString &attrName, const char *attrValue, unsigned size, DtHlaObject *hlaObj)
	Set the attribute with the given name. Note that in order to do this you must provide a DtHlaObject. More...
virtual const char *	getAttributeByName (const DtString &attrName, unsigned &size, DtHlaObject *hlaObj) const
	Get a pointer to attribute value for the attribute with the given name. More...
virtual const char *	getAttributeByHandleIfUpdated (const RTI::AttributeHandle &attrHdl, unsigned &size) const
	Get a pointer to attribute value for the attribute with the given handle, but only if it's been updated since the last time we read it. More...
virtual DtStateRepositoryExtension *	stateRepositoryExtension (DtString srExtName) const
	Returns pointer to a DtStateRepositoryExtension object with the given name Returns 0 if no extension with given name is found. More...
virtual std::vector< DtString >	stateRepositoryExtensionNames () const
	Returns a set of the registered state repository extension names. More...
virtual void	setStateRepositoryExtensions (std::map< DtString, DtStateRepositoryExtension * > extensions)
	Returns pointer to a DtStateRepositoryExtension object with the given name Returns 0 if no extension with given name is found. More...
virtual const std::map < DtString, DtStateRepositoryExtension * >	stateRepositoryExtensions () const
	Returns pointer to a DtStateRepositoryExtension object with the given name Returns 0 if no extension with given name is found. More...

Static Public Member Functions
static DtWaterSurfaceStateRepository *	create ()
	Create a DtWaterSurfaceStateRepository. More...
Static Public Member Functions inherited from DtWeatherStateRepository
static DtWeatherStateRepository *	create ()
	Create a DtWeatherStateRepository. More...
Static Public Member Functions inherited from DtEnvironmentConditionStateRepository
static DtEnvironmentConditionStateRepository *	create ()
	Create a DtEnvironmentConditionStateRepository. More...
Static Public Member Functions inherited from DtMetocRootStateRepository
static DtMetocRootStateRepository *	create ()
	Create a DtMetocRootStateRepository. More...
Static Public Member Functions inherited from DtStateRepository
static bool	addStateRepositoryExtension (DtString srExtName, DtSrExtCreatorFnc fnc)
	The following functions are for extending state repositories through State Repository Extension classes. More...

Protected Attributes
DtSeaStateEnum16	mySeaState
DtFloat32	mySalinity
DtFloat32	myTide
DtIceStruct	myIce
DtWaterCurrentStruct	myCurrent
DtWaveStruct	myWave
DtWaveStruct	mySwell
DtU16	myPriority
DtFloat32	myChoppiness
DtFloat32	mySurgeDepth
DtFloat32	mySurfaceTransparency
bool	myDriveSeaStateFromWind
Protected Attributes inherited from DtWeatherStateRepository
DtFloat32	myTemperature
DtWindStruct	myWind
DtPrecipitationStruct	myPrecipitation
DtHazeStruct	myHaze
DtFloat32	myHumidity
DtFloat32	myBarometricPressure
DtFloat32	myVisibilityRange
Protected Attributes inherited from DtEnvironmentConditionStateRepository
DtVrlUuid	myServiceId
DtGeoReferenceVariant	myGeoReference
bool	myIsMakMetocObject
Protected Attributes inherited from DtMetocRootStateRepository
DtVrlUuid	myUniqueId
DtString	myName
DtVrlUuid	myVrfWeatherAreaId

Additional Inherited Members
Public Types inherited from DtStateRepository
typedef std::map< DtString, DtStateRepositoryExtension * >	DtStateRepositoryExtensionMap
Public Attributes inherited from DtStateRepository
DtString	myGlobalId
DtObjectId	myLocalId
std::map< RTI::AttributeHandle, DtGenericAttributeInfo * >	myAttributesByHandle
	Attributes by handle. More...
DtStateRepositoryExtensionMap	myStateRepositoryExtensionMap
Static Public Attributes inherited from DtStateRepository
static std::map< DtString, DtSrExtCreatorFnc >	theStateRepositoryExtensionCreatorMap

Detailed Description

Instances of DtWaterSurfaceStateRepository are used to store state data for METOC_Root.EnvironmentCondition.Weather.WaterSurface objects.

Constructor & Destructor Documentation

DtWaterSurfaceStateRepository::DtWaterSurfaceStateRepository

(

)

Constructor.

virtual DtWaterSurfaceStateRepository::~DtWaterSurfaceStateRepository ( )

virtual

Destructor.

DtWaterSurfaceStateRepository::DtWaterSurfaceStateRepository

(

const DtWaterSurfaceStateRepository &

orig

)

Copy Constructor.

Member Function Documentation

virtual DtFloat32 DtWaterSurfaceStateRepository::choppiness ( ) const

virtual

Get the Choppiness.

virtual DtStateRepository* DtWaterSurfaceStateRepository::clone ( bool  copy ) const

virtual

Return a copy/empty object of the same type as this.

Reimplemented from DtWeatherStateRepository.

static DtWaterSurfaceStateRepository* DtWaterSurfaceStateRepository::create ( )

static

Create a DtWaterSurfaceStateRepository.

virtual const DtWaterCurrentStruct& DtWaterSurfaceStateRepository::current ( ) const

virtual

Get the Current.

virtual bool DtWaterSurfaceStateRepository::driveSeaStateFromWind ( ) const

virtual

Get the DriveSeaStateFromWind.

virtual const DtIceStruct& DtWaterSurfaceStateRepository::ice ( ) const

virtual

Get the Ice.

DtWaterSurfaceStateRepository& DtWaterSurfaceStateRepository::operator=

(

const DtWaterSurfaceStateRepository &

orig

)

Assignment Operator.

virtual void DtWaterSurfaceStateRepository::printData ( ) const

virtual

Print data to the DtInfo stream.

Reimplemented from DtWeatherStateRepository.

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

virtual

Print data to the specified stream.

Reimplemented from DtWeatherStateRepository.

virtual const DtU16& DtWaterSurfaceStateRepository::priority ( ) const

virtual

Get the Priority.

virtual const DtFloat32& DtWaterSurfaceStateRepository::salinity ( ) const

virtual

Get the Salinity.

virtual const DtSeaStateEnum16& DtWaterSurfaceStateRepository::seaState ( ) const

virtual

Get the SeaState.

virtual void DtWaterSurfaceStateRepository::setChoppiness ( DtFloat32  val )

virtual

Set the Choppiness.

virtual void DtWaterSurfaceStateRepository::setCurrent ( const DtWaterCurrentStruct &  val )

virtual

Set the Current.

virtual void DtWaterSurfaceStateRepository::setDriveSeaStateFromWind ( bool  val )

virtual

Set the DriveSeaStateFromWind.

virtual void DtWaterSurfaceStateRepository::setIce ( const DtIceStruct &  val )

virtual

Set the Ice.

virtual void DtWaterSurfaceStateRepository::setPriority ( const DtU16 &  val )

virtual

Set the Priority.

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

virtual

Set the Salinity.

virtual void DtWaterSurfaceStateRepository::setSeaState ( const DtSeaStateEnum16 &  val )

virtual

Set the SeaState.

virtual void DtWaterSurfaceStateRepository::setSurfaceTransparency ( DtFloat32  val )

virtual

Set the SurfaceTransparency.

virtual void DtWaterSurfaceStateRepository::setSurgeDepth ( DtFloat32  val )

virtual

Set the SurgeDepth.

virtual void DtWaterSurfaceStateRepository::setSwell ( const DtWaveStruct &  val )

virtual

Set the Swell.

virtual void DtWaterSurfaceStateRepository::setTide ( const DtFloat32 &  val )

virtual

Set the Tide.

virtual void DtWaterSurfaceStateRepository::setWave ( const DtWaveStruct &  val )

virtual

Set the Wave.

virtual DtFloat32 DtWaterSurfaceStateRepository::surfaceTransparency ( ) const

virtual

Get the SurfaceTransparency.

virtual DtFloat32 DtWaterSurfaceStateRepository::surgeDepth ( ) const

virtual

Get the SurgeDepth.

virtual const DtWaveStruct& DtWaterSurfaceStateRepository::swell ( ) const

virtual

Get the Swell.

virtual const DtFloat32& DtWaterSurfaceStateRepository::tide ( ) const

virtual

Get the Tide.

virtual const DtWaveStruct& DtWaterSurfaceStateRepository::wave ( ) const

virtual

Get the Wave.

Member Data Documentation

DtFloat32 DtWaterSurfaceStateRepository::myChoppiness

protected

DtWaterCurrentStruct DtWaterSurfaceStateRepository::myCurrent

protected

bool DtWaterSurfaceStateRepository::myDriveSeaStateFromWind

protected

DtIceStruct DtWaterSurfaceStateRepository::myIce

protected

DtU16 DtWaterSurfaceStateRepository::myPriority

protected

DtFloat32 DtWaterSurfaceStateRepository::mySalinity

protected

DtSeaStateEnum16 DtWaterSurfaceStateRepository::mySeaState

protected

DtFloat32 DtWaterSurfaceStateRepository::mySurfaceTransparency

protected

DtFloat32 DtWaterSurfaceStateRepository::mySurgeDepth

protected

DtWaveStruct DtWaterSurfaceStateRepository::mySwell

protected

DtFloat32 DtWaterSurfaceStateRepository::myTide

protected

DtWaveStruct DtWaterSurfaceStateRepository::myWave

protected

---

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

• waterSurfaceStateRepository.h