PtTerminalListener Class Reference

#include <PtTerminalListener.h>

Inheritance diagram for PtTerminalListener:

Collaboration diagram for PtTerminalListener:

Public Member Functions
PT_CLASS_INFO_MEMBERS	PtTerminalListener (const char *pTerminalName=NULL, PtEventMask *pMask=NULL)
virtual	~PtTerminalListener ()
	param: (in) pMask - Event mask defining events the listener is interested. This must be a subset of the events that the listener supports. The mask may be NULL where it is assumed that all events applicable to the derived listener are of interest. More...
void	terminalEventTransmissionEnded (const PtTerminalEvent &rEvent)
PtStatus	setTerminalName (const char *name)
	param: (in) rEvent - Reference to the PtEvent containing the specific event information. More...
PtStatus	getTerminalName (char *name, int len)
virtual PtBoolean	isClass (const char *pClassName)
	returns: Returns the string representation of the name of this class More...
virtual PtBoolean	isInstanceOf (const char *pClassName)
	param: (in) pClassName - the string to compare with the name of this class. retcode: TRUE - if the given string contains the class name of this class. retcode: FALSE - if the given string does not match that of this class More...
Public Member Functions inherited from PtEventListener
PT_CLASS_INFO_MEMBERS	PtEventListener (PtEventMask *pMask=NULL)
virtual	~PtEventListener ()
	param: (in) pMask - Event mask defining events the listener is interested in. This must be a subset of the events that the listener supports. The mask may be NULL where it is assumed that all events applicable to the derived listener are of interest. More...
PtStatus	getEventMask (const PtEventMask *&rpMask) const
PtBoolean	isEventEnabled (PtEvent::PtEventId &eventId)
	param: (in) pClassName - The string to compare with the name of this class retcode: TRUE - If this object is either an instance of or is derived from the specified class retcode: FALSE - If this object is not an instance of the specified class More...

Static Public Member Functions
static const char *	className ()
Static Public Member Functions inherited from PtEventListener
static const char *	className ()
	param: (out) rpMask - Reference to a pointer to the PtEventMask. retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...

Protected Attributes
char *	mpTerminalName
	param: (in) pClassName - the string to compare with the name of this class. retcode: TRUE - if this object is either an instance of or is derived from the specified class. retcode: FALSE - if this object is not an instance of the specified class. More...
Protected Attributes inherited from PtEventListener
PtEventMask *	mpMask
	param: (in) eventId - The event id corresponding to the event type retcode: TRUE - If the given event type is of interest to this listener retcode: FALSE - If the given event type is NOT of interest to this listener More...

Private Member Functions
	PtTerminalListener (const PtTerminalListener &rPtTerminalListener)
PtTerminalListener &	operator= (const PtTerminalListener &rhs)

Constructor & Destructor Documentation

PtTerminalListener	(	const char *	pTerminalName = NULL,
		PtEventMask *	pMask = NULL
	)

~PtTerminalListener ( )

virtual

param: (in) pMask - Event mask defining events the listener is interested. This must be a subset of the events that the listener supports. The mask may be NULL where it is assumed that all events applicable to the derived listener are of interest.

PtTerminalListener ( const PtTerminalListener &  rPtTerminalListener )

private

Member Function Documentation

static const char* className ( )

static

PtStatus getTerminalName	(	char *	name,
		int	len
	)

virtual PtBoolean isClass ( const char *  pClassName )

virtual

returns: Returns the string representation of the name of this class

Reimplemented from PtEventListener.

Reimplemented in PtTerminalComponentListener.

virtual PtBoolean isInstanceOf ( const char *  pClassName )

virtual

param: (in) pClassName - the string to compare with the name of this class. retcode: TRUE - if the given string contains the class name of this class. retcode: FALSE - if the given string does not match that of this class

Reimplemented from PtEventListener.

Reimplemented in PtTerminalComponentListener.

PtTerminalListener & operator= ( const PtTerminalListener &  rhs )

private

PtStatus setTerminalName

(

const char *

name

)

param: (in) rEvent - Reference to the PtEvent containing the specific event information.

void terminalEventTransmissionEnded

(

const PtTerminalEvent &

rEvent

)

Member Data Documentation

char* mpTerminalName

protected

param: (in) pClassName - the string to compare with the name of this class. retcode: TRUE - if this object is either an instance of or is derived from the specified class. retcode: FALSE - if this object is not an instance of the specified class.