VR-Vantage API Documentation
List of all members | Public Types | Public Member Functions | Protected Attributes | Private Member Functions
DtSdcAttributeTemplateObject Class Reference

An Attribute Template. More...

Inheritance diagram for DtSdcAttributeTemplateObject:
Inheritance graph
[legend]

Public Types

enum  DtSdcAttributeType {
  DtSdcAttributeTypeNoValue = 0, DtSdcAttributeValueNumeric = 1, DtSdcAttributeTypeValueBar = 2, DtSdcAttributeTypeValueGraph = 3,
  DtSdcAttributeTypeBitmap = 4
}

Public Member Functions

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

Protected Attributes

DtGlobalObjectDesignator myTemplateId
DtString myName
DtSdcAttributeType myAttributeType
DtAttributeTemplateStateRecord myAttributeTemplateRecord

Private Member Functions

 DtSdcAttributeTemplateObject ()
 Default constructor.

Detailed Description

An Attribute Template.

DtSdcAttributeTemplateObject 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:
DtSdcAttributeTypeNoValue 
DtSdcAttributeValueNumeric 
DtSdcAttributeTypeValueBar 
DtSdcAttributeTypeValueGraph 
DtSdcAttributeTypeBitmap 

Constructor & Destructor Documentation

DtSdcAttributeTemplateObject::DtSdcAttributeTemplateObject ( const DtGlobalObjectDesignator &  templateId,
const DtString &  name,
DtSdcAttributeType  attributeType 
)

Construct the Attribute Template.

Parameters
idPassed to DtSdcObject 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 DtSdcAttributeType this template represents

References Dt3DAttributeSubcategoryBarGraph, Dt3DAttributeSubcategoryBitmap, Dt3DAttributeSubcategoryOther, Dt3DAttributeSubcategorySingleValue, Dt3DAttributeSubcategoryXYPlot, DtSdcAttributeTypeBitmap, DtSdcAttributeTypeNoValue, DtSdcAttributeTypeValueBar, DtSdcAttributeTypeValueGraph, DtSdcAttributeValueNumeric, myAttributeTemplateRecord, myAttributeType, myName, myTemplateId, DtAttributeTemplateStateRecord::setAttributeType(), DtAttributeTemplateStateRecord::setName(), and DtAttributeTemplateStateRecord::setParentId().

DtSdcAttributeTemplateObject::~DtSdcAttributeTemplateObject ( )
virtual
DtSdcAttributeTemplateObject::DtSdcAttributeTemplateObject ( const DtSdcAttributeTemplateObject orig)

Copy constructor.

DtSdcAttributeTemplateObject::DtSdcAttributeTemplateObject ( )
private

Default constructor.

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

Member Function Documentation

DtSdcAttributeTemplateObject & DtSdcAttributeTemplateObject::operator= ( const DtSdcAttributeTemplateObject rhs)

Assignment operator.

References myAttributeTemplateRecord, myAttributeType, myName, and myTemplateId.

const DtString & DtSdcAttributeTemplateObject::name ( ) const
virtual

name accessor

Get the attribute group template's name

Returns
DtString name

References myName.

Referenced by DtSdcAttributeGroupObject::createAttributes().

const DtGlobalObjectDesignator & DtSdcAttributeTemplateObject::templateId ( ) const
virtual

name accessor

Get the attribute group template's name

Returns
DtString name

References myTemplateId.

DtSdcAttributeTemplateObject::DtSdcAttributeType DtSdcAttributeTemplateObject::attributeType ( ) const
virtual

attribute type accessor

Get the attribute template's type

Returns
DtString name

References myAttributeType.

Referenced by DtSdcAttributeGroupObject::createAttributes().

const DtAttributeTemplateStateRecord & DtSdcAttributeTemplateObject::attributeTemplateRecord ( ) const
virtual

Member Data Documentation

DtGlobalObjectDesignator DtSdcAttributeTemplateObject::myTemplateId
protected
DtString DtSdcAttributeTemplateObject::myName
protected
DtSdcAttributeType DtSdcAttributeTemplateObject::myAttributeType
protected
DtAttributeTemplateStateRecord DtSdcAttributeTemplateObject::myAttributeTemplateRecord
protected

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


Copyright © 2005-2013 VT MÄK Inc. All Rights Reserved (www.mak.com)