OpenCMISS-Zinc C++ API Documentation
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 ()
int readDescription (const char *description)
char * writeDescription ()

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 ( )

Get the default timekeeper.

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

Return the C handle of the Timekeepermodule object.

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

Check if this is a valid Timekeepermodule object.

Status True if object is valid, false otherwise.
int OpenCMISS::Zinc::Timekeepermodule::readDescription ( const char *  description)

Read the json description to the timekeeper module. This will change the timekeeper in the timekeeper module.

The string containing json description

OpenCMISS::Zinc::OK on success, otherwise ERROR status.
char* OpenCMISS::Zinc::Timekeepermodule::writeDescription ( )

Write the json file describing the timekeepers in the timekeeper module, which can be used to store the current timekeeper settings.

c string containing the json description of timekeeper module, otherwise 0;

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