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::Loggernotifier Class Reference

Manages individual user notification of changes with a logger. More...

#include <logger.hpp>

Public Member Functions

 Loggernotifier (cmzn_loggernotifier_id in_loggernotifier_id)
 
 Loggernotifier (const Loggernotifier &loggerNotifier)
 
Loggernotifieroperator= (const Loggernotifier &loggerNotifier)
 
bool isValid () const
 
cmzn_loggernotifier_id getId () const
 
int setCallback (Loggercallback &callback)
 
int clearCallback ()
 

Protected Attributes

cmzn_loggernotifier_id id
 

Detailed Description

Manages individual user notification of changes with a logger.

Manages individual user notification of changes with a logger.

Member Function Documentation

int OpenCMISS::Zinc::Loggernotifier::clearCallback ( )
inline

Stop and clear logger callback. This will stop the callback and also remove the callback function from the logger notifier.

Returns
Status OpenCMISS::Zinc::OK on success, any other value on failure.
cmzn_loggernotifier_id OpenCMISS::Zinc::Loggernotifier::getId ( ) const
inline

Return the C handle of the Loggernotifier object.

Returns
C handle of Loggernotifier if this objects is valid, 0 otherwise.
bool OpenCMISS::Zinc::Loggernotifier::isValid ( ) const
inline

Check if this is a valid Loggernotifier object.

Returns
Status True if object is valid, false otherwise.
int OpenCMISS::Zinc::Loggernotifier::setCallback ( Loggercallback callback)
inline

Assign the callback function and user data for the logger notifier. This function also starts the callback.

See Also
cmzn_loggernotifier_callback_function
Parameters
callbackfunction to be called when event is triggered.
user_data_inVoid pointer to user object. User must ensure this object's lifetime exceeds the duration for which callbacks are active.
Returns
Status OpenCMISS::Zinc::OK on success, any other value on failure.

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