VR-Forces Development_Version 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
vrvControlToolkit::DtBarAttributeTemplateObject Class Reference

A Value Bar Attribute Template. More...

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

Public Member Functions

 DtBarAttributeTemplateObject (const DtGlobalObjectDesignator &templateId, const DtString &name, double minRange, double maxRange)
 Construct the Value Bar Attribute Group Template.
virtual ~DtBarAttributeTemplateObject ()
 DtBarAttributeTemplateObject (const DtBarAttributeTemplateObject &orig)
 Copy constructor.
DtBarAttributeTemplateObjectoperator= (const DtBarAttributeTemplateObject &rhs)
 Assignment operator.
virtual double minRange () const
 minRange accessor
virtual double maxRange () const
 maxRange accessor
- Public Member Functions inherited from vrvControlToolkit::DtAttributeTemplateObject
 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

double myMinRange
double myMaxRange
- Protected Attributes inherited from vrvControlToolkit::DtAttributeTemplateObject
DtGlobalObjectDesignator myTemplateId
DtString myName
DtVdcAttributeType myAttributeType
DtAttributeTemplateStateRecord myAttributeTemplateRecord

Private Member Functions

 DtBarAttributeTemplateObject ()
 Default constructor.

Additional Inherited Members

- Public Types inherited from vrvControlToolkit::DtAttributeTemplateObject
enum  DtVdcAttributeType {
  DtVdcAttributeTypeNoValue = 0, DtVdcAttributeTypeValueNumeric = 1, DtVdcAttributeTypeValueBar = 2, DtVdcAttributeTypeValueGraph = 3,
  DtVdcAttributeTypeBitmap = 4
}

Detailed Description

A Value Bar Attribute Template.

DtBarAttributeTemplateObject represents a template that defines an attribute type in an Attribute Group that displays a horizontal value bar; a range (min and max) is specified, and then the bar is drawn showing what portion of the range is covered by the attribute value set.

Constructor & Destructor Documentation

vrvControlToolkit::DtBarAttributeTemplateObject::DtBarAttributeTemplateObject ( const DtGlobalObjectDesignator &  templateId,
const DtString name,
double  minRange,
double  maxRange 
)

Construct the Value Bar Attribute Group Template.

Parameters
idPassed to DtSdcAtteibuteTemplate3Object base (see)
templateIdPassed to DtSdcAtteibuteTemplate3Object base (see)
name
minRangeThe minimum value for the range of values represented
maxRangeThe maximum value for the range of values represented
virtual vrvControlToolkit::DtBarAttributeTemplateObject::~DtBarAttributeTemplateObject ( )
virtual
vrvControlToolkit::DtBarAttributeTemplateObject::DtBarAttributeTemplateObject ( const DtBarAttributeTemplateObject orig)

Copy constructor.

vrvControlToolkit::DtBarAttributeTemplateObject::DtBarAttributeTemplateObject ( )
private

Default constructor.

Private and not implemented - you must supply all parameters to create a value bar attribute template

Member Function Documentation

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

Assignment operator.

virtual double vrvControlToolkit::DtBarAttributeTemplateObject::minRange ( ) const
virtual

minRange accessor

Get the minimum value for the range represented

Returns
double, minimum range
virtual double vrvControlToolkit::DtBarAttributeTemplateObject::maxRange ( ) const
virtual

maxRange accessor

Get the maximum value for the range represented

Returns
double, maximum range

Member Data Documentation

double vrvControlToolkit::DtBarAttributeTemplateObject::myMinRange
protected
double vrvControlToolkit::DtBarAttributeTemplateObject::myMaxRange
protected

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

Document ID: Generated on Tue Mar 8 22:13:38 EST 2016 from SVN revision 162938
Copyright © 2005-2015 VT MÄK. All Rights Reserved (www.mak.com)