makVrv::DtOsgEarthPropertyItemKey Class Reference

DtOsgEarthPropertyItemKey Key of the osgEarth property item, represented by the type and index. More...

Public Member Functions
	DtOsgEarthPropertyItemKey ()
	The default constructor. The key will be invalid. More...
	DtOsgEarthPropertyItemKey (const char *type, const char *ParentType)
	Constructor. More...
	DtOsgEarthPropertyItemKey (const char *type, int index, const char *parentType, int parentIndex)
	Constructor. More...
	DtOsgEarthPropertyItemKey (const std::string &type, const std::string &parentType)
	Constructor. More...
	DtOsgEarthPropertyItemKey (const std::string &type, int index)
	Constructor. More...
	DtOsgEarthPropertyItemKey (const std::string &type, int index, const std::string &parentType, int parentIndex)
	Constructor. More...
void	setParentType (const std::string &type)
	Sets the type of the parent. More...
void	setParentIndex (int index)
	Sets the index of the parent. More...
void	setType (const std::string &type)
	Sets the type of the item. More...
void	setIndex (int index)
	Sets the index of the item. More...
void	invalid ()
	Invalid the key, sets the type to null string and index to 0. More...
std::string	parentType () const
	Gest the type of the parent. More...
int	parentIndex () const
	Gest the index of the parent. More...
std::string	type () const
	Gest the type. More...
int	index () const
	Gest the index. More...
bool	operator< (const DtOsgEarthPropertyItemKey &) const
	less operator override. More...
bool	operator== (const DtOsgEarthPropertyItemKey &) const
	eaqul operator override. More...

Protected Attributes
std::string	myType
int	myIndex
std::string	myParentType
int	myParentIndex

Detailed Description

DtOsgEarthPropertyItemKey Key of the osgEarth property item, represented by the type and index.

Type is the config string used in the earth file, like "image" for ImageLayerOptions. Index is the index of the same type child under the parent. For example, "composite" image layer driver may contains multipe image layers, the index is the sequence as they appear in the earth file.

Constructor & Destructor Documentation

makVrv::DtOsgEarthPropertyItemKey::DtOsgEarthPropertyItemKey

(

)

The default constructor. The key will be invalid.

makVrv::DtOsgEarthPropertyItemKey::DtOsgEarthPropertyItemKey	(	const char *	type,
		const char *	ParentType
	)

Constructor.

Parameters

type	The config string used in th earth fie.
ParentType	The type of the parent item. The index will be set to 0 for the item and its parent.

makVrv::DtOsgEarthPropertyItemKey::DtOsgEarthPropertyItemKey	(	const char *	type,
		int	index,
		const char *	parentType,
		int	parentIndex
	)

Constructor.

Parameters

type	The config string used in th earth fie.
index	The index of the same type child under its parent.
parentType	The type of the parent item.
parentIndex	The index of the parent.

makVrv::DtOsgEarthPropertyItemKey::DtOsgEarthPropertyItemKey	(	const std::string &	type,
		const std::string &	parentType
	)

Constructor.

Parameters

type	The config string used in th earth fie.
ParentType	The type of the parent item. The index will be set to 0 for the item and its parent.

makVrv::DtOsgEarthPropertyItemKey::DtOsgEarthPropertyItemKey	(	const std::string &	type,
		int	index
	)

Constructor.

Parameters

type	The config string used in th earth fie.
index	The index of the same type child under its parent.

makVrv::DtOsgEarthPropertyItemKey::DtOsgEarthPropertyItemKey	(	const std::string &	type,
		int	index,
		const std::string &	parentType,
		int	parentIndex
	)

Constructor.

Parameters

type	The config string used in th earth fie.
index	The index of the same type child under the parent.
parentType	The type of the parent item.
parentIndex	The index of the parent.

Member Function Documentation

void makVrv::DtOsgEarthPropertyItemKey::setParentType

(

const std::string &

type

)

Sets the type of the parent.

void makVrv::DtOsgEarthPropertyItemKey::setParentIndex

(

int

index

)

Sets the index of the parent.

Parameters

index

The index of the same type child under its parent.

void makVrv::DtOsgEarthPropertyItemKey::setType

(

const std::string &

type

)

Sets the type of the item.

Parameters

type	The config string used in th earth fie.

void makVrv::DtOsgEarthPropertyItemKey::setIndex

(

int

index

)

Sets the index of the item.

Parameters

index

The index of the same type child under the parent.

void makVrv::DtOsgEarthPropertyItemKey::invalid

(

)

Invalid the key, sets the type to null string and index to 0.

std::string makVrv::DtOsgEarthPropertyItemKey::parentType

(

)

const

Gest the type of the parent.

int makVrv::DtOsgEarthPropertyItemKey::parentIndex

(

)

const

Gest the index of the parent.

std::string makVrv::DtOsgEarthPropertyItemKey::type

(

)

const

Gest the type.

Returns

type The config string used in th earth fie.

int makVrv::DtOsgEarthPropertyItemKey::index

(

)

const

Gest the index.

Returns

index The index of the same type child under its parent.

bool makVrv::DtOsgEarthPropertyItemKey::operator<

(

const DtOsgEarthPropertyItemKey &

)

const

less operator override.

bool makVrv::DtOsgEarthPropertyItemKey::operator==

(

const DtOsgEarthPropertyItemKey &

)

const

eaqul operator override.

Member Data Documentation

std::string makVrv::DtOsgEarthPropertyItemKey::myType

protected

int makVrv::DtOsgEarthPropertyItemKey::myIndex

protected

std::string makVrv::DtOsgEarthPropertyItemKey::myParentType

protected

int makVrv::DtOsgEarthPropertyItemKey::myParentIndex

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrvOsgEarth/DtOsgEarthPropertyItemKey.h