DtTaskMessageDescriptor Class Reference

Inheritance diagram for DtTaskMessageDescriptor:

Public Member Functions
	DtTaskMessageDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	constructor Setting the readonly flag prevents object from writing itself to the stream.
	DtTaskMessageDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
virtual	~DtTaskMessageDescriptor ()
	destructor
	DtTaskMessageDescriptor (const DtTaskMessageDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
const DtTaskMessageDescriptor &	operator= (const DtTaskMessageDescriptor &orig)
	assignment operator
virtual void	setTaskMessage (const DtTaskMessage &taskMessage)
	Set/get the task message.
virtual DtTaskMessage *	taskMessage () const
virtual void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtReaderWriter::appPath())
	Override putSelf() to map myTaskMessage to reader/writer data members writing to file.
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Override getSelf() to map reader/writer data members to myTaskMessage.
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
bool	operator== (const DtReaderWriter &) const
	Equivalence operator.
bool	operator!= (const DtReaderWriter &rhs)
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 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 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.
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)
	Override putData() to write our task to file.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Override getData() to create our task from the mtl stream.
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.

Protected Attributes
DtTaskMessage *	myTaskMessage
DtSimTask *	myTask
	These data members are only valid within putSelf() and getSelf() calls.
DtRwString	myTransmitter
DtRwBoolean	myTransmitterIsEchelonId
DtRwString	myReceiver
DtRwBoolean	myReceiverIsEchelonId
DtRwBoolean	myIndependentlyTasked
DtRwInt	myTaskId
DtRwInt	myTaskTrackingNumber
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
typedef DtReaderWriterFactory *(*	DtReaderWriterFactoryCreatorFcn )()
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 void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory.
static void	createReaderWriterFactory ()
static DtReaderWriterFactory *	factory ()
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

Constructor & Destructor Documentation

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

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

By default, DtReaderWriter objects are read/write.

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

virtual DtTaskMessageDescriptor::~DtTaskMessageDescriptor ( )

virtual

destructor

DtTaskMessageDescriptor::DtTaskMessageDescriptor	(	const DtTaskMessageDescriptor &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

copy constructor

Member Function Documentation

const DtTaskMessageDescriptor& DtTaskMessageDescriptor::operator=

(

const DtTaskMessageDescriptor &

orig

)

assignment operator

virtual void DtTaskMessageDescriptor::setTaskMessage ( const DtTaskMessage &  taskMessage )

virtual

Set/get the task message.

virtual DtTaskMessage* DtTaskMessageDescriptor::taskMessage ( ) const

virtual

virtual void DtTaskMessageDescriptor::putSelf ( FILE *  fp, int  indentLevel = 0, bool  writeUnspecified = false, const DtFilename &  path = DtReaderWriter::appPath()  )

virtual

Override putSelf() to map myTaskMessage to reader/writer data members writing to file.

Reimplemented from DtReaderWriter.

virtual void DtTaskMessageDescriptor::getSelf ( DtlObjPtr  args, const DtFilename &  searchPath, const DtVariableBindingsList &  variableBindings  )

virtual

Override getSelf() to map reader/writer data members to myTaskMessage.

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

protectedvirtual

Override putData() to write our task to file.

Reimplemented from DtReaderWriter.

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

protectedvirtual

Override getData() to create our task from the mtl stream.

Member Data Documentation

DtTaskMessage* DtTaskMessageDescriptor::myTaskMessage

protected

DtSimTask* DtTaskMessageDescriptor::myTask

protected

These data members are only valid within putSelf() and getSelf() calls.

They are only used for reading from/writing to file.

DtRwString DtTaskMessageDescriptor::myTransmitter

protected

DtRwBoolean DtTaskMessageDescriptor::myTransmitterIsEchelonId

protected

DtRwString DtTaskMessageDescriptor::myReceiver

protected

DtRwBoolean DtTaskMessageDescriptor::myReceiverIsEchelonId

protected

DtRwBoolean DtTaskMessageDescriptor::myIndependentlyTasked

protected

DtRwInt DtTaskMessageDescriptor::myTaskId

protected

DtRwInt DtTaskMessageDescriptor::myTaskTrackingNumber

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjcore/taskMessageDesc.h