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 Member Functions | Protected Attributes
makVrf::DtVrfMenu Class Reference
Inheritance diagram for makVrf::DtVrfMenu:
Inheritance graph
[legend]

Public Member Functions

 DtVrfMenu (const DtString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
 
virtual ~DtVrfMenu ()
 
 DtVrfMenu (const DtVrfMenu &orig)
 
DtVrfMenu & operator= (const DtVrfMenu &orig)
 
virtual bool operator== (const DtVrfMenuEntry &) const
 
virtual const DtList & entries () const
 
virtual void getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) override
 
virtual DtlObjPtr getLocalData (DtlObjPtr args)
 
virtual DtlObjPtr getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
 
virtual void addObject (const DtString &item, const DtObjectType &type, int force, const DtString &at="")
 
virtual void addEntity (const DtString &item, const DtObjectType &type, int force, const DtString &at="")
 
virtual bool creationKeyFor (const DtString &name, DtEntityMapperKey &retKey) const
 
virtual bool load (const DtFilename &)
 
virtual bool save (const DtFilename &)
 
virtual void setComment (const DtString &)
 
virtual const DtString & comment () const
 
virtual DtVrfMenuEntry * findEntry (DtVrfMenuEntry *) const
 
virtual DtVrfMenuEntry * findEntry (const DtString &, bool recurse=false) const
 
virtual void merge (DtVrfMenu *)
 
virtual void add (DtVrfMenuEntry *)
 
virtual DtVrfMenuEntry * clone () const
 
const DtFilename & filename () const
 
void setFilename (const DtFilename &)
 
- Public Member Functions inherited from makVrf::DtVrfMenuEntry
 DtVrfMenuEntry (const DtString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
 
virtual ~DtVrfMenuEntry ()
 
 DtVrfMenuEntry (const DtVrfMenuEntry &orig)
 
DtVrfMenuEntry & operator= (const DtVrfMenuEntry &orig)
 
virtual DtString label () const
 
void setLabel (const DtString &)
 
virtual bool operator!= (const DtVrfMenuEntry &) 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 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 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 void reset ()
 
virtual int alignment () const
 
virtual bool variableIsBound () const
 
virtual void unbindVariable ()
 
virtual void setName (const DtString &)
 
virtual const char * readerWriterType () const
 
virtual const char * xmlType () 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 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 DtPropertyInterface * property ()
 
virtual const DtPropertyInterface * property () const
 
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 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)
 

Protected Member Functions

virtual void copyMenuEntries (const DtList *)
 
virtual void merge (DtVrfMenuEntry *)
 
virtual void addMenuItem (const DtString &item, const DtObjectType &type, int force, const char *name, const DtString &at)
 
virtual void writeSelf (std::string &fp, int i, bool writeUnspecified, const DtFilename &path)
 
- Protected Member Functions inherited from DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 

Protected Attributes

DtList myEntries
 
DtString myComment
 
DtFilename myFilename
 
std::set< DtVrfMenuEntry * > mySetEntries
 
- Protected Attributes inherited from makVrf::DtVrfMenuEntry
DtRwString myLabel
 
- 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
 

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 )()
 
- 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)
 
- 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

makVrf::DtVrfMenu::DtVrfMenu ( const DtString &  name,
DtReaderWriterRegistry *const  parentRegistry = NULL 
)

Constructor.

virtual makVrf::DtVrfMenu::~DtVrfMenu ( )
virtual

Destructor.

makVrf::DtVrfMenu::DtVrfMenu ( const DtVrfMenu &  orig)

Copy constructor.

Member Function Documentation

DtVrfMenu& makVrf::DtVrfMenu::operator= ( const DtVrfMenu &  orig)

Assignment operator.

virtual bool makVrf::DtVrfMenu::operator== ( const DtVrfMenuEntry &  ) const
virtual

Reimplemented from makVrf::DtVrfMenuEntry.

virtual const DtList& makVrf::DtVrfMenu::entries ( ) const
virtual
virtual void makVrf::DtVrfMenu::getSelf ( DtlObjPtr  args,
const DtReaderWriter::SearchPaths &  searchPaths,
const DtVariableBindingsList &  variableBindings 
)
overridevirtual

Top level to read itself from an input stream. searchPath is passed down to all DtReaderWriter members in its DtReaderWriterRegistry (collection of child DtReaderWriter nodes). If a given member in the registry is of type DtReaderWriterFile, and the searchPath is specified with a non-NULL string, then file to be read in is searched for in the given path.

Reimplemented from DtReaderWriter.

virtual DtlObjPtr makVrf::DtVrfMenu::getLocalData ( DtlObjPtr  args)
virtual
virtual DtlObjPtr makVrf::DtVrfMenu::getData ( DtlObjPtr  args,
const DtReaderWriter::SearchPaths &  searchPaths,
const DtVariableBindingsList &  variableBindings 
)
virtual

Deriving class overrides these to get/put class specific data.

Reimplemented from DtReaderWriter.

virtual void makVrf::DtVrfMenu::addObject ( const DtString &  item,
const DtObjectType &  type,
int  force,
const DtString &  at = "" 
)
virtual
virtual void makVrf::DtVrfMenu::addEntity ( const DtString &  item,
const DtObjectType &  type,
int  force,
const DtString &  at = "" 
)
virtual
virtual bool makVrf::DtVrfMenu::creationKeyFor ( const DtString &  name,
DtEntityMapperKey &  retKey 
) const
virtual

Given an object name, fills in the retKey with the entity mapper key used to create the object. If the object does not exist, returns false. Must check all entries to see if they have the specified name, and, it is of DtCreateObjectMenuItem type.

virtual bool makVrf::DtVrfMenu::load ( const DtFilename &  )
virtual

Loads menu from specified file.

virtual bool makVrf::DtVrfMenu::save ( const DtFilename &  )
virtual

Saves file (and comment) to specified file.

virtual void makVrf::DtVrfMenu::setComment ( const DtString &  )
virtual

Get/set comment.

virtual const DtString& makVrf::DtVrfMenu::comment ( ) const
virtual
virtual DtVrfMenuEntry* makVrf::DtVrfMenu::findEntry ( DtVrfMenuEntry *  ) const
virtual

Returns an entry that matches the given one (if there is one)

virtual DtVrfMenuEntry* makVrf::DtVrfMenu::findEntry ( const DtString &  ,
bool  recurse = false 
) const
virtual

Returns the menu entry that has the specified label. If recursive is false, only looks at this menu.

virtual void makVrf::DtVrfMenu::merge ( DtVrfMenu *  )
virtual

Merges in the supplied menu into this one.

virtual void makVrf::DtVrfMenu::add ( DtVrfMenuEntry *  )
virtual
virtual DtVrfMenuEntry* makVrf::DtVrfMenu::clone ( ) const
virtual

Reimplemented from makVrf::DtVrfMenuEntry.

const DtFilename & makVrf::DtVrfMenu::filename ( ) const
inline

Filename read in.

References myFilename.

void makVrf::DtVrfMenu::setFilename ( const DtFilename &  f)
inline

References myFilename.

virtual void makVrf::DtVrfMenu::copyMenuEntries ( const DtList *  )
protectedvirtual
virtual void makVrf::DtVrfMenu::merge ( DtVrfMenuEntry *  )
protectedvirtual
virtual void makVrf::DtVrfMenu::addMenuItem ( const DtString &  item,
const DtObjectType &  type,
int  force,
const char *  name,
const DtString &  at 
)
protectedvirtual
virtual void makVrf::DtVrfMenu::writeSelf ( std::string &  fp,
int  indentLevel,
bool  writeUnspecified,
const DtFilename &  path 
)
protectedvirtual

Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.

Reimplemented from DtReaderWriter.

Member Data Documentation

DtList makVrf::DtVrfMenu::myEntries
protected
DtString makVrf::DtVrfMenu::myComment
protected
DtFilename makVrf::DtVrfMenu::myFilename
protected

Referenced by filename(), and setFilename().

std::set<DtVrfMenuEntry*> makVrf::DtVrfMenu::mySetEntries
protected
The documentation for this class was generated from the following file:
Document ID: Generated on Tue Sep 24 19:28:17 EDT 2024 from SVN revision 269799
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)