yocto_oscontrol.h File Reference

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

Include dependency graph for yocto_oscontrol.h:

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

Go to the source code of this file.

Classes
class	YOsControl

Macros
#define	Y_SHUTDOWNCOUNTDOWN_INVALID   (YAPI_INVALID_UINT)

Typedefs
typedef void(*	YOsControlValueCallback) (YOsControl *func, const string &functionValue)

Functions
YOsControl *	yFindOsControl (const string &func)
YOsControl *	yFirstOsControl (void)

Macro Definition Documentation

#define Y_SHUTDOWNCOUNTDOWN_INVALID   (YAPI_INVALID_UINT)

Definition at line 55 of file yocto_oscontrol.h.

Typedef Documentation

typedef void(* YOsControlValueCallback) (YOsControl *func, const string &functionValue)

Definition at line 54 of file yocto_oscontrol.h.

Function Documentation

YOsControl* yFindOsControl ( const string &  func )

inline

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

Returns

a YOsControl object allowing you to drive the OS control.

Definition at line 229 of file yocto_oscontrol.h.

YOsControl* yFirstOsControl ( void  )

inline

Starts the enumeration of OS control currently accessible. Use the method YOsControl.nextOsControl() to iterate on next OS control.

Returns

a pointer to a YOsControl object, corresponding to the first OS control currently online, or a NULL pointer if there are none.

Definition at line 240 of file yocto_oscontrol.h.