Inheritance diagram for DtCSVReaderWriter:

Public Types
typedef std::vector< std::string >	DtCSVLineEntry
	Stores a parsed csv line.
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

Public Member Functions
	DtCSVReaderWriter ()
	default constructor
	DtCSVReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream.
	DtCSVReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtCSVReaderWriter (const DtString &name, const DtCSVReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtCSVReaderWriter (const DtSymbolString &name, const DtCSVReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtCSVReaderWriter &	operator= (const DtCSVReaderWriter &orig)
	assignment operator
virtual	~DtCSVReaderWriter ()
	destructor
virtual void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	getSelf (FILE *fp)
	Top level to read itself from an input stream.
virtual void	writeSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Called from putSelf to write out individual data items.
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
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	getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
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.

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

Additional Inherited Members
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 const DtFilename &	appPath ()
	Gets the current working directory.
static DtReaderWriterFactory *	factory ()
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.
Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static DtReaderWriterFactory	theFactory

Detailed Description

File: csvReaderWriter.h.

Class: DtCSVReaderWriter

Description:

Member Typedef Documentation

typedef std::vector<std::string> DtCSVReaderWriter::DtCSVLineEntry

Stores a parsed csv line.

Constructor & Destructor Documentation

DtCSVReaderWriter::DtCSVReaderWriter ( )

default constructor

DtCSVReaderWriter::DtCSVReaderWriter	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = `NULL`,
		bool	readonly = `false`
	)

real constructor Setting the readonly flag prevents object from writing itself to the stream.

By default, DtReaderWriter objects are read/write.

DtCSVReaderWriter::DtCSVReaderWriter	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = `NULL`,
		bool	readonly = `false`
	)

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

copy constructor

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

virtual DtCSVReaderWriter::~DtCSVReaderWriter ( )

virtual

destructor

Member Function Documentation

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

assignment operator

virtual void DtCSVReaderWriter::putSelf	(	FILE *	fp,
		int	indentLevel = `0`,
		bool	writeUnspecified = `false`,
		const DtFilename &	path = `DtFilename::nullFilename()`
	)

virtual

Top level call to write itself to file.

If write unspecified is true, will write entries that are unspecified. Path is passed down to all DtCSVReaderWriter members in its DtCSVReaderWriterRegistry (collection of child DtCSVReaderWriter nodes).

Reimplemented from DtReaderWriter.

Reimplemented in DtCombatIdentificationLevelTable.

virtual void DtCSVReaderWriter::getSelf ( FILE * fp )

virtual

Top level to read itself from an input stream.

searchPath is passed down to all DtCSVReaderWriter members in its DtCSVReaderWriterRegistry (collection of child DtCSVReaderWriter nodes).

virtual void DtCSVReaderWriter::writeSelf	(	FILE *	fp,
		int	indentLevel = `0`,
		bool	writeUnspecified = `false`,
		const DtFilename &	path = `DtFilename::nullFilename()`
	)

virtual

Called from putSelf to write out individual data items.

Reimplemented from DtReaderWriter.

virtual const char* DtCSVReaderWriter::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.

Reimplemented in DtCombatIdentificationLevelTable, DtCombatIdentificationLevelTableEntry, and DtCombatIdentificationDetectionIntervalEntry.

virtual void DtCSVReaderWriter::putData	(	FILE *	fp,
		int	indentLevel = `0`
	)

protectedvirtual

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

Reimplemented from DtReaderWriter.

virtual bool DtCSVReaderWriter::getData ( FILE * fp )

protectedvirtual

bool DtCSVReaderWriter::readLine	(	FILE *	fp,
		DtString &	line
	)

protected

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

include/vrfutil/csvReaderWriter.h

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation