DtNavSectorName Class Reference

Aids in creating and parsing nav sector names. More...

Public Member Functions
const DtString &	fullName () const
	un-sectorized areas More...
const DtString &	baseName () const
	The base sector name (everything except for the random ID). More...
const DtString &	profile () const
	The name of the profile for this sector. More...
void	setProfile (const DtString &prof)
	Resets the profile name. More...
int	x () const
	The sector x coordinate. More...
int	y () const
	The sector y coordinate. More...
void	setCoordinates (int x, int y)
	Resets the sector coordinates. More...
DtNavSectorDataType	navDataType () const
	The sector nav data type. More...
void	setNavDataType (DtNavSectorDataType dataType)
	Resets the nav data type. More...
const DtString &	randomId () const
	The sector's random ID string. More...
void	setRandomId (const DtString &rId)
	Resets the random ID string. More...
	DtNavSectorName (const DtNavSectorName &other)
	Constructors. More...
	DtNavSectorName (const DtString &fullName)
	DtNavSectorName (const DtString &profile, int x, int y, DtNavSectorDataType navDataType, const DtString &randomId)
	DtNavSectorName (const DtString &profile, DtNavSectorDataType navDataType, const DtString &randomId)
virtual bool	operator< (const DtNavSectorName &rhs) const
	Comparison operators. More...
virtual bool	operator> (const DtNavSectorName &rhs) const
virtual bool	operator<= (const DtNavSectorName &rhs) const
virtual bool	operator>= (const DtNavSectorName &rhs) const
virtual bool	operator== (const DtNavSectorName &rhs) const
virtual bool	operator!= (const DtNavSectorName &rhs) const

Static Public Member Functions
static DtString	generateRandomId (unsigned length=4)
	Can be used to generate a new random ID. More...
static DtString	navDataTypeToString (DtNavSectorDataType &dt)
	Convert between nav data type enum and string. More...
static DtNavSectorDataType	navDataTypeFromString (const DtString &dtStr)

Protected Member Functions
void	assembleFullName () const
	Assembled the full name from the constituent parts. More...
void	parseFullName () const
	Parses the full name into the constituent parts. More...

Protected Attributes
DtString	myFullName
	All members are mutable because it is expected that a DtNavSectorName is created with the full name or in pieces, and that the pieces or full name are then parsed or assembled as they are needed. More...
DtString	myBaseName
DtString	myProfile
int	myX
int	myY
DtNavSectorDataType	myNavDataType
DtString	myRandomId

Detailed Description

Aids in creating and parsing nav sector names.

Constructor & Destructor Documentation

DtNavSectorName::DtNavSectorName

(

const DtNavSectorName &

other

)

Constructors.

DtNavSectorName::DtNavSectorName

(

const DtString &

fullName

)

DtNavSectorName::DtNavSectorName	(	const DtString &	profile,
		int	x,
		int	y,
		DtNavSectorDataType	navDataType,
		const DtString &	randomId
	)

DtNavSectorName::DtNavSectorName	(	const DtString &	profile,
		DtNavSectorDataType	navDataType,
		const DtString &	randomId
	)

Member Function Documentation

const DtString& DtNavSectorName::fullName

(

)

const

un-sectorized areas

The full sector name.

const DtString& DtNavSectorName::baseName

(

)

const

The base sector name (everything except for the random ID).

const DtString& DtNavSectorName::profile

(

)

const

The name of the profile for this sector.

void DtNavSectorName::setProfile

(

const DtString &

prof

)

Resets the profile name.

int DtNavSectorName::x

(

)

const

The sector x coordinate.

int DtNavSectorName::y

(

)

const

The sector y coordinate.

void DtNavSectorName::setCoordinates	(	int	x,
		int	y
	)

Resets the sector coordinates.

DtNavSectorDataType DtNavSectorName::navDataType

(

)

const

The sector nav data type.

void DtNavSectorName::setNavDataType

(

DtNavSectorDataType

dataType

)

Resets the nav data type.

const DtString& DtNavSectorName::randomId

(

)

const

The sector's random ID string.

void DtNavSectorName::setRandomId

(

const DtString &

rId

)

Resets the random ID string.

static DtString DtNavSectorName::generateRandomId ( unsigned  length = 4 )

static

Can be used to generate a new random ID.

virtual bool DtNavSectorName::operator< ( const DtNavSectorName &  rhs ) const

virtual

Comparison operators.

virtual bool DtNavSectorName::operator> ( const DtNavSectorName &  rhs ) const

virtual

virtual bool DtNavSectorName::operator<= ( const DtNavSectorName &  rhs ) const

virtual

virtual bool DtNavSectorName::operator>= ( const DtNavSectorName &  rhs ) const

virtual

virtual bool DtNavSectorName::operator== ( const DtNavSectorName &  rhs ) const

virtual

virtual bool DtNavSectorName::operator!= ( const DtNavSectorName &  rhs ) const

virtual

static DtString DtNavSectorName::navDataTypeToString ( DtNavSectorDataType &  dt )

static

Convert between nav data type enum and string.

static DtNavSectorDataType DtNavSectorName::navDataTypeFromString ( const DtString &  dtStr )

static

void DtNavSectorName::assembleFullName ( ) const

protected

Assembled the full name from the constituent parts.

void DtNavSectorName::parseFullName ( ) const

protected

Parses the full name into the constituent parts.

Member Data Documentation

DtString DtNavSectorName::myFullName

mutableprotected

All members are mutable because it is expected that a DtNavSectorName is created with the full name or in pieces, and that the pieces or full name are then parsed or assembled as they are needed.

DtString DtNavSectorName::myBaseName

mutableprotected

DtString DtNavSectorName::myProfile

mutableprotected

int DtNavSectorName::myX

mutableprotected

int DtNavSectorName::myY

mutableprotected

DtNavSectorDataType DtNavSectorName::myNavDataType

mutableprotected

DtString DtNavSectorName::myRandomId

mutableprotected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-10-branch/include/vrfNavigation/navSectorName.h