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 | Static Public Member Functions | Protected Attributes | Private Member Functions
DtRwPropertiesRangeItem Class Reference

A range item is a special property that will be put onto the network as range ring item using the name as the name of the reader/writer item, range.

Inheritance diagram for DtRwPropertiesRangeItem:
Inheritance graph
[legend]

Public Member Functions

 DtRwPropertiesRangeItem (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
 
 DtRwPropertiesRangeItem (const DtString &name, const DtRwPropertiesRangeItem &orig, DtReaderWriterRegistry *parentRegistry=0)
 
DtRwPropertiesRangeItem & operator= (const DtRwPropertiesRangeItem &orig)
 
virtual ~DtRwPropertiesRangeItem () override
 
virtual const char * readerWriterType () const override
 
virtual const char * propertyType () const override
 
virtual const char * xmlType () const override
 
virtual void bindLocalVariables (const DtVariableBindingsList &variableBindings) override
 
virtual void setRange (double)
 
virtual double range () const
 
- Public Member Functions inherited from DtRwPropertyReal
 DtRwPropertyReal (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
 
 DtRwPropertyReal (const DtString &name, DtReal value, DtReaderWriterRegistry *parentRegistry=0)
 
 DtRwPropertyReal (const DtString &name, const DtRwPropertyReal &orig, DtReaderWriterRegistry *parentRegistry=0)
 
 DtRwPropertyReal (const DtRwPropertyReal &orig, DtReaderWriterRegistry *parentRegistry=0)
 
DtRwPropertyReal & operator= (const DtRwPropertyReal &orig)
 
virtual ~DtRwPropertyReal () override
 
virtual bool isSimilarProperty (const DtPropertyInterface *rhs, bool strict) const override
 
- Public Member Functions inherited from DtRwPropertyWithThreshold< DtRwReal >
 DtRwPropertyWithThreshold (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
 
 DtRwPropertyWithThreshold (const DtString &name, const DtRwPropertyWithThreshold &orig, DtReaderWriterRegistry *parentRegistry=0)
 
DtRwPropertyWithThreshold & operator= (const DtRwPropertyWithThreshold &orig)
 
virtual ~DtRwPropertyWithThreshold () override
 
virtual char * encode (char *) const override
 
virtual bool isUpdateNeeded (DtTime t) const override
 
virtual void setThresholdAlgorithm (DtThresholdAlgorithm alg)
 
virtual DtThresholdAlgorithm thresholdAlgorithm () const
 
virtual void setDefaultThresholdAlgorithm (DtThresholdAlgorithm alg)
 
virtual void setThreshold (double value)
 
virtual double threshold () const
 
virtual void setMaxUpdateInterval (DtTime interval)
 
virtual DtTime maxUpdateInterval () const
 
virtual void setMaxUnchangedUpdateInterval (DtTime interval)
 
virtual DtTime maxUnchangedUpdateInterval () const
 
virtual void processPublicationArg (DtlObjPtr arg) override
 
virtual void copyPublishingSettings (const DtPropertyInterface &prop) override
 
virtual double percentChanged () const
 
virtual double amountChanged () const
 
virtual bool merge (const DtPropertyInterface &target, DtPropertyInterface::MergeFlags, const DtMergePath &path=DtMergePath(), const std::set< DtString > &ignore=std::set< DtString >()) override
 
virtual void writePublishInformation (std::string &fp, int indentLevel) override
 
- Public Member Functions inherited from DtRwProperty< DtRwReal >
 DtRwProperty (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
 
 DtRwProperty (const DtString &name, const DtRwProperty &orig, DtReaderWriterRegistry *parentRegistry=0)
 
DtRwProperty & operator= (const DtRwProperty &orig)
 
virtual ~DtRwProperty () override
 
virtual void copy (const DtPropertyInterface &rhs) override
 
virtual DtString stringRep (const DtString &root="") const override
 
virtual DtSymbolString propertyName () const override
 
virtual void setPropertyName (const DtString &propertyName) override
 
virtual void getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=DtReaderWriter::SearchPaths(), const DtVariableBindingsList &variableBindings=DtReaderWriter::nullVariableReference())
 
virtual DtlObjPtr getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) override
 
virtual void recordUpdateTime () const
 
virtual bool hasReceivedUpdateSince (DtTime t) const override
 
virtual DtTime updateClockTime () const override
 
virtual void reset () override
 
virtual void setKeepPublishingSettings (bool keep) override
 
virtual bool keepPublishingSettings () const override
 
virtual const char * decode (const char *) override
 
virtual void getSize (int &size) const override
 
virtual int hlaAlignment () const override
 
virtual DtReaderWriter * readerWriter () override
 
virtual const DtReaderWriter * readerWriter () const override
 
virtual DtPropertyInterface * property ()
 
virtual const DtPropertyInterface * property () const
 
virtual bool isPublished () const override
 
virtual void setIsPublished (bool isPub) override
 
virtual unsigned disRecordType () const override
 
virtual void setDisRecordType (unsigned recType) override
 
virtual bool isDebugEnabled () const override
 
virtual void setDebugEnabled (bool en) override
 
- Public Member Functions inherited from DtRwReal
 DtRwReal ()
 
 DtRwReal (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtRwReal (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtRwReal (const DtString &name, DtReal value, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtRwReal (const DtSymbolString &name, DtReal value, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtRwReal (const DtRwReal &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
DtRwReal & operator= (const DtRwReal &orig)
 
virtual ~DtRwReal () override
 
virtual operator const DtReal () const
 
DtReal operator= (const DtReal orig)
 
virtual DtReal operator- () const
 
virtual DtReal operator* (const DtReal rhs) const
 
virtual DtReal operator/ (const DtReal rhs) const
 
virtual DtReal operator+ (const DtReal rhs) const
 
virtual DtReal operator- (const DtReal rhs) const
 
virtual bool operator< (const DtReal rhs) const
 
virtual bool operator> (const DtReal rhs) const
 
virtual bool operator<= (const DtReal rhs) const
 
virtual bool operator>= (const DtReal rhs) const
 
virtual bool operator== (const DtReal rhs) const
 
virtual bool operator!= (const DtReal rhs) const
 
virtual DtReal operator*= (const DtReal rhs)
 
virtual DtReal operator/= (const DtReal rhs)
 
virtual DtReal operator+= (const DtReal rhs)
 
virtual DtReal operator-= (const DtReal rhs)
 
virtual DtReal value () const
 
virtual void setValue (DtReal value)
 
virtual void putData (std::string &fp, int indentLevel=0) override
 
virtual DtString prettyPrint () const override
 
virtual int alignment () const override
 
virtual void putData (DtEnvironmentSP, DtEnvValueSP parent) const override
 
virtual void getData (const DtEnvironmentSP, const DtEnvValueSP value, const DtReaderWriter::SearchPaths &searchPaths=DtReaderWriter::SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList()) override
 
- Public Member Functions inherited from DtReaderWriter
 DtReaderWriter ()
 
 DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 
 DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 
 DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
 
const DtReaderWriter & operator= (const DtReaderWriter &orig)
 
bool operator== (const DtReaderWriter &) const
 
bool operator!= (const DtReaderWriter &rhs) const
 
virtual ~DtReaderWriter ()
 
virtual void putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
 
virtual void postPutSelf ()
 
virtual void prePutSelf ()
 
virtual void postGetSelf ()
 
virtual void preGetSelf ()
 
virtual void writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
 
virtual DtSymbolString name () const
 
virtual void addAlias (const DtSymbolString &alias)
 
virtual void addAlias (const DtString &alias)
 
virtual bool hasAlias (const DtSymbolString &alias)
 
virtual const aliasContainer & aliases () const
 
virtual void setReadonly (bool flag)
 
bool isReadonly () const
 
virtual bool variableIsBound () const
 
virtual void unbindVariable ()
 
virtual void setName (const DtString &)
 
std::string debugText () const
 
virtual void bindVariables (DtVariableBindingsList variableBindings)
 
virtual std::list
< DtVariableNameType > 		unboundVariables () const
 
bool invalid () const
 
virtual bool hasChild (const DtReaderWriter *p) const
 
virtual bool hasVariableReference () const
 
virtual bool changedSinceLastChecked ()
 
virtual bool peekChangedSinceLastChecked () const
 
virtual void setValueSpecified (bool specified, bool recurse=false)
 
virtual bool valueSpecified () const
 
virtual bool isVariableReference () const
 
virtual void setIsVariableReference (bool value)
 
virtual void clearAllVariableReferenceFlags ()
 
virtual DtSymbolString variableName () const
 
virtual void setVariableName (const DtSymbolString variableName)
 
virtual const DtReaderWriter * defaultRWValue () const
 
virtual DtReaderWriter * defaultRWValue ()
 
virtual void setDefaultRWValue (DtReaderWriter *)
 
virtual bool checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 
const DtReaderWriterRegistry & registry () const
 
DtReaderWriterRegistry & registry ()
 
virtual DtString toXml () const
 
virtual DtRwVariableBindings * generateVariableBindings () const
 
virtual bool toXml (const DtFilename &) const
 
virtual bool fromXml (const DtString &)
 
virtual bool fromXmlFile (const DtFilename &)
 
virtual void putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
 
virtual void putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
 
virtual void getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
 
virtual void unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
 
virtual void getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
 
- Public Member Functions inherited from DtPropertyInterface
virtual ~DtPropertyInterface ()
 
virtual bool isPublishedArg (DtlObjPtr arg, unsigned &disVarRecType)
 
virtual void processPublicationArgs (DtlObjPtr arg)
 
template<typename ValueType >
boost::optional< ValueType > propertyValue () const
 
template<typename ValueType >
bool setPropertyValue (ValueType val)
 
virtual const DtPropertyInterface * findPropertyInterface (const DtString &propertyName) const
 
virtual DtPropertyInterface * findPropertyInterface (const DtString &propertyName)
 
template<typename SpecificPropType >
const SpecificPropType * findProperty (const DtString &propertyName) const
 
template<typename SpecificPropType >
SpecificPropType * findProperty (const DtString &propertyName)
 
template<typename ValueType >
boost::optional< ValueType > findPropertyValue (const DtString &propertyName) const
 
template<typename ValueType >
bool findAndSetPropertyValue (const DtString &propertyName, ValueType val)
 
virtual bool addProperty (DtPropertyInterface *property)
 
template<typename SpecificPropType >
SpecificPropType * addNewProperty (const DtString &propertyName)
 
virtual bool removeProperty (const DtString &propertyName)
 
virtual bool removeProperty (const DtPropertyInterface *property)
 
int getSize () const
 

Static Public Member Functions

static const char * theXmlType ()
 
- Static Public Member Functions inherited from DtRwPropertyWithThreshold< DtRwReal >
static void setDefaultThreshold (double value)
 
static void setDefaultMaxUpdateInterval (DtTime interval)
 
static void setDefaultMaxUnchangedUpdateInterval (DtTime interval)
 
- Static Public Member Functions inherited from DtRwReal
static double getDouble (DtEnvironmentSP env, DtString attributeName, DtEnvValueSP root)
 
static const char * theXmlType ()
 
- Static Public Member Functions inherited from DtReaderWriter
static void putIndent (std::string &fp, int indentLevel)
 
static const
DtVariableBindingsList & 		nullVariableReference ()
 
static void setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
 
static void setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
 
static void setPutIndent (bool)
 
static bool putIndent ()
 
static const char * theXmlType ()
 
static const DtFilename & appPath ()
 
static void setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
 
static void createReaderWriterFactory ()
 
static void cleanupFactory ()
 
static DtReaderWriterFactory * factory ()
 
static void setOutputStream (DtOutputStream *stream)
 
static DtOutputStream & outputStream ()
 
static DtReaderWriter * createFromXmlFile (const DtFilename &, bool createAsProperty=false)
 
static DtReaderWriter * createFromXml (const DtString &, bool createAsProperty=false)
 
static DtReaderWriter * createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
 
static DtString getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
 

Protected Attributes

bool myBindingLocalVars
 
- Protected Attributes inherited from DtRwPropertyWithThreshold< DtRwReal >
DtRwReal myLastEncodedValue
 
DtTime myLastEncodeTime
 
DtThresholdAlgorithm myThresholdAlgorithm
 
double myThreshold
 
DtTime myMaxUpdateInterval
 
DtTime myMaxUnchangedUpdateInterval
 
- Protected Attributes inherited from DtRwProperty< DtRwReal >
DtClock myClock
 
DtTime myUpdateTime
 
unsigned myDisRecordType
 
bool myIsPublished
 
bool myKeepPublishingSettingsOnCopy
 
bool myDebugEnabled
 
- Protected Attributes inherited from DtRwReal
DtReal myValue
 
- Protected Attributes inherited from DtReaderWriter
const DtSymbolString myName
 
DtReaderWriterRegistry myRegistry
 
DtReaderWriterRegistry * myParentRegistry
 
bool myValueSpecified
 
bool myReadOnlyFlag
 
bool myIsVariableReference
 
DtSymbolString myVariableName
 
bool myVariableIsBound
 
DtReaderWriter * myDefaultValue
 
aliasContainer myAliases
 
bool myInvalid
 
bool myChangedFlag
 

Private Member Functions

 DtRwPropertiesRangeItem ()
 

Additional Inherited Members

- Public Types inherited from DtReaderWriter
typedef std::vector
< DtSymbolString > 		aliasContainer
 
typedef std::vector
< DtSymbolString >::iterator 		aliasIter
 
typedef std::vector
< DtSymbolString >
::const_iterator 		aliasConstIter
 
typedef std::vector< DtFilename > SearchPaths
 
typedef std::pair
< DtSymbolString, DtString > 		DtVariableNameType
 
typedef DtReaderWriterFactory *(* DtReaderWriterFactoryCreatorFcn )()
 
- Public Types inherited from DtPropertyInterface
enum  MergeFlags {
  Replace = 0x00000001, MinimalSimilarityCheck = 0x00000002, RollUp = 0x00000004, AddMissing = 0x00000008,
  KeepPublishedSettings = 0x00000010
}
 
- Protected Member Functions inherited from DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 
- Static Protected Attributes inherited from DtRwPropertyWithThreshold< DtRwReal >
static DtThresholdAlgorithm myDefaultThresholdAlgorithm
 
static double myDefaultThreshold
 
static DtTime myDefaultMaxUpdateInterval
 
static DtTime myDefaultMaxUnchangedUpdateInterval
 
- Static Protected Attributes inherited from DtReaderWriter
static DtString theUnspecifiedValue
 
static DtGetSelfCallbackInfo thePostGetSelfCallback
 
static DtPutSelfCallbackInfo thePrePutSelfCallback
 
static const DtVariableBindingsList theEmptyVariableBindingsList
 
static bool theCreatorFcnSet
 
static DtReaderWriterFactory * theFactory
 
static
DtReaderWriterFactoryCreatorFcn 		theFactoryCreatorFcn
 
static bool thePutIndent
 
static DtOutputStream * theOutputStream
 

Constructor & Destructor Documentation

DtRwPropertiesRangeItem::DtRwPropertiesRangeItem ( )
private

Not implemented.

DtRwPropertiesRangeItem::DtRwPropertiesRangeItem ( const DtString &  name,
DtReaderWriterRegistry *  parentRegistry = 0 
)
DtRwPropertiesRangeItem::DtRwPropertiesRangeItem ( const DtString &  name,
const DtRwPropertiesRangeItem &  orig,
DtReaderWriterRegistry *  parentRegistry = 0 
)
virtual DtRwPropertiesRangeItem::~DtRwPropertiesRangeItem ( )
overridevirtual

Member Function Documentation

DtRwPropertiesRangeItem& DtRwPropertiesRangeItem::operator= ( const DtRwPropertiesRangeItem &  orig)
virtual const char* DtRwPropertiesRangeItem::readerWriterType ( ) const
overridevirtual

Used to supply a string type that this reader writer type is. This can be used in place of dynamic-casting. Also used by the opd editor to determine which type of control to create.

Reimplemented from DtRwReal.

virtual const char* DtRwPropertiesRangeItem::propertyType ( ) const
overridevirtual

Typically returns reader/writer type.

Reimplemented from DtRwProperty< DtRwReal >.

static const char* DtRwPropertiesRangeItem::theXmlType ( )
static

The type that is used when archiving to an XML stream.

virtual const char* DtRwPropertiesRangeItem::xmlType ( ) const
inlineoverridevirtual

Routines to archive/dearchive from an XML Environment.

Reimplemented from DtRwReal.

References DtRwReal::theXmlType().

virtual void DtRwPropertiesRangeItem::bindLocalVariables ( const DtVariableBindingsList &  variableBindings)
overridevirtual

Checks to see if this RW object is a variable reference that can be bound using the provided bindings. If so, it binds it. Overridden to work with variables of type real, not just range items.

Reimplemented from DtReaderWriter.

virtual void DtRwPropertiesRangeItem::setRange ( double  )
virtual
virtual double DtRwPropertiesRangeItem::range ( ) const
virtual

Member Data Documentation

bool DtRwPropertiesRangeItem::myBindingLocalVars
protected

Set to true while binding local variables. During this period, DtRwPropertiesRangeItem should act like a DtRwPropertyReal.

The documentation for this class was generated from the following file:
Document ID: Generated on Thu Oct 23 22:29:17 EDT 2025 from SVN revision 280951
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)