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
DtSystemUniqueNameParameterData Class Reference

System parameter data that specifies an articulated part type as a variable type.

Inheritance diagram for DtSystemUniqueNameParameterData:
Inheritance graph
[legend]

Public Member Functions

 DtSystemUniqueNameParameterData (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
 
 DtSystemUniqueNameParameterData (const DtString &name, const DtSystemUniqueNameParameterData &orig, DtReaderWriterRegistry *parentRegistry=0)
 
DtSystemUniqueNameParameterDataoperator= (const DtSystemUniqueNameParameterData &orig)
 
virtual ~DtSystemUniqueNameParameterData () override
 
virtual DtSystemParameterDataclone () const override
 
virtual DtString parameterType () const override
 
virtual DtString category () const
 
virtual void setCategory (const DtString &cat)
 
- Public Member Functions inherited from DtSystemStringParameterData
 DtSystemStringParameterData (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
 
 DtSystemStringParameterData (const DtString &name, const DtSystemStringParameterData &orig, DtReaderWriterRegistry *parentRegistry=0)
 
DtSystemStringParameterDataoperator= (const DtSystemStringParameterData &orig)
 
virtual ~DtSystemStringParameterData () override
 
virtual bool operator== (const DtSystemParameterData &rhs) const override
 
virtual void assignDefaultValueToReaderWriter (DtReaderWriter *rwToChange) const override
 
virtual DtString defaultValue () const
 
virtual const DtReaderWriterdefaultRWValue () const override
 
virtual void setDefaultValue (const DtString &value)
 
- Public Member Functions inherited from DtSystemParameterData
 DtSystemParameterData (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtSystemParameterData (const DtString &name, const DtSystemParameterData &orig, DtReaderWriterRegistry *parentRegistry=0)
 
DtSystemParameterDataoperator= (const DtSystemParameterData &orig)
 
virtual ~DtSystemParameterData () override
 
virtual DtString parameterName () const
 
virtual void setParameterName (const DtString &name)
 
virtual DtString variableType () const
 
virtual void setVariableType (const DtString &type)
 
virtual DtString displayLabel () const
 
virtual void setDisplayLabel (const DtString &label)
 
virtual DtString displayUnits () const
 
virtual void setDisplayUnits (const DtString &units)
 
virtual DtString sourceUnits () const
 
virtual void setSourceUnits (const DtString &units)
 
virtual void setRollUpRule (const DtString &)
 
virtual DtString rollUpRule () const
 
virtual void setListItems (const DtString &)
 
virtual const DtStringlistItems () const
 
virtual void getListItems (std::vector< DtString > &keys, std::vector< DtString > &values) const
 
virtual void setListDisplay (int)
 
virtual int listDisplay () const
 
virtual void setAllowEdit (const bool)
 
virtual bool allowEdit () const
 
virtual void setDisplayValue (const bool)
 
virtual bool displayValue () const
 
- 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 DtReaderWriteroperator= (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 getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 
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 aliasContaineraliases () const
 
virtual void setReadonly (bool flag)
 
bool isReadonly () const
 
virtual void reset ()
 
virtual int alignment () const
 
virtual bool variableIsBound () const
 
virtual void unbindVariable ()
 
virtual void setName (const DtString &)
 
virtual const charreaderWriterType () const
 
virtual const charxmlType () const
 
virtual DtString prettyPrint () const
 
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 void bindLocalVariables (const DtVariableBindingsList &variableBindings)
 
virtual void recordUpdateTime () const
 
virtual bool changedSinceLastChecked ()
 
virtual bool peekChangedSinceLastChecked () const
 
virtual void putData (std::string &fp, int indentLevel=0)
 
virtual DtlObjPtr getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
 
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 DtReaderWriterdefaultRWValue ()
 
virtual void setDefaultRWValue (DtReaderWriter *)
 
virtual bool checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 
const DtReaderWriterRegistryregistry () const
 
DtReaderWriterRegistryregistry ()
 
virtual DtPropertyInterfaceproperty ()
 
virtual const DtPropertyInterfaceproperty () const
 
virtual DtString toXml () const
 
virtual DtRwVariableBindingsgenerateVariableBindings () 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 putData (DtEnvironmentSP, DtEnvValueSP value) 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 getData (const DtEnvironmentSP, const DtEnvValueSP, 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)
 

Static Public Member Functions

static DtSystemParameterDatacreate (const DtString &rwName)
 
- Static Public Member Functions inherited from DtSystemStringParameterData
static DtSystemParameterDatacreate (const DtString &rwName)
 
- Static Public Member Functions inherited from DtSystemParameterData
static DtSystemParameterDatacreateSystemParameterData (const DtString &type)
 
static
DtSystemParameterDataFactory
factory ()
 
- 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 chartheXmlType ()
 
static const DtFilename & appPath ()
 
static void setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
 
static void createReaderWriterFactory ()
 
static void cleanupFactory ()
 
static DtReaderWriterFactoryfactory ()
 
static void setOutputStream (DtOutputStream *stream)
 
static DtOutputStream & outputStream ()
 
static DtReaderWritercreateFromXmlFile (const DtFilename &, bool createAsProperty=false)
 
static DtReaderWritercreateFromXml (const DtString &, bool createAsProperty=false)
 
static DtReaderWritercreateFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
 
static DtString getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
 

Protected Attributes

DtRwString myCategory
 
- Protected Attributes inherited from DtSystemStringParameterData
DtRwString myDefaultValue
 
- Protected Attributes inherited from DtSystemParameterData
DtRwString myParameterName
 
DtRwString myVariableType
 
DtRwString myDisplayLabel
 
DtRwString myDisplayUnits
 
DtRwString mySourceUnits
 
DtRwString myListItems
 
DtRwInt myListDisplay
 
DtRwBoolean myAllowEdit
 
DtRwBoolean myDisplayValue
 
DtRwString myRollUpRule
 
- Protected Attributes inherited from DtReaderWriter
const DtSymbolString myName
 
DtReaderWriterRegistry myRegistry
 
DtReaderWriterRegistrymyParentRegistry
 
bool myValueSpecified
 
bool myReadOnlyFlag
 
bool myIsVariableReference
 
DtSymbolString myVariableName
 
bool myVariableIsBound
 
DtReaderWritermyDefaultValue
 
aliasContainer myAliases
 
bool myInvalid
 
bool myChangedFlag
 

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 )()
 
- Protected Member Functions inherited from DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 
- Static Protected Attributes inherited from DtSystemParameterData
static std::unique_ptr
< DtSystemParameterDataFactory
theFactory
 
- Static Protected Attributes inherited from DtReaderWriter
static DtString theUnspecifiedValue
 
static DtGetSelfCallbackInfo thePostGetSelfCallback
 
static DtPutSelfCallbackInfo thePrePutSelfCallback
 
static const DtVariableBindingsList theEmptyVariableBindingsList
 
static bool theCreatorFcnSet
 
static DtReaderWriterFactorytheFactory
 
static
DtReaderWriterFactoryCreatorFcn 
theFactoryCreatorFcn
 
static bool thePutIndent
 
static DtOutputStream * theOutputStream
 

Constructor & Destructor Documentation

DtSystemUniqueNameParameterData::DtSystemUniqueNameParameterData ( const DtString name,
DtReaderWriterRegistry parentRegistry = 0 
)
DtSystemUniqueNameParameterData::DtSystemUniqueNameParameterData ( const DtString name,
const DtSystemUniqueNameParameterData orig,
DtReaderWriterRegistry parentRegistry = 0 
)
virtual DtSystemUniqueNameParameterData::~DtSystemUniqueNameParameterData ( )
overridevirtual

Member Function Documentation

DtSystemUniqueNameParameterData& DtSystemUniqueNameParameterData::operator= ( const DtSystemUniqueNameParameterData orig)
virtual DtSystemParameterData* DtSystemUniqueNameParameterData::clone ( ) const
overridevirtual

Reimplemented from DtSystemStringParameterData.

virtual DtString DtSystemUniqueNameParameterData::parameterType ( ) const
overridevirtual
Returns
The type string for this parameter. Comes from systemParameterDataTypes.h.

Reimplemented from DtSystemStringParameterData.

virtual DtString DtSystemUniqueNameParameterData::category ( ) const
virtual
virtual void DtSystemUniqueNameParameterData::setCategory ( const DtString cat)
virtual
static DtSystemParameterData* DtSystemUniqueNameParameterData::create ( const DtString rwName)
static

Member Data Documentation

DtRwString DtSystemUniqueNameParameterData::myCategory
protected

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)