VR-Forces 4.7 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Types | Public Member Functions | Protected Attributes | Private Member Functions
vrvControlToolkit::DtAttributeTemplateObject Class Reference

An Attribute Template. More...

Inheritance diagram for vrvControlToolkit::DtAttributeTemplateObject:
Inheritance graph
[legend]

Public Types

enum  DtVdcAttributeType {
  DtVdcAttributeTypeNoValue = 0, DtVdcAttributeTypeValueNumeric = 1, DtVdcAttributeTypeValueBar = 2, DtVdcAttributeTypeValueGraph = 3,
  DtVdcAttributeTypeBitmap = 4
}

Public Member Functions

 DtAttributeTemplateObject (const DtGlobalObjectDesignator &templateId, const DtString &name, DtVdcAttributeType attributeType)
 Construct the Attribute Template.
virtual ~DtAttributeTemplateObject ()
 DtAttributeTemplateObject (const DtAttributeTemplateObject &orig)
 Copy constructor.
DtAttributeTemplateObjectoperator= (const DtAttributeTemplateObject &rhs)
 Assignment operator.
virtual const DtStringname () const
 name accessor
virtual const
DtGlobalObjectDesignator
templateId () const
 name accessor
virtual DtVdcAttributeType attributeType () const
 attribute type accessor
virtual const
DtAttributeTemplateStateRecord
attributeTemplateRecord () const

Protected Attributes

DtGlobalObjectDesignator myTemplateId
DtString myName
DtVdcAttributeType myAttributeType
DtAttributeTemplateStateRecord myAttributeTemplateRecord

Private Member Functions

 DtAttributeTemplateObject ()
 Default constructor.

Detailed Description

An Attribute Template.

DtAttributeTemplateObject represents a template that defines one type of attribute in an Attribute Group: Specifically the attribute name and type that will appear in a group instance (attribute values are supplied by the the group instance).

Member Enumeration Documentation

Enumerator:
DtVdcAttributeTypeNoValue 
DtVdcAttributeTypeValueNumeric 
DtVdcAttributeTypeValueBar 
DtVdcAttributeTypeValueGraph 
DtVdcAttributeTypeBitmap 

Constructor & Destructor Documentation

vrvControlToolkit::DtAttributeTemplateObject::DtAttributeTemplateObject ( const DtGlobalObjectDesignator templateId,
const DtString name,
DtVdcAttributeType  attributeType 
)

Construct the Attribute Template.

Parameters
idPassed to DtDrawControlObject base (see)
templateIdId of the attribute group template that this attribute template is to be part of
nameThe name of the attribute template (this is displayed on the left-hand side of the attribute when displaying the attribute in a group instance
attributeTypeThe DtVdcAttributeType this template represents
virtual vrvControlToolkit::DtAttributeTemplateObject::~DtAttributeTemplateObject ( )
virtual
vrvControlToolkit::DtAttributeTemplateObject::DtAttributeTemplateObject ( const DtAttributeTemplateObject orig)

Copy constructor.

vrvControlToolkit::DtAttributeTemplateObject::DtAttributeTemplateObject ( )
private

Default constructor.

Private and not implemented - you must supply all parameters to create an attribute template

Member Function Documentation

DtAttributeTemplateObject& vrvControlToolkit::DtAttributeTemplateObject::operator= ( const DtAttributeTemplateObject rhs)

Assignment operator.

virtual const DtString& vrvControlToolkit::DtAttributeTemplateObject::name ( ) const
virtual

name accessor

Get the attribute group template's name

Returns
DtString name
virtual const DtGlobalObjectDesignator& vrvControlToolkit::DtAttributeTemplateObject::templateId ( ) const
virtual

name accessor

Get the attribute group template's name

Returns
DtString name
virtual DtVdcAttributeType vrvControlToolkit::DtAttributeTemplateObject::attributeType ( ) const
virtual

attribute type accessor

Get the attribute template's type

Returns
DtString name
virtual const DtAttributeTemplateStateRecord& vrvControlToolkit::DtAttributeTemplateObject::attributeTemplateRecord ( ) const
virtual

Member Data Documentation

DtGlobalObjectDesignator vrvControlToolkit::DtAttributeTemplateObject::myTemplateId
protected
DtString vrvControlToolkit::DtAttributeTemplateObject::myName
protected
DtVdcAttributeType vrvControlToolkit::DtAttributeTemplateObject::myAttributeType
protected
DtAttributeTemplateStateRecord vrvControlToolkit::DtAttributeTemplateObject::myAttributeTemplateRecord
protected

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

Document ID: Generated on Fri Apr 26 21:53:14 EDT 2019 from SVN revision 197883
Copyright © 2005-2019 VT MAK. All Rights Reserved (www.mak.com)