Admin content which contains the list of art parts, their parameters, and limits for a particular entity. This is the response to the DtRequestArtPartsAdmin message.

Inheritance diagram for DtArtPartsAdmin:

[legend]

Classes
struct	CurrentMinAndMax

Public Types
typedef std::map< int, CurrentMinAndMax >	ParamInfo

typedef std::map< int, ParamInfo >	PartParamInfo

Public Member Functions
	DtArtPartsAdmin ()

	DtArtPartsAdmin (const DtArtPartsAdmin &orig)

const DtArtPartsAdmin &	operator= (const DtArtPartsAdmin &orig)

virtual	~DtArtPartsAdmin ()

virtual bool	init ()

virtual const DtAdminContentMessageType &	type () const

virtual void	addArtPart (int partType)

virtual void	setArtPartParam (int partType, int paramType, double current, double min, double max)

virtual void	clearArtParts ()

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 PartParamInfo &	artParts () const

virtual PartParamInfo &	artParts ()


virtual const ParamInfo &	artPartParams (int partType) const

virtual ParamInfo &	artPartParams (int partType)

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
PartParamInfo	myArtPartParams

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

Member Typedef Documentation

typedef std::map<int, CurrentMinAndMax> DtArtPartsAdmin::ParamInfo

typedef std::map<int, ParamInfo> DtArtPartsAdmin::PartParamInfo

Constructor & Destructor Documentation

DtArtPartsAdmin::DtArtPartsAdmin ( )

default constructor

DtArtPartsAdmin::DtArtPartsAdmin ( const DtArtPartsAdmin & orig )

copy constructor

virtual DtArtPartsAdmin::~DtArtPartsAdmin ( )

virtual

destructor

Member Function Documentation

const DtArtPartsAdmin& DtArtPartsAdmin::operator= ( const DtArtPartsAdmin & orig )

assignment operator; same as copy costructor.

static DtAdminContent* DtArtPartsAdmin::create ( )

static

Creator function. Returns new instance of this class.

virtual bool DtArtPartsAdmin::init ( )

virtual

Call after construction.

Reimplemented from DtAdminContent.

virtual const DtAdminContentMessageType& DtArtPartsAdmin::type ( ) const

virtual

Returns

Implements DtAdminContent.

virtual const PartParamInfo& DtArtPartsAdmin::artParts ( ) const

virtual

Direct access to the list of articulated parts and parameters.

virtual PartParamInfo& DtArtPartsAdmin::artParts ( )

virtual

Direct access to the list of articulated parts and parameters.

virtual void DtArtPartsAdmin::addArtPart ( int partType )

virtual

Add an additional articulated part to the end of the list.

virtual const ParamInfo& DtArtPartsAdmin::artPartParams ( int partType ) const

virtual

Direct access to the list of parameters for an articulated part.

virtual ParamInfo& DtArtPartsAdmin::artPartParams ( int partType )

virtual

Direct access to the list of parameters for an articulated part.

virtual void DtArtPartsAdmin::setArtPartParam	(	int	partType,
		int	paramType,
		double	current,
		double	min,
		double	max
	)

virtual

Sets or adds an articulated parameter value.

virtual void DtArtPartsAdmin::clearArtParts ( )

virtual

Clear the current art part list.

virtual DtAdminContent* DtArtPartsAdmin::clone ( ) const

virtual

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

Implements DtAdminContent.

virtual DtString DtArtPartsAdmin::stringRep ( ) const

virtual

Get a readable string representation of this content.

Implements DtAdminContent.

virtual int DtArtPartsAdmin::netRepSize ( ) const

virtual

Returns: Size of the serialized representation of this admin content.

Reimplemented from DtAdminContent.

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

virtual

Decodes content from buffer.

Reimplemented from DtAdminContent.

virtual bool DtArtPartsAdmin::setToNet ( )

virtual

Encodes content into buffer.

Reimplemented from DtAdminContent.

Member Data Documentation

PartParamInfo DtArtPartsAdmin::myArtPartParams

protected

The list of available parts and their parameters.

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrftasks/artPartsAdmin.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation