OpenCMISS-Zinc C++ API Documentation
 All Classes Namespaces Files Functions Typedefs Enumerations Enumerator Pages
Public Member Functions | Protected Attributes | List of all members
OpenCMISS::Zinc::Loggerevent Class Reference

Information about changes to messages in the logger. More...

#include <logger.hpp>

Public Member Functions

 Loggerevent (cmzn_loggerevent_id in_logger_event_id)
 
 Loggerevent (const Loggerevent &loggerEvent)
 
Loggereventoperator= (const Loggerevent &loggerEvent)
 
bool isValid () const
 
cmzn_loggerevent_id getId () const
 
Logger::ChangeFlags getChangeFlags () const
 
Logger::MessageType getMessageType () const
 
char * getMessageText () const
 
Logger getLogger () const
 

Protected Attributes

cmzn_loggerevent_id id
 

Detailed Description

Information about changes to messages in the logger.

Information about changes to messages in the logger, sent with each callback from the logger notifier.

Member Function Documentation

Logger::ChangeFlags OpenCMISS::Zinc::Loggerevent::getChangeFlags ( ) const
inline

Get logical OR of flags indicating how the logger has changed.

See Also
Logger::ChangeFlag
Parameters
loggerThe logger to query about.
Returns
The change flags summarising the change: logical OR of enum Logger::ChangeFlag values. Returns CMZN_LOGGER_CHANGE_FLAG_NONE in case of invalid arguments.
cmzn_loggerevent_id OpenCMISS::Zinc::Loggerevent::getId ( ) const
inline

Return the C handle of the Loggerevent object.

Returns
C handle of Loggerevent if this objects is valid, 0 otherwise.
Logger OpenCMISS::Zinc::Loggerevent::getLogger ( ) const
inline

Get the logger which creates this event.

Returns
valid logger associated with this event, otherwise 0.
char* OpenCMISS::Zinc::Loggerevent::getMessageText ( ) const
inline

Get the message assoicated with this event. This may not neccessarily be the last message on the logger.

Returns
The message associated with this event.
Logger::MessageType OpenCMISS::Zinc::Loggerevent::getMessageType ( ) const
inline

Get the type of the message associated with this event.

See Also
Logger::MessageType
Returns
The type of the message associated with this event.
bool OpenCMISS::Zinc::Loggerevent::isValid ( ) const
inline

Check if this is a valid Loggerevent object.

Returns
Status True if object is valid, false otherwise.

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