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:

[legend]

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 DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Top level to read itself from an input stream.
virtual void	saveFile (const DtFilename &filename)
	Saves contents of file to specified filename.
virtual void	loadFile (const DtFilename &searchPath, const DtVariableBindingsList &variableBindings, DtlObjStringMap *commentMap=NULL)
virtual void	putSelf (FILE *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.
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)
	copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
virtual	~DtReaderWriter ()
	destructor
virtual void	writeSelf (FILE *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 bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
virtual bool	isReadonly () const
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 DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
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 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 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.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

Static Public Member Functions
static const DtFilename &	appPath ()
	Gets the current working directory. Calls DtReaderWriter::appPath().
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (FILE *fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static DtReaderWriterFactory *	factory ()

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.
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	putData (FILE *fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.

Protected Attributes
DtRwString	myFilename
DtReaderWriter *	myObjectToReadAndWrite
bool	myFileReadOnly
DtFilename	myFilenameLastReadIn
DtString	myVariableSubstitutedFilename
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
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::pair < DtSymbolString, DtString >	DtVariableNameType
Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static DtReaderWriterFactory	theFactory

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 DtFilename &	searchPath,
		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.

Reimplemented from DtReaderWriter.

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

virtual

Saves contents of file to specified filename.

virtual void DtReaderWriterFile::loadFile	(	const DtFilename &	searchPath,
		const DtVariableBindingsList &	variableBindings,
		DtlObjStringMap *	commentMap = `NULL`
	)

virtual

Reimplemented in DtReaderWriterFileExtensible.

virtual void DtReaderWriterFile::putSelf	(	FILE *	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::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:

include/vrfutil/rwFile.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation