VR-Forces 4.5 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Attributes | Private Member Functions
DtSdcAttributeGroupTemplateObject Class Reference

An Attribute Group Template. More...

Inheritance diagram for DtSdcAttributeGroupTemplateObject:
Inheritance graph
[legend]

Public Member Functions

 DtSdcAttributeGroupTemplateObject (DtExerciseConn *exConn, unsigned id, const DtString &name)
 Construct the Attribute Group Template.
virtual ~DtSdcAttributeGroupTemplateObject ()
virtual const DtStringname () const
 name accessor
virtual
DtSdcAttributeTemplateObject
createAttributeTemplate (const DtString &name, DtSdcAttributeTemplateObject::DtSdcAttributeType attType)
 Create an Attribute Template.
virtual
DtSdcAttributeTemplateObject
createAttributeTemplate (const DtString &name, double minRange, double maxRange)
 Create a Bar Value Attribute Template.
virtual
DtSdcAttributeTemplateList
attributeTemplates ()
 Attribute template list accessor.
virtual
DtSdcAttributeTemplateObject
attributeTemplate (const DtString &name)
 Attribute Template Accessor.
virtual void update ()
 update the internal pdu
- Public Member Functions inherited from DtSdcObject
 DtSdcObject (DtExerciseConn *exConn, unsigned id, const DtString &objName)
 Parameterized constructor.
virtual ~DtSdcObject ()
 Virtual destructor.
virtual unsigned id () const
 id accessor
virtual void setId (unsigned id)
 id mutator
virtual const
DtGlobalObjectDesignator
globalId () const
virtual void setVisible (bool yesNo)
virtual bool visible () const
virtual bool flashing () const
virtual void setFlashing (bool yesNo)
virtual const DtSdcColorcolor () const
virtual void setColor (const DtSdcColor &color)
virtual void setRemoteGraphicSet (const std::string &setName)

Protected Attributes

DtString myName
DtSdcAttributeTemplateMap myAttributeTemplateMap
DtSdcAttributeTemplateList myAttributeTemplateList
- Protected Attributes inherited from DtSdcObject
unsigned myId
DtEnvironmentProcessPublisher myPublisher
bool myVisible
DtSdcColor myEmptyColor

Private Member Functions

 DtSdcAttributeGroupTemplateObject ()
 Default constructor.
 DtSdcAttributeGroupTemplateObject (const DtSdcAttributeGroupTemplateObject &orig)
 Copy constructor.
DtSdcAttributeGroupTemplateObjectoperator= (const DtSdcAttributeGroupTemplateObject &rhs)
 Assignment operator.

Detailed Description

An Attribute Group Template.

DtSdcAttributeGroupTemplateObject 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

DtSdcAttributeGroupTemplateObject::DtSdcAttributeGroupTemplateObject ( DtExerciseConn *  exConn,
unsigned  id,
const DtString name 
)

Construct the Attribute Group Template.

Parameters
idPassed to DtSdcObject base (see)
nameThe name of the attribute group template (this is displayed at the top of each attribute group instance)
virtual DtSdcAttributeGroupTemplateObject::~DtSdcAttributeGroupTemplateObject ( )
virtual
DtSdcAttributeGroupTemplateObject::DtSdcAttributeGroupTemplateObject ( )
private

Default constructor.

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

DtSdcAttributeGroupTemplateObject::DtSdcAttributeGroupTemplateObject ( const DtSdcAttributeGroupTemplateObject orig)
private

Copy constructor.

Private and not implemented - not copyable.

Member Function Documentation

DtSdcAttributeGroupTemplateObject& DtSdcAttributeGroupTemplateObject::operator= ( const DtSdcAttributeGroupTemplateObject rhs)
private

Assignment operator.

Private and not implemented - not copyable.

virtual const DtString& DtSdcAttributeGroupTemplateObject::name ( ) const
virtual

name accessor

Get the attribute group template's name

Returns
DtString name
virtual DtSdcAttributeTemplateObject* DtSdcAttributeGroupTemplateObject::createAttributeTemplate ( const DtString name,
DtSdcAttributeTemplateObject::DtSdcAttributeType  attType 
)
virtual

Create an Attribute Template.

Parameters
idPassed to DtSdcObject base (see)
nameThe name of the attribute template (this is displayed on the left-hand side of the attribute when displaying the attribute group instance)
typeThe 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 DtSdcAttributeTemplateObject* DtSdcAttributeGroupTemplateObject::createAttributeTemplate ( const DtString name,
double  minRange,
double  maxRange 
)
virtual

Create a Bar Value Attribute Template.

Parameters
idPassed to DtSdcObject base (see)
nameThe name of the attribute template (this is displayed on the left-hand side of the attribute when displaying the attribute group instance)
minRangeThe minimum value for the range this attribute represents
maxRangeThe maximum value for the range this attribute represents
virtual DtSdcAttributeTemplateList& DtSdcAttributeGroupTemplateObject::attributeTemplates ( )
virtual

Attribute template list accessor.

Get the list of attribute templates created for this template

Returns
List of attribute templates
virtual DtSdcAttributeTemplateObject* DtSdcAttributeGroupTemplateObject::attributeTemplate ( const DtString name)
virtual

Attribute Template Accessor.

Find the attribute template with the specified it

Parameters
attributetemplate id
Returns
pointer to attribute template
virtual void DtSdcAttributeGroupTemplateObject::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 DtSdcObject.

Member Data Documentation

DtString DtSdcAttributeGroupTemplateObject::myName
protected
DtSdcAttributeTemplateMap DtSdcAttributeGroupTemplateObject::myAttributeTemplateMap
protected
DtSdcAttributeTemplateList DtSdcAttributeGroupTemplateObject::myAttributeTemplateList
protected

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

Document ID: Generated on Thu Mar 23 18:54:12 EDT 2017 from SVN revision 174804
Copyright © 2005-2017 VT MÄK. All Rights Reserved (www.mak.com)