OpenCMISS-Zinc C++ API Documentation
Public Member Functions | Protected Attributes | List of all members
OpenCMISS::Zinc::Timenotifierevent Class Reference

Information about changes to the timekeeper/time. More...

#include <timenotifier.hpp>

Public Member Functions

 Timenotifierevent (cmzn_timenotifierevent_id in_timenotifier_event_id)
 
 Timenotifierevent (const Timenotifierevent &timenotifierEvent)
 
Timenotifiereventoperator= (const Timenotifierevent &timenotifierEvent)
 
bool isValid () const
 
cmzn_timenotifierevent_id getId () const
 
double getTime () const
 

Protected Attributes

cmzn_timenotifierevent_id id
 

Detailed Description

Information about changes to the timekeeper/time.

Information about changes to the timekeeper/time, sent with each callback from the time notifier.

Member Function Documentation

cmzn_timenotifierevent_id OpenCMISS::Zinc::Timenotifierevent::getId ( ) const
inline

Return the C handle of the Timenotifierevent object.

Returns
C handle of Timenotifierevent if this objects is valid, 0 otherwise.
double OpenCMISS::Zinc::Timenotifierevent::getTime ( ) const
inline

Get the time when this timenotifier event is triggered.

Returns
The time when this timenotifier event is triggered
bool OpenCMISS::Zinc::Timenotifierevent::isValid ( ) const
inline

Check if this is a valid Timenotifierevent object.

Returns
Status True if object is valid, false otherwise.

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