DtAvailableNavigationPreferencesAdmin Class Reference

Admin content which contains the list of navigation preferences names that a particular entity has available. These are the preferences that the entity can assume. This is the response to the DtRequestAvailableNavigationPreferencesAdmin message. Also contains the current preference of the entity, if it has one.

Inheritance diagram for DtAvailableNavigationPreferencesAdmin:

Public Member Functions
	DtAvailableNavigationPreferencesAdmin ()
	DtAvailableNavigationPreferencesAdmin (const DtAvailableNavigationPreferencesAdmin &orig)
const DtAvailableNavigationPreferencesAdmin &	operator= (const DtAvailableNavigationPreferencesAdmin &orig)
virtual	~DtAvailableNavigationPreferencesAdmin ()
virtual bool	init ()
virtual const DtAdminContentMessageType &	type () const
virtual void	addPreference (const DtString &preferenceName)
virtual void	clearPreferencesList ()
virtual DtAdminContent *	clone () const
virtual DtString	stringRep () const
virtual int	netRepSize () const
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
virtual bool	setToNet ()
virtual const std::list < DtString > &	preferencesList () const
virtual std::list< DtString > &	preferencesList ()
virtual DtString	currentPreference () const
virtual void	setCurrentPreference (const DtString &preferenceName)
Public Member Functions inherited from DtAdminContent
virtual	~DtAdminContent ()
virtual char *	netRep ()

Static Public Member Functions
static DtAdminContent *	create ()
Static Public Member Functions inherited from DtAdminContent
static void	addAdminContentCreatorFcn (const DtAdminContentMessageType &contentName, DtAdminContentCreatorFcn fcn)
static void	setFactory (DtAdminContentFactory *factory)
static DtAdminContentFactory *	factory ()
static bool	isTypeRegistered (const DtAdminContentMessageType &type)

Protected Attributes
std::list< DtString >	myPreferenceList
DtString	myCurrentPreference
Protected Attributes inherited from DtAdminContent
char *	myNetRep

Additional Inherited Members
Protected Member Functions inherited from DtAdminContent
	DtAdminContent ()
	DtAdminContent (const DtAdminContent &orig)
const DtAdminContent &	operator= (const DtAdminContent &orig)
virtual char *	createNetworkBuffer ()
Static Protected Attributes inherited from DtAdminContent
static DtAdminContentFactory *	myFactory

Constructor & Destructor Documentation

DtAvailableNavigationPreferencesAdmin::DtAvailableNavigationPreferencesAdmin

(

)

default constructor

DtAvailableNavigationPreferencesAdmin::DtAvailableNavigationPreferencesAdmin

(

const DtAvailableNavigationPreferencesAdmin &

orig

)

copy constructor

virtual DtAvailableNavigationPreferencesAdmin::~DtAvailableNavigationPreferencesAdmin ( )

virtual

destructor

Member Function Documentation

const DtAvailableNavigationPreferencesAdmin& DtAvailableNavigationPreferencesAdmin::operator=

(

const DtAvailableNavigationPreferencesAdmin &

orig

)

assignment operator; same as copy costructor.

static DtAdminContent* DtAvailableNavigationPreferencesAdmin::create ( )

static

Creator function. Returns new instance of this class.

virtual bool DtAvailableNavigationPreferencesAdmin::init ( )

virtual

Call after construction.

Reimplemented from DtAdminContent.

virtual const DtAdminContentMessageType& DtAvailableNavigationPreferencesAdmin::type ( ) const

virtual

Returns

Implements DtAdminContent.

virtual const std::list<DtString>& DtAvailableNavigationPreferencesAdmin::preferencesList ( ) const

virtual

Direct access to the list of preferences names.

virtual std::list<DtString>& DtAvailableNavigationPreferencesAdmin::preferencesList ( )

virtual

Direct access to the list of preferences names.

virtual void DtAvailableNavigationPreferencesAdmin::addPreference ( const DtString &  preferenceName )

virtual

Add an additional preference name to the end of the current formation list.

virtual void DtAvailableNavigationPreferencesAdmin::clearPreferencesList ( )

virtual

Clear the current preference list.

virtual DtString DtAvailableNavigationPreferencesAdmin::currentPreference ( ) const

virtual

The current formation of the entity, if it has one.

virtual void DtAvailableNavigationPreferencesAdmin::setCurrentPreference ( const DtString &  preferenceName )

virtual

The current formation of the entity, if it has one.

virtual DtAdminContent* DtAvailableNavigationPreferencesAdmin::clone ( ) const

virtual

Make a copy of this content. Returns a pointer to a newly created copy of this class.

Implements DtAdminContent.

virtual DtString DtAvailableNavigationPreferencesAdmin::stringRep ( ) const

virtual

Get a readable string representation of this content.

Implements DtAdminContent.

virtual int DtAvailableNavigationPreferencesAdmin::netRepSize ( ) const

virtual

Returns

Size of the serialized representation of this admin content.

Reimplemented from DtAdminContent.

virtual bool DtAvailableNavigationPreferencesAdmin::setFromNet ( const char *  contentBuffer, unsigned  contentSize  )

virtual

Decodes content from buffer.

Reimplemented from DtAdminContent.

virtual bool DtAvailableNavigationPreferencesAdmin::setToNet ( )

virtual

Encodes content into buffer.

Reimplemented from DtAdminContent.

Member Data Documentation

std::list<DtString> DtAvailableNavigationPreferencesAdmin::myPreferenceList

protected

The list of available preference names.

DtString DtAvailableNavigationPreferencesAdmin::myCurrentPreference

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrftasks/availableNavigationPreferencesAdmin.h