DtCeReceiveTextMessage Class Reference

Conditional expression which tests whether the associated entity receives a DtTextReport that contains the text specified in the condition. More...

Inheritance diagram for DtCeReceiveTextMessage:

Public Member Functions
	DtCeReceiveTextMessage ()
	default constructor
	DtCeReceiveTextMessage (DtReaderWriterRegistry *parentRegistry)
	real constructor
	DtCeReceiveTextMessage (const DtCeReceiveTextMessage &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
virtual	~DtCeReceiveTextMessage ()
	destructor
DtCeReceiveTextMessage &	operator= (const DtCeReceiveTextMessage &orig)
	assignment operator
virtual DtSimCondExpr *	clone (DtReaderWriterRegistry *parentRegistry=NULL)
	clone operator
virtual bool	operator== (const DtCeReceiveTextMessage &rhs) const
virtual int	type () const
	Returns DtReceiveTextConditionExpressionType (defined above).
virtual DtString	stringRep (int subExprIndex=DtSR_EXPR) const
	Get a readable string representation of this level of this expression.
virtual int	netRepSize () const
	These 3 should become pure virtual functions.
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
	Fills in the expression from the network buffer.
virtual bool	setToNet ()
	Fills in the network buffer (created by base class conditional expression) with the conditional expression contents.
virtual void	setMatchingText (const DtString &text)
	The text that will be matched to the radio message to determine if the text message meets this condition.
virtual DtString	matchingText () const
	The text that will be matched to the radio message to determine if the text message meets this condition.
virtual void	setAllowContaining (bool allow)
virtual bool	allowContaining () const
Public Member Functions inherited from DtSimCondExpr
	DtSimCondExpr ()
	default constructor
	DtSimCondExpr (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	real constructor
	DtSimCondExpr (const DtSimCondExpr &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
virtual	~DtSimCondExpr ()
	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.
DtSimCondExpr &	operator= (const DtSimCondExpr &orig)
	assignment operator
virtual void	setEvaluator (DtEvaluator *evaluator)
	Set the evaluator object to be used in our evaluate() function.
virtual bool	evaluate (const DtString &objectName, DtSimManager *simManager) const
	Evaluate this conditional expression for the entity with the given object name, in the context of the given simManager, and return the current result.
virtual int	subExprCount () const
	Get the number of sub-expressions nested inside this expression.
virtual DtSimCondExpr *	subExpr (int index)
	Get a pointer to any particular sub-expression nested inside this expression.
DtString	stringRepFull () const
	Get a readable string representation of this full expression.
virtual char *	netRep ()
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 DtSimCondExpr *	creator ()
	Returns a new DtCeReceiveTextMessage.
Static Public Member Functions inherited from DtSimCondExpr
static DtSimCondExpr *	createCondExpr (DtlObjPtr mtlStream)
	Static functions.
static void	addCondExprCreatorFcn (const DtString &type, const int intType, DtCondExprCreatorFcn fcn)
	Adds a conditional expression creator member function to the conditional expression factory.
static void	setFactory (DtCondExprFactory *factory)
static DtCondExprFactory *	factory ()
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 Attributes
DtRwString	myMatchingText
DtRwBoolean	myAllowContaining
Protected Attributes inherited from DtSimCondExpr
char *	myNetRep
DtEvaluator *	myEvaluator
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 Public Attributes inherited from DtSimCondExpr
static const int	DtSR_EXPR = -1
	A constant for use as the subExprIndex argument to stringRep().
Protected Member Functions inherited from DtSimCondExpr
virtual char *	createNetworkBuffer ()
Static Protected Attributes inherited from DtSimCondExpr
static DtCondExprFactory *	myFactory

Detailed Description

Conditional expression which tests whether the associated entity receives a DtTextReport that contains the text specified in the condition.

Constructor & Destructor Documentation

DtCeReceiveTextMessage::DtCeReceiveTextMessage

(

)

default constructor

DtCeReceiveTextMessage::DtCeReceiveTextMessage

(

DtReaderWriterRegistry *

parentRegistry

)

real constructor

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

copy constructor

virtual DtCeReceiveTextMessage::~DtCeReceiveTextMessage ( )

virtual

destructor

Member Function Documentation

DtCeReceiveTextMessage& DtCeReceiveTextMessage::operator=

(

const DtCeReceiveTextMessage &

orig

)

assignment operator

virtual DtSimCondExpr* DtCeReceiveTextMessage::clone ( DtReaderWriterRegistry *  parentRegistry = NULL )

virtual

clone operator

Implements DtSimCondExpr.

virtual bool DtCeReceiveTextMessage::operator== ( const DtCeReceiveTextMessage &  rhs ) const

virtual

virtual int DtCeReceiveTextMessage::type ( ) const

virtual

Returns DtReceiveTextConditionExpressionType (defined above).

Implements DtSimCondExpr.

virtual void DtCeReceiveTextMessage::setMatchingText ( const DtString &  text )

virtual

The text that will be matched to the radio message to determine if the text message meets this condition.

If allowContaining() is true, then as long as any substring of the message text matches this text, the condition is true. Otherwise, the text of the message must match this text exactly. If this text is empty, then any message text will trigger this condition.

virtual DtString DtCeReceiveTextMessage::matchingText ( ) const

virtual

The text that will be matched to the radio message to determine if the text message meets this condition.

If allowContaining() is true, then as long as any substring of the message text matches this text, the condition is true. Otherwise, the text of the message must match this text exactly. If this text is empty, then any message text will trigger this condition.

virtual void DtCeReceiveTextMessage::setAllowContaining ( bool  allow )

virtual

See Also

setMatchingText() and matchingText().

virtual bool DtCeReceiveTextMessage::allowContaining ( ) const

virtual

See Also

setMatchingText() and matchingText().

virtual DtString DtCeReceiveTextMessage::stringRep ( int  subExprIndex = DtSR_EXPR ) const

virtual

Get a readable string representation of this level of this expression.

The subExprIndex argument indicates which stringRep to get if this expression can have sub-expressions. If a sub-expression index >= 0 is given, the string returned will be the one that should precede that sub-expression. A sub-expression index of DtSimCondExpr::DtSR_EXPR requests the string that should follow any and all sub-expressions, this is the value that should be used for expressions that have no subExprs (i.e. subExprCount() == 0).

Implements DtSimCondExpr.

virtual int DtCeReceiveTextMessage::netRepSize ( ) const

virtual

These 3 should become pure virtual functions.

Reimplemented from DtSimCondExpr.

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

virtual

Fills in the expression from the network buffer.

Reimplemented from DtSimCondExpr.

virtual bool DtCeReceiveTextMessage::setToNet ( )

virtual

Fills in the network buffer (created by base class conditional expression) with the conditional expression contents.

Reimplemented from DtSimCondExpr.

static DtSimCondExpr* DtCeReceiveTextMessage::creator ( )

static

Returns a new DtCeReceiveTextMessage.

Member Data Documentation

DtRwString DtCeReceiveTextMessage::myMatchingText

protected

DtRwBoolean DtCeReceiveTextMessage::myAllowContaining

protected

---

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

• include/vrfutil/ceReceiveTextMessage.h