DtSimReport Class Reference

DtSimReport is an abstract base class from which real reports can derive. More...

Inheritance diagram for DtSimReport:

Public Member Functions
virtual	~DtSimReport ()
	destructor
virtual bool	init ()
	Base class init does nothing, but this will be called by create, in case any other deriving class needs to do virtual allocation.
virtual const DtSimReportMessageType &	type () const =0
	What kind of report am I? Returns a character string representing the kind of report.
virtual DtSimReport *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const =0
	Make a copy of this report.
virtual void	putData (FILE *fp, int indentLevel=0)
	putData writes our type, which is provided by the virtual type accessor of the deriving class.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	getData is just used to get us past the type in the data stream, since it's not actually stored.
virtual char *	netRep ()
virtual void	clearNetRep ()
	Clears the stored netRep.
virtual int	netRepSize () const =0
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)=0
virtual bool	setToNet ()=0
virtual DtString	stringRep () const
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	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 (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	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, 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 const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
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 DtSimReport *	createReport (const DtSimReportMessageType &reportTypeString)
	Static functions.
static void	addReportCreatorFcn (const DtSimReportMessageType &reportName, DtSimReportCreatorFcn fcn)
static void	setFactory (DtSimReportFactory *factory)
static DtSimReportFactory *	factory ()
static bool	isTypeRegistered (const DtSimReportMessageType &type)
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.

Protected Member Functions
	DtSimReport ()
	Constructors are protected because no one should instantiate the base class, just derived versions.
	DtSimReport (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	constructor if you have a task 'put' itself, the write name will preface the task.
	DtSimReport (const DtString &writeName, const DtSimReport &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtSimReport &	operator= (const DtSimReport &orig)
	assignment operator; same as copy constructor
virtual char *	createNetworkBuffer ()
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.

Protected Attributes
char *	myNetRep
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
static DtSimReportFactory *	myFactory
Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static DtReaderWriterFactory	theFactory

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

Detailed Description

DtSimReport is an abstract base class from which real reports can derive.

It manages the read/write capability; derived classes need only use and register read/writatble data types for derived information. The DtReportMessage class is used to convey a DtSimReport over the radio network. Components register callback functions for report messages in the same way that they do for task and set data messages.

Constructor & Destructor Documentation

DtSimReport::DtSimReport ( )

protected

Constructors are protected because no one should instantiate the base class, just derived versions.

default constructor

DtSimReport::DtSimReport ( const DtString &  writeName, DtReaderWriterRegistry *  parentRegistry = 0  )

protected

constructor if you have a task 'put' itself, the write name will preface the task.

DtSimReport::DtSimReport ( const DtString &  writeName, const DtSimReport &  orig, DtReaderWriterRegistry *  parentRegistry = 0  )

protected

copy constructor

virtual DtSimReport::~DtSimReport ( )

virtual

destructor

Member Function Documentation

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

protected

assignment operator; same as copy constructor

virtual bool DtSimReport::init ( )

virtual

Base class init does nothing, but this will be called by create, in case any other deriving class needs to do virtual allocation.

virtual const DtSimReportMessageType& DtSimReport::type ( ) const

pure virtual

What kind of report am I? Returns a character string representing the kind of report.

Derived classes must implement this function, returning a string that uniquely represents the kind of report it is. The definitions for report types used in VR-Forces are in radioMsgTypes.h.

Implemented in DtTaskCompleteReport, DtSpotReport, DtTaskCanceledReport, and DtTextReport.

virtual DtSimReport* DtSimReport::clone ( const DtString &  name, DtReaderWriterRegistry *  parentRegistry = 0  ) const

pure virtual

Make a copy of this report.

Returns a pointer to a newly created copy of this report. Derived classes must implement this function to instantiate and initialize a copy of the derived class type.

Implemented in DtTaskCompleteReport, DtTaskCanceledReport, DtSpotReport, and DtTextReport.

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

virtual

putData writes our type, which is provided by the virtual type accessor of the deriving class.

Reimplemented from DtReaderWriter.

virtual DtlObjPtr DtSimReport::getData ( DtlObjPtr  args, const DtFilename &  searchPath, const DtVariableBindingsList &  variableBindings  )

virtual

getData is just used to get us past the type in the data stream, since it's not actually stored.

Reimplemented from DtReaderWriter.

virtual char* DtSimReport::netRep ( )

virtual

virtual void DtSimReport::clearNetRep ( )

virtual

Clears the stored netRep.

It will be regenerated the next time netRep() is called. If a report already has a netRep, and some of the data has changed, call this to force a update of the netRep next time the report is sent on the network.

virtual int DtSimReport::netRepSize ( ) const

pure virtual

Implemented in DtSpotReport, DtTaskCompleteReport, DtTaskCanceledReport, and DtTextReport.

virtual bool DtSimReport::setFromNet ( const char *  contentBuffer, unsigned  contentSize  )

pure virtual

Implemented in DtSpotReport, DtTaskCompleteReport, DtTaskCanceledReport, and DtTextReport.

virtual bool DtSimReport::setToNet ( )

pure virtual

Implemented in DtSpotReport, DtTaskCompleteReport, DtTaskCanceledReport, and DtTextReport.

virtual DtString DtSimReport::stringRep ( ) const

virtual

Reimplemented in DtSpotReport, DtTaskCompleteReport, DtTaskCanceledReport, and DtTextReport.

static DtSimReport* DtSimReport::createReport ( const DtSimReportMessageType &  reportTypeString )

static

Static functions.

Creates a report based on a string type.

static void DtSimReport::addReportCreatorFcn ( const DtSimReportMessageType &  reportName, DtSimReportCreatorFcn  fcn  )

static

static void DtSimReport::setFactory ( DtSimReportFactory *  factory )

static

static DtSimReportFactory* DtSimReport::factory ( )

static

Returns

A pointer to the static DtReaderWriterFactory. This factory can create instances of DtReaderWriter subclasses that have been registered with it.

Reimplemented from DtReaderWriter.

static bool DtSimReport::isTypeRegistered ( const DtSimReportMessageType &  type )

static

virtual char* DtSimReport::createNetworkBuffer ( )

protectedvirtual

Member Data Documentation

char* DtSimReport::myNetRep

protected

DtSimReportFactory* DtSimReport::myFactory

staticprotected

---

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

• include/vrftasks/simReport.h