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:

List of all members.

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
Static Public Member Functions
static DtSimCondExpr *	creator ()
	Returns a new DtCeReceiveTextMessage.
Protected Attributes
DtRwString	myMatchingText
DtRwBoolean	myAllowContaining

---

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