VR-Forces Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Types | Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes
DtIffModeSettingsList Class Reference
Inheritance diagram for DtIffModeSettingsList:
Inheritance graph
[legend]

Public Types

typedef std::map< int,
DtIffModeSetting * > 
ModeSettings
 
- 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 Member Functions

 DtIffModeSettingsList (const DtString &name, DtReaderWriterRegistry *parentRegistry=nullptr)
 
 DtIffModeSettingsList (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=nullptr)
 
 DtIffModeSettingsList (const DtIffModeSettingsList &orig, DtReaderWriterRegistry *parentRegistry=nullptr)
 
DtIffModeSettingsListoperator= (const DtIffModeSettingsList &orig)
 
virtual ~DtIffModeSettingsList () override
 
bool operator== (const DtIffModeSettingsList &) const
 
bool operator!= (const DtIffModeSettingsList &rhs) const
 
virtual bool modeIsOn (int) const
 
virtual bool anyModeIsOn () const
 
virtual bool hasModeSetting (int i) const
 
virtual DtIffModeSettingmodeSetting (int)
 
virtual const DtIffModeSettingmodeSetting (int) const
 
const ModeSettingsmodeSettings () const
 
ModeSettingsmodeSettings ()
 
virtual std::vector< DtModeType > enabledModes () const
 
virtual DtString stringRep () const
 
virtual int netRepSize () const
 
virtual charsetToNet (char *netRep) const
 
virtual const charsetFromNet (const char *netRep)
 
virtual DtListItem * add (DtReaderWriter *) override
 
virtual void removeAndDeleteAll () override
 
- Public Member Functions inherited from DtRwList
 DtRwList ()
 
 DtRwList (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtRwList (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 
virtual ~DtRwList () override
 
const DtRwListoperator= (const DtRwList &orig)
 
virtual DtListItem * addWithAlternateName (DtReaderWriter *data, const DtString &name)
 
virtual DtListItem * addToStart (DtReaderWriter *data)
 
virtual DtListItem * addToEnd (DtReaderWriter *data)
 
virtual void * remove (DtReaderWriter *data, DtListItem *item)
 
virtual DtlObjPtr getLocalData (DtlObjPtr args)
 
virtual void getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference()) override
 
virtual void getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList()) override
 
virtual DtListItem * addBefore (DtReaderWriter *data, DtReaderWriter *before)
 
virtual DtListItem * addAfter (DtReaderWriter *data, DtReaderWriter *after)
 
virtual void removeAll ()
 
virtual void reset () override
 
virtual const charreaderWriterType () const override
 
bool operator== (const DtRwList &rhs) const
 
bool operator!= (const DtRwList &rhs) const
 
virtual void populateList (boost::function< void(DtReaderWriter *)> addFunction, DtEnvironmentSP env, DtEnvValueSP node, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &bindings)
 
virtual void populateListByType (boost::function< void(DtReaderWriter *)> addFunction, DtEnvironmentSP env, DtEnvValueSP node, const DtString &bindingType, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &bindings)
 
 DtRwList (const DtString &name, const DtRwList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtRwList (const DtSymbolString &name, const DtRwList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
virtual DtListItem * addBefore (DtReaderWriter *data, const DtString &before)
 
virtual DtListItem * addBefore (DtReaderWriter *data, const DtSymbolString &before)
 
virtual DtListItem * addAfter (DtReaderWriter *data, const DtString &after)
 
virtual DtListItem * addAfter (DtReaderWriter *data, const DtSymbolString &after)
 
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
 
virtual const charxmlType () const override
 
virtual std::set< DtStringsupportedXmlTypes () 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 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 int alignment () const
 
virtual bool variableIsBound () const
 
virtual void unbindVariable ()
 
virtual void setName (const DtString &)
 
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 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 DtReaderWriterdefaultRWValue () const
 
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 putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
 
virtual void unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
 
virtual void getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
 

Public Attributes

boost::signals2::signal< void(const
DtIffModeSetting *)> 
signal_settingChanged
 

Protected Member Functions

virtual void slot_settingChanged (const DtIffModeSetting *)
 
virtual void copyList (const DtIffModeSettingsList &)
 
virtual DtlObjPtr getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) override
 
virtual void postGetSelf () override
 
- Protected Member Functions inherited from DtRwList
virtual DtListItem * addBefore (DtReaderWriter *data, DtListItem *before)
 
virtual DtListItem * addAfter (DtReaderWriter *data, DtListItem *after)
 
- Protected Member Functions inherited from DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 

Protected Attributes

ModeSettings myModeSettings
 
- 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

- Static Public Member Functions inherited from DtRwList
static const chartheXmlType ()
 
- 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)
 
- 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
 

Member Typedef Documentation

Returns a map based on what is in the list.

Constructor & Destructor Documentation

DtIffModeSettingsList::DtIffModeSettingsList ( const DtString name,
DtReaderWriterRegistry parentRegistry = nullptr 
)
DtIffModeSettingsList::DtIffModeSettingsList ( const DtSymbolString name,
DtReaderWriterRegistry parentRegistry = nullptr 
)
DtIffModeSettingsList::DtIffModeSettingsList ( const DtIffModeSettingsList orig,
DtReaderWriterRegistry parentRegistry = nullptr 
)
virtual DtIffModeSettingsList::~DtIffModeSettingsList ( )
overridevirtual

Member Function Documentation

DtIffModeSettingsList& DtIffModeSettingsList::operator= ( const DtIffModeSettingsList orig)

assignment operator

bool DtIffModeSettingsList::operator== ( const DtIffModeSettingsList ) const
bool DtIffModeSettingsList::operator!= ( const DtIffModeSettingsList rhs) const
inline
virtual bool DtIffModeSettingsList::modeIsOn ( int  ) const
virtual

Returns true if this mode is currently present and on.

virtual bool DtIffModeSettingsList::anyModeIsOn ( ) const
virtual

Returns true if any mode that can be on is.

virtual bool DtIffModeSettingsList::hasModeSetting ( int  i) const
virtual
virtual DtIffModeSetting* DtIffModeSettingsList::modeSetting ( int  )
virtual
virtual const DtIffModeSetting* DtIffModeSettingsList::modeSetting ( int  ) const
virtual
const ModeSettings& DtIffModeSettingsList::modeSettings ( ) const
inline
ModeSettings& DtIffModeSettingsList::modeSettings ( )
inline
virtual std::vector<DtModeType> DtIffModeSettingsList::enabledModes ( ) const
virtual
virtual DtString DtIffModeSettingsList::stringRep ( ) const
virtual
virtual int DtIffModeSettingsList::netRepSize ( ) const
virtual
virtual char* DtIffModeSettingsList::setToNet ( char netRep) const
virtual
virtual const char* DtIffModeSettingsList::setFromNet ( const char netRep)
virtual
virtual DtListItem* DtIffModeSettingsList::add ( DtReaderWriter data)
overridevirtual

Add element to the end of the list. Returns the DtListItem envelope object that contains your new element.

Reimplemented from DtRwList.

virtual void DtIffModeSettingsList::removeAndDeleteAll ( )
overridevirtual

Removes and deletes all items in the list.

Reimplemented from DtRwList.

virtual void DtIffModeSettingsList::slot_settingChanged ( const DtIffModeSetting )
protectedvirtual
virtual void DtIffModeSettingsList::copyList ( const DtIffModeSettingsList )
protectedvirtual
virtual DtlObjPtr DtIffModeSettingsList::getData ( DtlObjPtr  args,
const DtReaderWriter::SearchPaths searchPaths,
const DtVariableBindingsList variableBindings 
)
overrideprotectedvirtual

This method must be overridden by a subclass. Within this method, new instances of the DtReaderWriter subclass that is being handled by this list must be created, and then retrieved from the mtl stream, using the getSelf member of that item.

Here is some sample code that could be used to implement a override of this class: (This is used in the DtRwIntegerList::getData() method)
DtlObjPtr nameObj = DtcCar(args);
DtRwInt* value = new DtRwInt(nameObj->pname());
value->getSelf(args, searchPaths, variableBindings);
this->add(value);
return DtcCdr(DtcCdr(args));

Implements DtRwList.

virtual void DtIffModeSettingsList::postGetSelf ( )
overrideprotectedvirtual

Called after either version of getSelf (mtl or environment). Default is no-op.

Reimplemented from DtReaderWriter.

Member Data Documentation

boost::signals2::signal<void (const DtIffModeSetting*)> DtIffModeSettingsList::signal_settingChanged

Signal sent when something about the setting changes that it wants to notify about.

ModeSettings DtIffModeSettingsList::myModeSettings
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)