VR-Forces Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties 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.

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.

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

Public Member Functions

 DtBarAttributeTemplateObject (const DtGlobalObjectDesignator &templateId, const DtString &name, double minRange, double maxRange)
 
virtual ~DtBarAttributeTemplateObject ()
 
 DtBarAttributeTemplateObject (const DtBarAttributeTemplateObject &orig)
 
DtBarAttributeTemplateObjectoperator= (const DtBarAttributeTemplateObject &rhs)
 
virtual double minRange () const
 
virtual double maxRange () const
 
- Public Member Functions inherited from vrvControlToolkit::DtAttributeTemplateObject
 DtAttributeTemplateObject (const DtGlobalObjectDesignator &templateId, const DtString &name, DtVdcAttributeType attributeType)
 
virtual ~DtAttributeTemplateObject ()
 
 DtAttributeTemplateObject (const DtAttributeTemplateObject &orig)
 
DtAttributeTemplateObjectoperator= (const DtAttributeTemplateObject &rhs)
 
virtual const DtStringname () const
 
virtual const
DtGlobalObjectDesignator
templateId () const
 
virtual DtVdcAttributeType attributeType () const
 
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 ()
 

Additional Inherited Members

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

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 Wed Mar 27 22:49:11 EDT 2024 from SVN revision 264633
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)