RVC::DESCRIPTOR Class Reference

DESCRIPTOR class for specifying name, description, and source for an object. More...

#include <rvc/descriptor.h>

List of all members.

Public Member Functions
	DESCRIPTOR (const DESCRIPTOR &rhs)
DEPRECATED	DESCRIPTOR (const RVC::OBJECTNAME &name)
	DESCRIPTOR (const MISTRING &name, const MISTRING &description)
	DESCRIPTOR (TEXTID TextID)
	DESCRIPTOR (const MISTRING &name)
	DESCRIPTOR ()
	~DESCRIPTOR ()
void	Clear ()
const MISTRING &	GetDescription () const
const MISTRING &	GetFullName () const
const OBJECTNAME &	GetShortName () const
const OBJECTNAME &	GetSource () const
bool	IsEmpty () const
bool	IsEqual (const DESCRIPTOR &rhs) const
bool	IsLessThan (const DESCRIPTOR &rhs) const
DESCRIPTOR &	operator= (TEXTID textid)
DESCRIPTOR &	operator= (const MISTRING &name)
DESCRIPTOR &	operator= (const DESCRIPTOR &rhs)
void	SetDescription (const MISTRING &Description)
void	SetName (const MISTRING &Name, FastDelegate< int(const RVC::OBJECTNAME &)> DelegateTestUniqueShortName)
void	SetName (const MISTRING &Name)
void	SetShortName (const OBJECTNAME &name)
void	SetSource (const char *Source)
void	SetSource (const OBJECTNAME &Source)

---

Detailed Description

DESCRIPTOR class for specifying name, description, and source for an object.

---

Constructor & Destructor Documentation

RVC::DESCRIPTOR::DESCRIPTOR

(

)

Default constructor Presets the 'source' field from MsysGetAppName().

RVC::DESCRIPTOR::DESCRIPTOR

(

const MISTRING &

name

)

Constructor taking a name as a MISTRING.

Will fill in the name field and short name fi with validating the name (does not guarentee uniqueness). Will set the description field if the resulting short name is different than 'name' Presets the 'source' field from MsysGetAppName().

RVC::DESCRIPTOR::DESCRIPTOR

(

TEXTID

TextID

)

Constructor taking a name as a TEXTID.

Will fill in the name field and short name field with validating the name (does not guarentee uniqueness). Will set the description field if the resulting short name is different than 'name' Presets the 'source' field from MsysGetAppName().

RVC::DESCRIPTOR::DESCRIPTOR	(	const MISTRING &	name,
		const MISTRING &	description
	)

Construct with both name and description.

DEPRECATED RVC::DESCRIPTOR::DESCRIPTOR

(

const RVC::OBJECTNAME &

name

)

Constructor taking a name as a RVC::OBJECTNAME.

RVC::DESCRIPTOR::DESCRIPTOR

(

const DESCRIPTOR &

rhs

)

[inline]

Copy constructor.

RVC::DESCRIPTOR::~DESCRIPTOR

(

)

Destructor.

---

Member Function Documentation

void RVC::DESCRIPTOR::Clear

(

)

[inline]

Clear the instance of all strings.

const MISTRING& RVC::DESCRIPTOR::GetDescription

(

)

const [inline]

Get the description of the object.

Returns:

Constant reference to the description

const MISTRING& RVC::DESCRIPTOR::GetFullName

(

)

const [inline]

Get the name of the object.

Returns:

Constant reference to the name

const OBJECTNAME& RVC::DESCRIPTOR::GetShortName

(

)

const [inline]

Get the short name of the object.

Returns:

Constant reference to the short name

const OBJECTNAME& RVC::DESCRIPTOR::GetSource

(

)

const

Get the source of the object.

Returns:

Constant reference to the source

bool RVC::DESCRIPTOR::IsEmpty

(

)

const [inline]

Is the descriptor empty?

bool RVC::DESCRIPTOR::IsEqual

(

const DESCRIPTOR &

rhs

)

const

Are the descriptor's equal?

bool RVC::DESCRIPTOR::IsLessThan

(

const DESCRIPTOR &

rhs

)

const [inline]

Are the descriptor's equal?

DESCRIPTOR& RVC::DESCRIPTOR::operator=

(

TEXTID

textid

)

Assignment from TEXTID, will clear out previous settings.

Will fill in the name field and short name field with validating the name (does not guarentee uniqueness). Will set the description field if the resulting short name is different than 'name' Presets the 'source' field from MsysGetAppName().

DESCRIPTOR& RVC::DESCRIPTOR::operator=

(

const MISTRING &

name

)

Assignment from MISTRING, will clear out previous settings.

Will fill in the name field and short name field with validating the name (does not guarentee uniqueness). Will set the description field if the resulting short name is different than 'name' Presets the 'source' field from MsysGetAppName().

DESCRIPTOR& RVC::DESCRIPTOR::operator=

(

const DESCRIPTOR &

rhs

)

[inline]

Assignment operator.

void RVC::DESCRIPTOR::SetDescription

(

const MISTRING &

Description

)

[inline]

Set the object description.

Parameters:

Description

The MISTRING containing the long description

void RVC::DESCRIPTOR::SetName	(	const MISTRING &	Name,
		FastDelegate< int(const RVC::OBJECTNAME &)>	DelegateTestUniqueShortName
	)

Set the object name with check for uniquely generated short name.

This will set the short name value as well. Delegate will only be called if the generated short name has changed and is not identical to the full name.

Parameters:

Name

The MISTRING containing the long name

void RVC::DESCRIPTOR::SetName

(

const MISTRING &

Name

)

Set the object name.

This will set the short name value as well.

Parameters:

Name

The MISTRING containing the long name

void RVC::DESCRIPTOR::SetShortName

(

const OBJECTNAME &

name

)

Set the short name (object ID tag).

void RVC::DESCRIPTOR::SetSource

(

const char *

Source

)

Set the object source Pass NULL for the 'Source' parameter to set to MsysGetAppName().

Parameters:

Source

The ASCII string containing the source string

void RVC::DESCRIPTOR::SetSource

(

const OBJECTNAME &

Source

)

[inline]

Set the object source.

Parameters:

Source

The OBJECTNAME containing the source string

---

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

• rvc/descriptor.h