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

An instance of an attribute group (and corresponding attribute values) More...

Public Member Functions

 DtSdcAttributeValue ()
 Default Constructor.
 ~DtSdcAttributeValue ()
 Destructor (non-virtual - this is a non-virtual class)
DtSdcAttributeValueoperator= (const DtSdcAttributeValue &rhs)
 Assignment Operator.
 DtSdcAttributeValue (const DtSdcAttributeValue &orig)
 Copy Constructor.
DtAttributeValueUpdateattributeValueUpdate ()
 gets the record used to represent this attribute value on the network
const DtAttributeValueUpdateattributeValueUpdate () const
const DtString & textValue () const
void setTextValue (const DtString &textValue)
double xValue () const
void setXValue (double x)
double yValue () const
void setYValue (double y)
bool dirty () const
void setDirty (bool dirty)

Protected Attributes

DtString myTextValue
double myXValue
double myYValue
bool myDirty
DtAttributeValueUpdate myAttributeValueUpdate

Detailed Description

An instance of an attribute group (and corresponding attribute values)

The DtSdcAttributeValue class is a container for holding the different types of attribute values that attributes can assume. It also has a DtAttributeUpdatePdu, which is used by the DtStealthRemoteDrawer class to update the attribute value represented by an instance of this class.

Constructor & Destructor Documentation

DtSdcAttributeValue::DtSdcAttributeValue ( )

Default Constructor.

DtSdcAttributeValue::~DtSdcAttributeValue ( )

Destructor (non-virtual - this is a non-virtual class)

DtSdcAttributeValue::DtSdcAttributeValue ( const DtSdcAttributeValue orig)

Copy Constructor.

Member Function Documentation

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

Assignment Operator.

References myAttributeValueUpdate, myDirty, myTextValue, myXValue, and myYValue.

const DtString & DtSdcAttributeValue::textValue ( ) const

gets/sets a text attribute value (used for BMP attributes)

References myTextValue.

Referenced by DtSdcAttributeGroupObject::bmpAttributeValue(), and setTextValue().

void DtSdcAttributeValue::setTextValue ( const DtString &  textValue)

gets/sets a text attribute value (used for BMP attributes)

References myAttributeValueUpdate, myTextValue, DtAttributeValueUpdate::setBitmapFilename(), and textValue().

Referenced by DtSdcAttributeGroupObject::setBmpAttributeValue().

double DtSdcAttributeValue::xValue ( ) const

gets/sets a numeric (x) attribute value (used for numeric, value bar, and graph attributes

References myXValue.

Referenced by DtSdcAttributeGroupObject::graphAttributeValueX(), DtSdcAttributeGroupObject::numericAttributeValue(), and DtSdcAttributeGroupObject::valueBarAttributeValue().

void DtSdcAttributeValue::setXValue ( double  x)
double DtSdcAttributeValue::yValue ( ) const

gets/sets a numeric (y) attribute value (used for graph attributes)

References myYValue.

Referenced by DtSdcAttributeGroupObject::graphAttributeValueY().

void DtSdcAttributeValue::setYValue ( double  y)

gets/sets a numeric (x) attribute value (used for numeric, value bar, and graph attributes

References myAttributeValueUpdate, myYValue, and DtAttributeValueUpdate::setYValue().

Referenced by DtSdcAttributeGroupObject::setGraphAttributeValueY().

bool DtSdcAttributeValue::dirty ( ) const

gets/sets a 'dirty' flag which indicates if the value has changed since the last time the group was updated to the network (used by DtStealthRemoteDrawer)

References myDirty.

Referenced by setDirty().

void DtSdcAttributeValue::setDirty ( bool  dirty)
DtAttributeValueUpdate & DtSdcAttributeValue::attributeValueUpdate ( )

gets the record used to represent this attribute value on the network

References myAttributeValueUpdate.

Referenced by DtSdcAttributeGroupObject::createAttributes().

const DtAttributeValueUpdate & DtSdcAttributeValue::attributeValueUpdate ( ) const

Member Data Documentation

DtString DtSdcAttributeValue::myTextValue
protected

Referenced by operator=(), setTextValue(), and textValue().

double DtSdcAttributeValue::myXValue
protected

Referenced by operator=(), setXValue(), and xValue().

double DtSdcAttributeValue::myYValue
protected

Referenced by operator=(), setYValue(), and yValue().

bool DtSdcAttributeValue::myDirty
protected

Referenced by dirty(), operator=(), and setDirty().

DtAttributeValueUpdate DtSdcAttributeValue::myAttributeValueUpdate
protected

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


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