SHAPER  9.12.0
Events_MessageBool Class Reference

An event message for sending a message with a boolean value. More...

Inheritance diagram for Events_MessageBool:
Inheritance graph

Public Member Functions

 Events_MessageBool (const Events_ID theEventID, const bool theValue, const void *theSender=0)
 Constructor. More...
 
virtual ~Events_MessageBool ()
 Default destructor. More...
 
const bool value () const
 Returns the value stored in this message. More...
 
EVENTS_EXPORT void send ()
 Sends the message. More...
 
const Events_IDeventID () const
 Returns identifier of the message. More...
 
void * sender () const
 Returns sender of the message or NULL if it is anonymous message. More...
 

Detailed Description

An event message for sending a message with a boolean value.

May be used for different where just a Boolean flag is needed to send.

Constructor & Destructor Documentation

◆ Events_MessageBool()

Events_MessageBool::Events_MessageBool ( const Events_ID  theEventID,
const bool  theValue,
const void *  theSender = 0 
)
inline

Constructor.

Parameters
theEventIDan indentifier of the message
theValuea Boolean value to send
theSendera pointer on sender object

◆ ~Events_MessageBool()

virtual Events_MessageBool::~Events_MessageBool ( )
inlinevirtual

Default destructor.

Member Function Documentation

◆ value()

const bool Events_MessageBool::value ( ) const
inline

Returns the value stored in this message.

◆ send()

void Events_MessageBool::send ( )

Sends the message.

◆ eventID()

const Events_ID& Events_Message::eventID ( ) const
inlineinherited

Returns identifier of the message.

◆ sender()

void* Events_Message::sender ( ) const
inlineinherited

Returns sender of the message or NULL if it is anonymous message.