VR-Forces 5.0.1 Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Friends
makArchives::DtTerrainRecord Class Reference

Record of a VR-Vantage terrain Contains: Terrain coordinate system Terrain patches Feature layers Terrain operations (extract props, etc.) Terrain settings defined elsewhere.

Public Types

typedef std::list
< DtTerrainPatchRecord
TerrainPatchRecords
 
typedef std::list
< DtFeatureLayerRecord
FeatureLayerRecords
 
typedef std::list
< DtOceanLayerRecord
OceanLayerRecords
 
typedef std::list
< DtGenericTerrainRecord
GenericRecords
 
typedef std::list
< DtTerrainOperationRecord
TerrainOperations
 
typedef std::map< std::string,
std::string > 
OptionalParameterMap
 

Public Member Functions

 DtTerrainRecord ()
 
 DtTerrainRecord (const DtTerrainRecord &orig)
 
bool operator== (const DtTerrainRecord &orig) const
 
bool operator!= (const DtTerrainRecord &orig) const
 
DtTerrainRecordoperator= (const DtTerrainRecord &orig)
 
virtual ~DtTerrainRecord ()
 
const std::string & coordinateSystem () const
 
const std::string & coordinateSystemParameters () const
 
void setCoordinateSystem (const std::string &cs)
 
void setCoordinateSystemParameters (const std::string &csp)
 
TerrainPatchRecordsterrainPatchRecords ()
 
const TerrainPatchRecordsterrainPatchRecords () const
 
FeatureLayerRecordsfeatureLayerRecords ()
 
const FeatureLayerRecordsfeatureLayerRecords () const
 
void setFeatureLayerRecords (const FeatureLayerRecords &records)
 
OceanLayerRecordsoceanLayerRecords ()
 
const OceanLayerRecordsoceanLayerRecords () const
 
void setOceanLayerRecords (const OceanLayerRecords &records)
 
GenericRecordsgenericRecords ()
 
const GenericRecordsgenericRecords () const
 
void setGenericRecords (const GenericRecords &records)
 
const TerrainOperationsterrainOperations () const
 
void setTerrainOperations (const TerrainOperations &operations)
 
virtual const std::string * findOptionalParameter (const std::string &name) const
 
virtual void setOptionalParameter (const std::string &name, const std::string &value)
 
virtual void setOptionalParameters (const OptionalParameterMap &)
 
virtual void removeOptionalParameter (const std::string &name)
 
const OptionalParameterMapoptionalParameters () const
 
virtual void setDescription (const std::string &description)
 
virtual const std::string & description () const
 
virtual void setUseICO (bool useICO)
 
virtual bool useICO () const
 

Protected Member Functions

template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 

Protected Attributes

std::string myCoordinateSystem
 
std::string myCoordinateSystemParameters
 
TerrainPatchRecords myTerrainPatchRecords
 
FeatureLayerRecords myFeatureLayerRecords
 
GenericRecords myGenericRecords
 
TerrainOperations myTerrainOperations
 
OceanLayerRecords myOceanLayerRecords
 
OptionalParameterMap myOptionalParameters
 
std::string myDescription
 
bool myUseICO
 

Friends

class boost::serialization::access
 

Member Typedef Documentation

typedef std::map<std::string,std::string> makArchives::DtTerrainRecord::OptionalParameterMap

Constructor & Destructor Documentation

makArchives::DtTerrainRecord::DtTerrainRecord ( )

CTOR.

makArchives::DtTerrainRecord::DtTerrainRecord ( const DtTerrainRecord orig)

Copy CTOR.

virtual makArchives::DtTerrainRecord::~DtTerrainRecord ( )
virtual

DTOR.

Member Function Documentation

bool makArchives::DtTerrainRecord::operator== ( const DtTerrainRecord orig) const
bool makArchives::DtTerrainRecord::operator!= ( const DtTerrainRecord orig) const
DtTerrainRecord& makArchives::DtTerrainRecord::operator= ( const DtTerrainRecord orig)

Assignment OP.

const std::string& makArchives::DtTerrainRecord::coordinateSystem ( ) const

The coordinate system type is determined by the active coordinate converter.

const std::string& makArchives::DtTerrainRecord::coordinateSystemParameters ( ) const

The coordinate system parameters.

void makArchives::DtTerrainRecord::setCoordinateSystem ( const std::string &  cs)

Set the current coordinate system.

void makArchives::DtTerrainRecord::setCoordinateSystemParameters ( const std::string &  csp)

Set the current coordinate system parameters. The format of the parameters varies for each coordinate system type.

TerrainPatchRecords& makArchives::DtTerrainRecord::terrainPatchRecords ( )

TerrainPatchRecords accessor.

const TerrainPatchRecords& makArchives::DtTerrainRecord::terrainPatchRecords ( ) const

TerrainPatchRecords accessor.

FeatureLayerRecords& makArchives::DtTerrainRecord::featureLayerRecords ( )

FeatureLayerRecords accessor.

const FeatureLayerRecords& makArchives::DtTerrainRecord::featureLayerRecords ( ) const

FeatureLayerRecords accessor.

void makArchives::DtTerrainRecord::setFeatureLayerRecords ( const FeatureLayerRecords records)

FeatureLayerRecords mutator.

OceanLayerRecords& makArchives::DtTerrainRecord::oceanLayerRecords ( )

OceanLayerRecords accessor.

const OceanLayerRecords& makArchives::DtTerrainRecord::oceanLayerRecords ( ) const

FeatureLayerRecords accessor.

void makArchives::DtTerrainRecord::setOceanLayerRecords ( const OceanLayerRecords records)

FeatureLayerRecords mutator.

GenericRecords& makArchives::DtTerrainRecord::genericRecords ( )

GenericRecords accessor.

const GenericRecords& makArchives::DtTerrainRecord::genericRecords ( ) const

GenericRecords accessor.

void makArchives::DtTerrainRecord::setGenericRecords ( const GenericRecords records)

GenericRecords mutator.

const TerrainOperations& makArchives::DtTerrainRecord::terrainOperations ( ) const

TerrainOperations accessor.

void makArchives::DtTerrainRecord::setTerrainOperations ( const TerrainOperations operations)

TerrainOperations mutator.

virtual const std::string* makArchives::DtTerrainRecord::findOptionalParameter ( const std::string &  name) const
virtual

Find an optional parameter.

virtual void makArchives::DtTerrainRecord::setOptionalParameter ( const std::string &  name,
const std::string &  value 
)
virtual

Set an optional parameter.

virtual void makArchives::DtTerrainRecord::setOptionalParameters ( const OptionalParameterMap )
virtual

Set an optional parameters. This will overwrite any existing optional parameters.

virtual void makArchives::DtTerrainRecord::removeOptionalParameter ( const std::string &  name)
virtual

Remove an optional parameter.

const OptionalParameterMap& makArchives::DtTerrainRecord::optionalParameters ( ) const

Get the optional parameters.

virtual void makArchives::DtTerrainRecord::setDescription ( const std::string &  description)
virtual

Set the terrain description.

virtual const std::string& makArchives::DtTerrainRecord::description ( ) const
virtual

Get the terrain description.

virtual void makArchives::DtTerrainRecord::setUseICO ( bool  useICO)
virtual

Set the use ICO flag.

virtual bool makArchives::DtTerrainRecord::useICO ( ) const
virtual

Get the use ICO flag.

template<class Archive >
void makArchives::DtTerrainRecord::serialize ( Archive &  ar,
const unsigned int  version 
)
inlineprotected

When the class Archive corresponds to an output archive, the & operator is defined similar to <<. Likewise, when the class Archive is a type of input archive the & operator is defined similar to >>.

Friends And Related Function Documentation

friend class boost::serialization::access
friend

Member Data Documentation

std::string makArchives::DtTerrainRecord::myCoordinateSystem
protected
std::string makArchives::DtTerrainRecord::myCoordinateSystemParameters
protected
TerrainPatchRecords makArchives::DtTerrainRecord::myTerrainPatchRecords
protected
FeatureLayerRecords makArchives::DtTerrainRecord::myFeatureLayerRecords
protected
GenericRecords makArchives::DtTerrainRecord::myGenericRecords
protected
TerrainOperations makArchives::DtTerrainRecord::myTerrainOperations
protected
OceanLayerRecords makArchives::DtTerrainRecord::myOceanLayerRecords
protected
OptionalParameterMap makArchives::DtTerrainRecord::myOptionalParameters
protected
std::string makArchives::DtTerrainRecord::myDescription
protected
bool makArchives::DtTerrainRecord::myUseICO
protected

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

Document ID: Generated on Mon Jun 20 00:38:30 EDT 2022 from SVN revision 244029
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)