DtNavSectorName Class Reference

Aids in creating and parsing nav sector names.

Public Member Functions
const DtString &	fullName () const
const DtString &	baseName () const
const DtString &	profile () const
void	setProfile (const DtString &prof)
int	x () const
int	y () const
void	setCoordinates (int x, int y)
DtNavSectorDataType	navDataType () const
void	setNavDataType (DtNavSectorDataType dataType)
const DtString &	randomId () const
void	setRandomId (const DtString &rId)
	DtNavSectorName (const DtNavSectorName &other)
	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
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)
static DtString	navDataTypeToString (DtNavSectorDataType &dt)
static DtNavSectorDataType	navDataTypeFromString (const DtString &dtStr)

Protected Member Functions
void	assembleFullName () const
void	parseFullName () const

Protected Attributes
DtString	myFullName
DtString	myBaseName
DtString	myProfile
int	myX
int	myY
DtNavSectorDataType	myNavDataType
DtString	myRandomId

Constructor & Destructor Documentation

DtNavSectorName::DtNavSectorName

(

const DtNavSectorName &

other

)

Constructors.

DtNavSectorName::DtNavSectorName

(

const DtString &

fullName

)

Constructors.

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

Constructors.

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

Constructors.

Member Function Documentation

const DtString& DtNavSectorName::fullName

(

)

const

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

Comparison operators.

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

virtual

Comparison operators.

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

virtual

Comparison operators.

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

virtual

Comparison operators.

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

virtual

Comparison operators.

static DtString DtNavSectorName::navDataTypeToString ( DtNavSectorDataType &  dt )

static

Convert between nav data type enum and string.

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

static

Convert between nav data type enum and string.

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.vrf5-0-branch/include/vrfNavigation/navSectorName.h