yocto_segmenteddisplay.h File Reference

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

Include dependency graph for yocto_segmenteddisplay.h:

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

Go to the source code of this file.

Classes
class	YSegmentedDisplay

Macros
#define	_Y_DISPLAYMODE_ENUM
#define	Y_DISPLAYEDTEXT_INVALID   (YAPI_INVALID_STRING)

Typedefs
typedef void(*	YSegmentedDisplayValueCallback) (YSegmentedDisplay *func, const string &functionValue)

Enumerations
enum	Y_DISPLAYMODE_enum {   Y_DISPLAYMODE_DISCONNECTED = 0, Y_DISPLAYMODE_MANUAL = 1, Y_DISPLAYMODE_AUTO1 = 2, Y_DISPLAYMODE_AUTO60 = 3,   Y_DISPLAYMODE_INVALID = -1 }

Functions
YSegmentedDisplay *	yFindSegmentedDisplay (const string &func)
YSegmentedDisplay *	yFirstSegmentedDisplay (void)

Macro Definition Documentation

#define _Y_DISPLAYMODE_ENUM

Definition at line 56 of file yocto_segmenteddisplay.h.

#define Y_DISPLAYEDTEXT_INVALID   (YAPI_INVALID_STRING)

Definition at line 65 of file yocto_segmenteddisplay.h.

Typedef Documentation

typedef void(* YSegmentedDisplayValueCallback) (YSegmentedDisplay *func, const string &functionValue)

Definition at line 54 of file yocto_segmenteddisplay.h.

Enumeration Type Documentation

enum Y_DISPLAYMODE_enum

Enumerator
Y_DISPLAYMODE_DISCONNECTED
Y_DISPLAYMODE_MANUAL
Y_DISPLAYMODE_AUTO1
Y_DISPLAYMODE_AUTO60
Y_DISPLAYMODE_INVALID

Definition at line 57 of file yocto_segmenteddisplay.h.

Function Documentation

YSegmentedDisplay* yFindSegmentedDisplay ( const string &  func )

inline

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

Returns

a YSegmentedDisplay object allowing you to drive the segmented displays.

Definition at line 248 of file yocto_segmenteddisplay.h.

YSegmentedDisplay* yFirstSegmentedDisplay ( void  )

inline

Starts the enumeration of segmented displays currently accessible. Use the method YSegmentedDisplay.nextSegmentedDisplay() to iterate on next segmented displays.

Returns

a pointer to a YSegmentedDisplay object, corresponding to the first segmented displays currently online, or a NULL pointer if there are none.

Definition at line 259 of file yocto_segmenteddisplay.h.