yocto_wakeupschedule.h File Reference

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

Include dependency graph for yocto_wakeupschedule.h:

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

Go to the source code of this file.

Classes
class	YWakeUpSchedule

Macros
#define	Y_HOURS_INVALID   (YAPI_INVALID_UINT)
#define	Y_MINUTESA_INVALID   (YAPI_INVALID_UINT)
#define	Y_MINUTESB_INVALID   (YAPI_INVALID_UINT)
#define	Y_MONTHDAYS_INVALID   (YAPI_INVALID_UINT)
#define	Y_MONTHS_INVALID   (YAPI_INVALID_UINT)
#define	Y_NEXTOCCURENCE_INVALID   (YAPI_INVALID_LONG)
#define	Y_WEEKDAYS_INVALID   (YAPI_INVALID_UINT)

Typedefs
typedef void(*	YWakeUpScheduleValueCallback) (YWakeUpSchedule *func, const string &functionValue)

Functions
YWakeUpSchedule *	yFindWakeUpSchedule (const string &func)
YWakeUpSchedule *	yFirstWakeUpSchedule (void)

Macro Definition Documentation

#define Y_HOURS_INVALID   (YAPI_INVALID_UINT)

Definition at line 57 of file yocto_wakeupschedule.h.

#define Y_MINUTESA_INVALID   (YAPI_INVALID_UINT)

Definition at line 55 of file yocto_wakeupschedule.h.

#define Y_MINUTESB_INVALID   (YAPI_INVALID_UINT)

Definition at line 56 of file yocto_wakeupschedule.h.

#define Y_MONTHDAYS_INVALID   (YAPI_INVALID_UINT)

Definition at line 59 of file yocto_wakeupschedule.h.

#define Y_MONTHS_INVALID   (YAPI_INVALID_UINT)

Definition at line 60 of file yocto_wakeupschedule.h.

#define Y_NEXTOCCURENCE_INVALID   (YAPI_INVALID_LONG)

Definition at line 61 of file yocto_wakeupschedule.h.

#define Y_WEEKDAYS_INVALID   (YAPI_INVALID_UINT)

Definition at line 58 of file yocto_wakeupschedule.h.

Typedef Documentation

typedef void(* YWakeUpScheduleValueCallback) (YWakeUpSchedule *func, const string &functionValue)

Definition at line 54 of file yocto_wakeupschedule.h.

Function Documentation

YWakeUpSchedule* yFindWakeUpSchedule ( const string &  func )

inline

Retrieves a wake up schedule 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 wake up schedule is online at the time it is invoked. The returned object is nevertheless valid. Use the method YWakeUpSchedule.isOnline() to test if the wake up schedule is indeed online at a given time. In case of ambiguity when looking for a wake up schedule 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 wake up schedule

Returns

a YWakeUpSchedule object allowing you to drive the wake up schedule.

Definition at line 396 of file yocto_wakeupschedule.h.

YWakeUpSchedule* yFirstWakeUpSchedule ( void  )

inline

Starts the enumeration of wake up schedules currently accessible. Use the method YWakeUpSchedule.nextWakeUpSchedule() to iterate on next wake up schedules.

Returns

a pointer to a YWakeUpSchedule object, corresponding to the first wake up schedule currently online, or a NULL pointer if there are none.

Definition at line 407 of file yocto_wakeupschedule.h.