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

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 ()
	CTOR.
	DtTerrainRecord (const DtTerrainRecord &orig)
	Copy CTOR.
DtTerrainRecord &	operator= (const DtTerrainRecord &orig)
	Assignment OP.
virtual	~DtTerrainRecord ()
	DTOR.
const std::string &	coordinateSystem () const
	The coordinate system type is determined by the active coordinate converter.
const std::string &	coordinateSystemParameters () const
	The coordinate system parameters.
void	setCoordinateSystem (const std::string &cs)
	Set the current coordinate system.
void	setCoordinateSystemParameters (const std::string &csp)
	Set the current coordinate system parameters.
TerrainPatchRecords &	terrainPatchRecords ()
	TerrainPatchRecords accessor.
const TerrainPatchRecords &	terrainPatchRecords () const
	TerrainPatchRecords accessor.
FeatureLayerRecords &	featureLayerRecords ()
	FeatureLayerRecords accessor.
const FeatureLayerRecords &	featureLayerRecords () const
	FeatureLayerRecords accessor.
void	setFeatureLayerRecords (const FeatureLayerRecords &records)
	FeatureLayerRecords mutator.
OceanLayerRecords &	oceanLayerRecords ()
	OceanLayerRecords accessor.
const OceanLayerRecords &	oceanLayerRecords () const
	FeatureLayerRecords accessor.
void	setOceanLayerRecords (const OceanLayerRecords &records)
	FeatureLayerRecords mutator.
GenericRecords &	genericRecords ()
	GenericRecords accessor.
const GenericRecords &	genericRecords () const
	GenericRecords accessor.
void	setGenericRecords (const GenericRecords &records)
	GenericRecords mutator.
const TerrainOperations &	terrainOperations () const
	TerrainOperations accessor.
void	setTerrainOperations (const TerrainOperations &operations)
	TerrainOperations mutator.
virtual const std::string *	findOptionalParameter (const std::string &name) const
	Find an optional parameter.
virtual void	setOptionalParameter (const std::string &name, const std::string &value)
	Set an optional parameter.
virtual void	setOptionalParameters (const OptionalParameterMap &)
	Set an optional parameters.
virtual void	removeOptionalParameter (const std::string &name)
	Remove an optional parameter.
const OptionalParameterMap &	optionalParameters () const
	Get the optional parameters.
virtual void	setDescription (const std::string &description)
	Set the terrain description.
virtual const std::string &	description () const
	Get the terrain description.
virtual void	setUseICO (bool useICO)
	Set the use ICO flag.
virtual bool	useICO () const
	Get the use ICO flag.

Protected Member Functions
template<class Archive >
void	serialize (Archive &ar, const unsigned int version)
	When the class Archive corresponds to an output archive, the & operator is defined similar to <<.

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

Detailed Description

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

Member Typedef Documentation

typedef std::list<DtTerrainPatchRecord> makArchives::DtTerrainRecord::TerrainPatchRecords

typedef std::list<DtFeatureLayerRecord> makArchives::DtTerrainRecord::FeatureLayerRecords

typedef std::list<DtOceanLayerRecord> makArchives::DtTerrainRecord::OceanLayerRecords

typedef std::list<DtGenericTerrainRecord> makArchives::DtTerrainRecord::GenericRecords

typedef std::list<DtTerrainOperationRecord> makArchives::DtTerrainRecord::TerrainOperations

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

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:

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/makArchives/DtTerrainRecord.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation