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

Module for finding and managing timekeepers. More...

#include <timekeeper.hpp>

Public Member Functions

 Timekeepermodule (cmzn_timekeepermodule_id in_timekeepermodule_id)
 
 Timekeepermodule (const Timekeepermodule &timekeeperModule)
 
Timekeepermoduleoperator= (const Timekeepermodule &timekeeperModule)
 
bool isValid () const
 
cmzn_timekeepermodule_id getId () const
 
Timekeeper getDefaultTimekeeper ()
 

Protected Attributes

cmzn_timekeepermodule_id id
 

Detailed Description

Module for finding and managing timekeepers.

Module for finding and managing timekeepers.

Member Function Documentation

Timekeeper OpenCMISS::Zinc::Timekeepermodule::getDefaultTimekeeper ( )
inline

Get the default timekeeper.

Returns
Handle to default timekeeper, or NULL/invalid handle on failure.
cmzn_timekeepermodule_id OpenCMISS::Zinc::Timekeepermodule::getId ( ) const
inline

Return the C handle of the Timekeepermodule object.

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

Check if this is a valid Timekeepermodule object.

Returns
Status True if object is valid, false otherwise.

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