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 | Static Public Member Functions | Protected Attributes
DtSubsurfaceLayerStateRepository Class Reference

Instances of DtSubsurfaceLayerStateRepository are used to store state data for METOC_Root.EnvironmentCondition.SubsurfaceLayer objects. More...

+ Inheritance diagram for DtSubsurfaceLayerStateRepository:
+ Collaboration diagram for DtSubsurfaceLayerStateRepository:

Public Member Functions

 DtSubsurfaceLayerStateRepository ()
 Constructor. More...
 
virtual ~DtSubsurfaceLayerStateRepository ()
 Destructor. More...
 
 DtSubsurfaceLayerStateRepository (const DtSubsurfaceLayerStateRepository &orig)
 Copy Constructor. More...
 
DtSubsurfaceLayerStateRepositoryoperator= (const DtSubsurfaceLayerStateRepository &orig)
 Assignment Operator. More...
 
virtual DtStateRepositoryclone (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 setTemperature (const DtFloat32 &val)
 Set the Temperature. More...
 
virtual const DtFloat32temperature () const
 Get the Temperature. More...
 
virtual void setLayer (const DtLayerStruct &val)
 Set the Layer. More...
 
virtual const DtLayerStructlayer () const
 Get the Layer. More...
 
virtual void setCurrent (const DtWaterCurrentStruct &val)
 Set the Current. More...
 
virtual const
DtWaterCurrentStruct
current () const
 Get the Current. More...
 
virtual void setSalinity (const DtFloat32 &val)
 Set the Salinity. More...
 
virtual const DtFloat32salinity () 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 setVisibilityRange (const DtFloat32 &val)
 Set the VisibilityRange. More...
 
virtual const DtFloat32visibilityRange () const
 Get the VisibilityRange. More...
 
virtual void setPermeability (const DtFloat32 &val)
 Set the Permeability. More...
 
virtual const DtFloat32permeability () const
 Get the Permeability. More...
 
virtual void setPriority (const DtU16 &val)
 Set the Priority. More...
 
virtual const DtU16priority () const
 Get the Priority. More...
 
- Public Member Functions inherited from DtEnvironmentConditionStateRepository
 DtEnvironmentConditionStateRepository ()
 Constructor. More...
 
virtual ~DtEnvironmentConditionStateRepository ()
 Destructor. More...
 
 DtEnvironmentConditionStateRepository (const DtEnvironmentConditionStateRepository &orig)
 Copy Constructor. More...
 
DtEnvironmentConditionStateRepositoryoperator= (const DtEnvironmentConditionStateRepository &orig)
 Assignment Operator. More...
 
virtual void setServiceId (const DtVrlUuid &val)
 Set the ServiceId. More...
 
virtual const DtVrlUuidserviceId () 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...
 
DtMetocRootStateRepositoryoperator= (const DtMetocRootStateRepository &orig)
 Assignment Operator. More...
 
virtual void setUniqueId (const DtVrlUuid &val)
 Set the UniqueId. More...
 
virtual const DtVrlUuiduniqueId () const
 Get the UniqueId. More...
 
virtual void setName (const DtString &val)
 Set the Name. More...
 
virtual const DtStringname () 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...
 
DtStateRepositoryoperator= (const DtStateRepository &orig)
 assignment operator More...
 
virtual void setGlobalId (const DtGlobalObjectDesignator &id)
 Get/Set global identifier, or name. More...
 
virtual const
DtGlobalObjectDesignator
globalId () const
 
virtual unsigned int numberOfAttributeRecords () const
 
virtual void setAttributeRecords (const DtAttributeRecordSet &records)
 The following functions are related to the extendability part of DIS 7. More...
 
virtual void setAttributeRecords (const DtStandardVariableRecordPtrVector &records)
 Replace the attribute record set with the records in the given vector. More...
 
virtual const
DtAttributeRecordSet
attributeRecordSet () const
 Return the attribute record set. More...
 
virtual DtAttributeRecordSetattributeRecordSet ()
 Return the attribute record set. More...
 
virtual const
DtStandardVariableRecordPtrVector
attributeRecords () const
 Return the attribute records Any changes to the returned record(s) will modify the records in the recordSet. More...
 
virtual const
DtStandardVariableRecordPtrVector
attributeRecords (unsigned int recordType) const
 Return the attribute records of the given type (all records if type is 0) Any changes to the returned record(s) will modify the records in the recordSet. More...
 
virtual DtStandardVariableRecordattributeRecord (unsigned int recordType) const
 Return the (first) attribute record of the given type (first record if type is 0) Any changes to the returned record will modify the record in the recordSet. More...
 
virtual int removeAttributeRecord (unsigned int recordType, bool removeAll=true)
 Remove and discard the first record of the given record type (if there is one) or all them. More...
 
virtual
DtStandardVariableRecordPtrVector
getAttributeRecords (unsigned int recordType, DtStandardVariableRecordPtrVector &vec) const
 Get the attribute records of the given type (all if type is 0) Any changes to the returned record(s) will modify the records in the recordSet. More...
 
virtual
DtStandardVariableRecordPtrVector
getAttributeRecords (DtStandardVariableRecordPtrVector &vec) const
 Get the attribute records Any changes to the returned record(s) will modify the records in the recordSet. More...
 
virtual void addAttributeRecord (DtStandardVariableRecord *record)
 Add a clone of given record to the attribute record set. More...
 
virtual void addAttributeRecord (std::auto_ptr< DtStandardVariableRecord > record)
 Add the given record to the attribute record set. More...
 
virtual void clearAttributeRecords ()
 Clear all records. 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< DtStringstateRepositoryExtensionNames () 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
DtSubsurfaceLayerStateRepository
create ()
 Create a DtSubsurfaceLayerStateRepository. More...
 
- Static Public Member Functions inherited from DtEnvironmentConditionStateRepository
static
DtEnvironmentConditionStateRepository
create ()
 Create a DtEnvironmentConditionStateRepository. More...
 
- Static Public Member Functions inherited from DtMetocRootStateRepository
static DtMetocRootStateRepositorycreate ()
 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

DtFloat32 myTemperature
 
DtLayerStruct myLayer
 
DtWaterCurrentStruct myCurrent
 
DtFloat32 mySalinity
 
DtSedimentTypeEnum32 myBottomType
 
DtFloat32 myVisibilityRange
 
DtFloat32 myPermeability
 
DtU16 myPriority
 
- 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
DtGlobalObjectDesignator myGlobalId
 
DtAttributeRecordSet myAttributeRecords
 
DtStandardVariableRecordPtrVector myReturnedRecords
 
DtStateRepositoryExtensionMap myStateRepositoryExtensionMap
 
- Static Public Attributes inherited from DtStateRepository
static std::map< DtString,
DtSrExtCreatorFnc
theStateRepositoryExtensionCreatorMap
 

Detailed Description

Instances of DtSubsurfaceLayerStateRepository are used to store state data for METOC_Root.EnvironmentCondition.SubsurfaceLayer objects.

Constructor & Destructor Documentation

DtSubsurfaceLayerStateRepository::DtSubsurfaceLayerStateRepository ( )

Constructor.

virtual DtSubsurfaceLayerStateRepository::~DtSubsurfaceLayerStateRepository ( )
virtual

Destructor.

DtSubsurfaceLayerStateRepository::DtSubsurfaceLayerStateRepository ( const DtSubsurfaceLayerStateRepository orig)

Copy Constructor.

Member Function Documentation

virtual const DtSedimentTypeEnum32& DtSubsurfaceLayerStateRepository::bottomType ( ) const
virtual

Get the BottomType.

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

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

Reimplemented from DtEnvironmentConditionStateRepository.

static DtSubsurfaceLayerStateRepository* DtSubsurfaceLayerStateRepository::create ( )
static
virtual const DtWaterCurrentStruct& DtSubsurfaceLayerStateRepository::current ( ) const
virtual

Get the Current.

virtual const DtLayerStruct& DtSubsurfaceLayerStateRepository::layer ( ) const
virtual

Get the Layer.

DtSubsurfaceLayerStateRepository& DtSubsurfaceLayerStateRepository::operator= ( const DtSubsurfaceLayerStateRepository orig)

Assignment Operator.

virtual const DtFloat32& DtSubsurfaceLayerStateRepository::permeability ( ) const
virtual

Get the Permeability.

virtual void DtSubsurfaceLayerStateRepository::printData ( ) const
virtual

Print data to the DtInfo stream.

Reimplemented from DtEnvironmentConditionStateRepository.

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

Print data to the specified stream.

Reimplemented from DtEnvironmentConditionStateRepository.

virtual const DtU16& DtSubsurfaceLayerStateRepository::priority ( ) const
virtual

Get the Priority.

virtual const DtFloat32& DtSubsurfaceLayerStateRepository::salinity ( ) const
virtual

Get the Salinity.

virtual void DtSubsurfaceLayerStateRepository::setBottomType ( const DtSedimentTypeEnum32 val)
virtual

Set the BottomType.

virtual void DtSubsurfaceLayerStateRepository::setCurrent ( const DtWaterCurrentStruct val)
virtual

Set the Current.

virtual void DtSubsurfaceLayerStateRepository::setLayer ( const DtLayerStruct val)
virtual

Set the Layer.

virtual void DtSubsurfaceLayerStateRepository::setPermeability ( const DtFloat32 val)
virtual

Set the Permeability.

virtual void DtSubsurfaceLayerStateRepository::setPriority ( const DtU16 val)
virtual

Set the Priority.

virtual void DtSubsurfaceLayerStateRepository::setSalinity ( const DtFloat32 val)
virtual

Set the Salinity.

virtual void DtSubsurfaceLayerStateRepository::setTemperature ( const DtFloat32 val)
virtual

Set the Temperature.

virtual void DtSubsurfaceLayerStateRepository::setVisibilityRange ( const DtFloat32 val)
virtual

Set the VisibilityRange.

virtual const DtFloat32& DtSubsurfaceLayerStateRepository::temperature ( ) const
virtual

Get the Temperature.

virtual const DtFloat32& DtSubsurfaceLayerStateRepository::visibilityRange ( ) const
virtual

Get the VisibilityRange.

Member Data Documentation

DtSedimentTypeEnum32 DtSubsurfaceLayerStateRepository::myBottomType
protected
DtWaterCurrentStruct DtSubsurfaceLayerStateRepository::myCurrent
protected
DtLayerStruct DtSubsurfaceLayerStateRepository::myLayer
protected
DtFloat32 DtSubsurfaceLayerStateRepository::myPermeability
protected
DtU16 DtSubsurfaceLayerStateRepository::myPriority
protected
DtFloat32 DtSubsurfaceLayerStateRepository::mySalinity
protected
DtFloat32 DtSubsurfaceLayerStateRepository::myTemperature
protected
DtFloat32 DtSubsurfaceLayerStateRepository::myVisibilityRange
protected

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

Document ID: Generated on Wed Mar 27 02:04:30 EDT 2024 from SVN revision 264570
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)