vrvControlToolkit::DtAttributeGroupTemplateObject Class Reference

An Attribute Group Template. More...

Inheritance diagram for vrvControlToolkit::DtAttributeGroupTemplateObject:

List of all members.

Public Member Functions
	DtAttributeGroupTemplateObject (DtExerciseConn *exConn, unsigned id, const DtString &name)
	Construct the Attribute Group Template.
virtual	~DtAttributeGroupTemplateObject ()
virtual const DtString &	name () const
	name accessor
virtual DtAttributeTemplateObject *	createAttributeTemplate (const DtString &name, DtAttributeTemplateObject::DtVdcAttributeType attType)
	Create an Attribute Template.
virtual DtAttributeTemplateObject *	createAttributeTemplate (const DtString &name, double minRange, double maxRange)
	Create a Bar Value Attribute Template.
virtual DtVdcAttributeTemplateList &	attributeTemplates ()
	Attribute template list accessor.
virtual DtAttributeTemplateObject *	attributeTemplate (const DtString &name)
	Attribute Template Accessor.
virtual void	update ()
	update the internal pdu
Protected Attributes
DtString	myName
DtVdcAttributeTemplateMap	myAttributeTemplateMap
DtVdcAttributeTemplateList	myAttributeTemplateList
Private Member Functions
	DtAttributeGroupTemplateObject ()
	Default constructor.
	DtAttributeGroupTemplateObject (const DtAttributeGroupTemplateObject &orig)
	Copy constructor.
DtAttributeGroupTemplateObject &	operator= (const DtAttributeGroupTemplateObject &rhs)
	Assignment operator.

---

Detailed Description

An Attribute Group Template.

DtAttributeGroupTemplateObject represents a template that defines a type of Attribute Group: Specifically the name that will be used for all attribute groups based on the template and the list of associated attribute templates that make up a group instance.

---

Constructor & Destructor Documentation

vrvControlToolkit::DtAttributeGroupTemplateObject::DtAttributeGroupTemplateObject	(	DtExerciseConn *	exConn,
		unsigned	id,
		const DtString &	name
	)

Construct the Attribute Group Template.

Parameters:

id	Passed to DtDrawControlObject base (see)
name	The name of the attribute group template (this is displayed at the top of each attribute group instance)

virtual vrvControlToolkit::DtAttributeGroupTemplateObject::~DtAttributeGroupTemplateObject

(

)

[virtual]

vrvControlToolkit::DtAttributeGroupTemplateObject::DtAttributeGroupTemplateObject

(

)

[private]

Default constructor.

Private and not implemented - you must supply id and name parameters to construct the attribute group template

vrvControlToolkit::DtAttributeGroupTemplateObject::DtAttributeGroupTemplateObject

(

const DtAttributeGroupTemplateObject &

orig

)

[private]

Copy constructor.

Private and not implemented - not copyable.

---

Member Function Documentation

DtAttributeGroupTemplateObject& vrvControlToolkit::DtAttributeGroupTemplateObject::operator=

(

const DtAttributeGroupTemplateObject &

rhs

)

[private]

Assignment operator.

Private and not implemented - not copyable.

virtual const DtString& vrvControlToolkit::DtAttributeGroupTemplateObject::name

(

)

const [virtual]

name accessor

Get the attribute group template's name

Returns:

DtString name

virtual DtAttributeTemplateObject* vrvControlToolkit::DtAttributeGroupTemplateObject::createAttributeTemplate	(	const DtString &	name,
		DtAttributeTemplateObject::DtVdcAttributeType	attType
	)		[virtual]

Create an Attribute Template.

Parameters:

id	Passed to DtDrawControlObject base (see)
name	The name of the attribute template (this is displayed on the left-hand side of the attribute when displaying the attribute group instance)
type	The type of attribute this template represents. This method should NOT be used to create ValueBar attribute templates; use the alternate method that takes min and max range values instead.

virtual DtAttributeTemplateObject* vrvControlToolkit::DtAttributeGroupTemplateObject::createAttributeTemplate	(	const DtString &	name,
		double	minRange,
		double	maxRange
	)		[virtual]

Create a Bar Value Attribute Template.

Parameters:

id	Passed to DtDrawControlObject base (see)
name	The name of the attribute template (this is displayed on the left-hand side of the attribute when displaying the attribute group instance)
minRange	The minimum value for the range this attribute represents
maxRange	The maximum value for the range this attribute represents

virtual DtVdcAttributeTemplateList& vrvControlToolkit::DtAttributeGroupTemplateObject::attributeTemplates

(

)

[virtual]

Attribute template list accessor.

Get the list of attribute templates created for this template

Returns:

List of attribute templates

virtual DtAttributeTemplateObject* vrvControlToolkit::DtAttributeGroupTemplateObject::attributeTemplate

(

const DtString &

name

)

[virtual]

Attribute Template Accessor.

Find the attribute template with the specified it

Parameters:

attribute

template id

Returns:

pointer to attribute template

virtual void vrvControlToolkit::DtAttributeGroupTemplateObject::update

(

)

[virtual]

update the internal pdu

This function is a no-op for the attribute group template, as all fields of the pdu are set at construction time and can't be changed.

Implements vrvControlToolkit::DtDrawControlObject.

---

Member Data Documentation

DtString vrvControlToolkit::DtAttributeGroupTemplateObject::myName [protected]

DtVdcAttributeTemplateMap vrvControlToolkit::DtAttributeGroupTemplateObject::myAttributeTemplateMap [protected]

DtVdcAttributeTemplateList vrvControlToolkit::DtAttributeGroupTemplateObject::myAttributeTemplateList [protected]

---

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

• include/vrvDrawControl/DtAttributeGroupTemplateObject.h