DtReaderWriterFile Class Reference

Using a DtReaderWriterFile allows a DtReaderWriter object to be read in from an MTL stream contained in an external file. More...

Inheritance diagram for DtReaderWriterFile:

Public Member Functions
	DtReaderWriterFile ()
	default constructor
	DtReaderWriterFile (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	real constructor
	DtReaderWriterFile (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriterFile (const DtString &name, const DtReaderWriterFile &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtReaderWriterFile (const DtSymbolString &name, const DtReaderWriterFile &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtReaderWriterFile &	operator= (const DtReaderWriterFile &orig)
	assignment operator
DtReaderWriterFile &	operator= (const DtFilename &orig)
virtual	~DtReaderWriterFile ()
	destructor
DtReaderWriterFile *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	clone
DtReaderWriterFile *	clone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	Top level to read itself from an input stream.
virtual bool	saveFile (const DtFilename &filename)
	Saves contents of file to specified filename.
virtual bool	loadFile (const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings, DtlObjStringMap *commentMap=NULL)
	Returns true if file is loaded.
virtual void	putSelf (std::string &fp, int indentLevel, bool writeUnspecified, const DtFilename &path)
	Top level call to write itself to file.
virtual void	setObjectToReadAndWrite (DtReaderWriter *object)
	Sets the DtReaderWriter to be read from and written to the file.
virtual const DtReaderWriter &	objectToReadAndWrite () const
	Returns the DtReaderWriter to be read from and written to the file.
virtual void	setFilename (const DtString &filename)
	Name of the file to to write.
virtual void	setFilename (const DtString &filename, const DtString &unsubstitutedFilename)
	Sets the filename in the same way as setFilename(const DtString& filename), but additionally sets the unsubstituted filename to the specified string.
virtual const DtString &	filename () const
	If variables are specified in the filename, they will be substituted with their values before being returned by this method.
virtual DtString	unsubstitutedFilename () const
virtual void	setUnsubstitudedFilename (const DtString &f)
	Sets the unsubsituted filename in the myFileame object.
virtual const DtFilename &	filenameLastReadIn () const
	Name of file most recently read in by getSelf()
virtual void	setFileReadOnly (bool readOnly=true)
	By default, DtReaderWriterFile reads a file that has been specified, but when it writes itself, it only writes the filename.
virtual bool	fileReadOnly () const
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual void	substitute (const DtVariableBindingsList &variableBindings)
	Substitutes any variables in the list to variable substituted filename.
bool	operator== (const DtReaderWriterFile &) const
	Only compares filenames, not contents.
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream.
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	pseudo-copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
bool	operator== (const DtReaderWriter &) const
	Equivalence operator.
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
	destructor
virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op.
virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op.
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op.
virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op.
virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object.
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object.
virtual void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
bool	isReadonly () const
virtual void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to iriginal state Default is no-op.
virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment.
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false.
virtual void	setName (const DtString &)
	Set the name of the object.
virtual const char *	xmlType () const
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
std::string	debugText () const
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children.
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
	Returns true if this variable has a child p in it's chain.
virtual bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference.
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
	Checks to see if this RW object is a variable reference that can be bound using the provided bindings.
virtual void	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated.
virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time.
virtual void	putData (std::string &fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
	The specified flags are used for optional values.
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively.
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
	The variable name, if this object is a variable reference.
virtual const DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriter *	defaultRWValue ()
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable.
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Give the stream, if the stream contains a default value then set it here.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename.
virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid.
virtual bool	fromXmlFile (const DtFilename &)
	Restires object from given xml file.
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data.
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference.
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())
	Gets data from the environment value.
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
	Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op.
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference.

Static Public Member Functions
static const DtFilename &	appPath ()
	Gets the current working directory. Calls DtReaderWriter::appPath().
static DtFilename	findHighestPriorityFile (const DtFilename &filename, const DtReaderWriter::SearchPaths &searchPaths, bool warnOnNotFound=true)
static FILE *	loadHighestPriorityFile (const DtFilename &filename, const DtReaderWriter::SearchPaths &searchPaths, bool warnOnNotFound=true)
static FILE *	loadHighestPriorityFile (const DtFilename &filename, const DtReaderWriter::SearchPaths &searchPaths, DtFilename &successfulPath, bool warnOnNotFound=true)
static DtFilename	createPathFragment (const DtFilename &filename, const DtReaderWriter::SearchPaths &searchPaths)
	Returns a filename that is a substitutable fragment for the given file.
static std::vector< DtFilename >	findFilesByExtension (const DtString &path, const DtString &extension)
	Finds all files with the given extension in the supplied path.
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 ()
	The type that is used when archiving to an XML stream.
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory.
static void	createReaderWriterFactory ()
static void	cleanupFactory ()
static DtReaderWriterFactory *	factory ()
static DtReaderWriter *	createFromXmlFile (const DtFilename &)
	Given a filename, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromXml (const DtString &)
	Given a xml string, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP)
	Given a xml environment, returns a newly created reader/writer object from the object found within.
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
	Gets the named attribute from a DtEnvValueSP.
Static Public Member Functions inherited from DtObjectDebugger< DtReaderWriter >
static DtObjectCounter::CounterType	ObjectCount ()
static const DtObjectContainer *	ObjectContainer ()

Protected Member Functions
bool	getFilenameToWrite (const DtFilename &path, const DtFilename &filename, DtFilename &filenameToWrite) const
	Get the filename to write, given a path and base filename.
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
Protected Member Functions inherited from DtObjectDebugger< DtReaderWriter >
	DtObjectDebugger ()
	DtObjectDebugger (const DtObjectDebugger &)
	~DtObjectDebugger ()

Protected Attributes
DtRwString	myFilename
DtReaderWriter *	myObjectToReadAndWrite
bool	myFileReadOnly
DtFilename	myFilenameLastReadIn
DtString	myVariableSubstitutedFilename
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
	Container for the aliases which represent alternative names for the object.
bool	myInvalid
	Set to true if there is a problem reading this item.

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

Detailed Description

Using a DtReaderWriterFile allows a DtReaderWriter object to be read in from an MTL stream contained in an external file.

For instance, the signature object sensor uses a DtReaderWriterFile for its "combat-identification-level-table-file" parameter. Once the file is created, setObjectToReadAndWrite must be called before use.

Constructor & Destructor Documentation

DtReaderWriterFile::DtReaderWriterFile

(

)

default constructor

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

real constructor

DtReaderWriterFile::DtReaderWriterFile	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

DtReaderWriterFile::DtReaderWriterFile	(	const DtString &	name,
		const DtReaderWriterFile &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

copy constructor

DtReaderWriterFile::DtReaderWriterFile	(	const DtSymbolString &	name,
		const DtReaderWriterFile &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

virtual DtReaderWriterFile::~DtReaderWriterFile ( )

virtual

destructor

Member Function Documentation

DtReaderWriterFile& DtReaderWriterFile::operator=

(

const DtReaderWriterFile &

orig

)

assignment operator

Reimplemented in DtReaderWriterFileExtensible.

DtReaderWriterFile& DtReaderWriterFile::operator=

(

const DtFilename &

orig

)

Reimplemented in DtReaderWriterFileExtensible.

DtReaderWriterFile* DtReaderWriterFile::clone	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

clone

DtReaderWriterFile* DtReaderWriterFile::clone	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

virtual void DtReaderWriterFile::getSelf ( DtlObjPtr  args, const DtReaderWriter::SearchPaths &  searchPaths, const DtVariableBindingsList &  variableBindings  )

virtual

Top level to read itself from an input stream.

searchPath is the name of the directory in which to locate it's filename to load.

virtual bool DtReaderWriterFile::saveFile ( const DtFilename &  filename )

virtual

Saves contents of file to specified filename.

virtual bool DtReaderWriterFile::loadFile ( const DtReaderWriter::SearchPaths &  searchPaths, const DtVariableBindingsList &  variableBindings, DtlObjStringMap *  commentMap = NULL  )

virtual

Returns true if file is loaded.

Reimplemented in DtReaderWriterFileExtensible.

Referenced by DtFormationTable::FormationAdder::operator()().

virtual void DtReaderWriterFile::putSelf ( std::string &  fp, int  indentLevel, bool  writeUnspecified, const DtFilename &  path  )

virtual

Top level call to write itself to file.

The path prepended to the filename before writing the entry to file.

Reimplemented from DtReaderWriter.

virtual void DtReaderWriterFile::setObjectToReadAndWrite ( DtReaderWriter *  object )

virtual

Sets the DtReaderWriter to be read from and written to the file.

virtual const DtReaderWriter& DtReaderWriterFile::objectToReadAndWrite ( ) const

virtual

Returns the DtReaderWriter to be read from and written to the file.

static const DtFilename& DtReaderWriterFile::appPath ( )

static

Gets the current working directory. Calls DtReaderWriter::appPath().

Reimplemented from DtReaderWriter.

virtual void DtReaderWriterFile::setFilename ( const DtString &  filename )

virtual

Name of the file to to write.

If path is absolute, this is the filename that will be written in putSelf(). If filename is relative, it will be combined with the path passed into putSelf(). If variables are specified in the filename, they will be substituted with their values before being returned by this method. This sets both the full filename and the unsubstituted filename to this string, essentially removing any variables.

virtual void DtReaderWriterFile::setFilename ( const DtString &  filename, const DtString &  unsubstitutedFilename  )

virtual

Sets the filename in the same way as setFilename(const DtString& filename), but additionally sets the unsubstituted filename to the specified string.

Note

Use this method with caution. You must set the filename and unsubstituted filename to equivalent values if they are to be read in correctly.

virtual const DtString& DtReaderWriterFile::filename ( ) const

virtual

If variables are specified in the filename, they will be substituted with their values before being returned by this method.

Use unsubstitutedFilename() to get the string with variables still in it.

virtual DtString DtReaderWriterFile::unsubstitutedFilename ( ) const

virtual

Returns

The filename of the file without any variable substitutions.

virtual void DtReaderWriterFile::setUnsubstitudedFilename ( const DtString &  f )

virtual

Sets the unsubsituted filename in the myFileame object.

virtual const DtFilename& DtReaderWriterFile::filenameLastReadIn ( ) const

virtual

Name of file most recently read in by getSelf()

virtual void DtReaderWriterFile::setFileReadOnly ( bool  readOnly = true )

virtual

By default, DtReaderWriterFile reads a file that has been specified, but when it writes itself, it only writes the filename.

If you want it to write not only the filename but also write the 'objectToReadAndWrite', call setFileReadOnly(false).

virtual bool DtReaderWriterFile::fileReadOnly ( ) const

virtual

virtual const char* DtReaderWriterFile::readerWriterType ( ) const

virtual

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 DtReaderWriter.

virtual void DtReaderWriterFile::substitute ( const DtVariableBindingsList &  variableBindings )

virtual

Substitutes any variables in the list to variable substituted filename.

Reimplemented in DtReaderWriterFileExtensible.

bool DtReaderWriterFile::operator==

(

const DtReaderWriterFile &

)

const

Only compares filenames, not contents.

static DtFilename DtReaderWriterFile::findHighestPriorityFile ( const DtFilename &  filename, const DtReaderWriter::SearchPaths &  searchPaths, bool  warnOnNotFound = true  )

static

static FILE* DtReaderWriterFile::loadHighestPriorityFile ( const DtFilename &  filename, const DtReaderWriter::SearchPaths &  searchPaths, bool  warnOnNotFound = true  )

static

static FILE* DtReaderWriterFile::loadHighestPriorityFile ( const DtFilename &  filename, const DtReaderWriter::SearchPaths &  searchPaths, DtFilename &  successfulPath, bool  warnOnNotFound = true  )

static

static DtFilename DtReaderWriterFile::createPathFragment ( const DtFilename &  filename, const DtReaderWriter::SearchPaths &  searchPaths  )

static

Returns a filename that is a substitutable fragment for the given file.

static std::vector<DtFilename> DtReaderWriterFile::findFilesByExtension ( const DtString &  path, const DtString &  extension  )

static

Finds all files with the given extension in the supplied path.

Non-recursive.

bool DtReaderWriterFile::getFilenameToWrite ( const DtFilename &  path, const DtFilename &  filename, DtFilename &  filenameToWrite  ) const

protected

Get the filename to write, given a path and base filename.

If filename is absolute, sets filenameToWrite to filename and returns true. If filename is relative, combines the path with the filename, creating the directory if necessary.

Member Data Documentation

DtRwString DtReaderWriterFile::myFilename

protected

DtReaderWriter* DtReaderWriterFile::myObjectToReadAndWrite

protected

bool DtReaderWriterFile::myFileReadOnly

protected

DtFilename DtReaderWriterFile::myFilenameLastReadIn

protected

DtString DtReaderWriterFile::myVariableSubstitutedFilename

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-4-branch/include/vrfutil/readerWriterFile.h