yocto_realtimeclock.h File Reference

#include "yocto_api.h"
#include <cfloat>
#include <cmath>
#include <map>

Include dependency graph for yocto_realtimeclock.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	YRealTimeClock

Macros
#define	_Y_TIMESET_ENUM
#define	Y_DATETIME_INVALID   (YAPI_INVALID_STRING)
#define	Y_UNIXTIME_INVALID   (YAPI_INVALID_LONG)
#define	Y_UTCOFFSET_INVALID   (YAPI_INVALID_INT)

Typedefs
typedef void(*	YRealTimeClockValueCallback) (YRealTimeClock *func, const string &functionValue)

Enumerations
enum	Y_TIMESET_enum { Y_TIMESET_FALSE = 0, Y_TIMESET_TRUE = 1, Y_TIMESET_INVALID = -1 }

Functions
YRealTimeClock *	yFindRealTimeClock (const string &func)
YRealTimeClock *	yFirstRealTimeClock (void)

Macro Definition Documentation

#define _Y_TIMESET_ENUM

Definition at line 56 of file yocto_realtimeclock.h.

#define Y_DATETIME_INVALID   (YAPI_INVALID_STRING)

Definition at line 64 of file yocto_realtimeclock.h.

#define Y_UNIXTIME_INVALID   (YAPI_INVALID_LONG)

Definition at line 63 of file yocto_realtimeclock.h.

#define Y_UTCOFFSET_INVALID   (YAPI_INVALID_INT)

Definition at line 65 of file yocto_realtimeclock.h.

Typedef Documentation

typedef void(* YRealTimeClockValueCallback) (YRealTimeClock *func, const string &functionValue)

Definition at line 54 of file yocto_realtimeclock.h.

Enumeration Type Documentation

enum Y_TIMESET_enum

Enumerator
Y_TIMESET_FALSE
Y_TIMESET_TRUE
Y_TIMESET_INVALID

Definition at line 57 of file yocto_realtimeclock.h.

Function Documentation

YRealTimeClock* yFindRealTimeClock ( const string &  func )

inline

Retrieves a clock for a given identifier. The identifier can be specified using several formats:

• FunctionLogicalName
• ModuleSerialNumber.FunctionIdentifier
• ModuleSerialNumber.FunctionLogicalName
• ModuleLogicalName.FunctionIdentifier
• ModuleLogicalName.FunctionLogicalName

This function does not require that the clock is online at the time it is invoked. The returned object is nevertheless valid. Use the method YRealTimeClock.isOnline() to test if the clock is indeed online at a given time. In case of ambiguity when looking for a clock by logical name, no error is notified: the first instance found is returned. The search is performed first by hardware name, then by logical name.

If a call to this object's is_online() method returns FALSE although you are certain that the matching device is plugged, make sure that you did call registerHub() at application initialization time.

Parameters

func	: a string that uniquely characterizes the clock

Returns

a YRealTimeClock object allowing you to drive the clock.

Definition at line 296 of file yocto_realtimeclock.h.

YRealTimeClock* yFirstRealTimeClock ( void  )

inline

Starts the enumeration of clocks currently accessible. Use the method YRealTimeClock.nextRealTimeClock() to iterate on next clocks.

Returns

a pointer to a YRealTimeClock object, corresponding to the first clock currently online, or a NULL pointer if there are none.

Definition at line 307 of file yocto_realtimeclock.h.