#include <yocto_segmenteddisplay.h>

Inheritance diagram for YSegmentedDisplay:

Public Member Functions
virtual int	_invokeValueCallback (string value)

string	displayedText (void)

Y_DISPLAYMODE_enum	displayMode (void)

string	get_displayedText (void)

Y_DISPLAYMODE_enum	get_displayMode (void)

YSegmentedDisplay *	next (void)

YSegmentedDisplay *	nextSegmentedDisplay (void)

virtual int	registerValueCallback (YSegmentedDisplayValueCallback callback)

int	set_displayedText (const string &newval)

int	set_displayMode (Y_DISPLAYMODE_enum newval)

int	setDisplayedText (const string &newval)

int	setDisplayMode (Y_DISPLAYMODE_enum newval)

	~YSegmentedDisplay ()

Public Member Functions inherited from YFunction
void	_clearDataStreamCache ()

string	_decode_json_string (const string &json)

string	_download (const string &url)

YDataStream *	_findDataStream (YDataSet &dataset, const string &def)

string	_get_json_path (const string &json, const string &path)

vector< string >	_json_get_array (const string &json)

string	_json_get_key (const string &json, const string &data)

string	_json_get_string (const string &json)

int	_parseEx (yJsonStateMachine &j)

virtual int	_parserHelper (void)

string	_parseString (yJsonStateMachine &j)

string	_request (const string &request)

string	_requestEx (int tcpchan, const string &request, yapiRequestProgressCallback callback, void *context)

void	_throw (YRETCODE errType, string errMsg)

YRETCODE	_upload (const string &path, const string &content)

YRETCODE	_uploadWithProgress (const string &path, const string &content, yapiRequestProgressCallback callback, void *context)

string	advertisedValue (void)

void	clearCache ()

string	describe (void)

string	errMessage (void)

string	errorMessage (void)

YRETCODE	errorType (void)

YRETCODE	errType (void)

YFUN_DESCR	functionDescriptor (void)

string	get_advertisedValue (void)

string	get_errorMessage (void)

YRETCODE	get_errorType (void)

virtual string	get_friendlyName (void)

YFUN_DESCR	get_functionDescriptor (void)

string	get_functionId (void)

string	get_hardwareId (void)

string	get_hubSerial ()

string	get_logicalName (void)

YModule *	get_module (void)

void *	get_userData (void)

bool	isOnline (void)

YRETCODE	load (int msValidity)

virtual string	loadAttribute (string attrName)

string	logicalName (void)

YModule *	module (void)

virtual int	muteValueCallbacks (void)

YFunction *	next (void)

YFunction *	nextFunction (void)

virtual int	registerValueCallback (YFunctionValueCallback callback)

int	set_advertisedValue (const string &newval)

int	set_logicalName (const string &newval)

void	set_userData (void *data)

int	setAdvertisedValue (const string &newval)

int	setLogicalName (const string &newval)

void	setUserData (void *data)

virtual int	unmuteValueCallbacks (void)

void *	userData (void)

virtual	~YFunction ()

Static Public Member Functions
static YSegmentedDisplay *	Find (string func)

static YSegmentedDisplay *	FindSegmentedDisplay (string func)

static YSegmentedDisplay *	First (void)

static YSegmentedDisplay *	FirstSegmentedDisplay (void)

Static Public Member Functions inherited from YFunction
static void	_ClearCache (void)

static YFunction *	Find (string func)

static YFunction *	FindFunction (string func)

static YFunction *	First (void)

static YFunction *	FirstFunction (void)

Static Public Attributes
static const string	DISPLAYEDTEXT_INVALID = YAPI_INVALID_STRING

static const Y_DISPLAYMODE_enum	DISPLAYMODE_AUTO1 = Y_DISPLAYMODE_AUTO1

static const Y_DISPLAYMODE_enum	DISPLAYMODE_AUTO60 = Y_DISPLAYMODE_AUTO60

static const Y_DISPLAYMODE_enum	DISPLAYMODE_DISCONNECTED = Y_DISPLAYMODE_DISCONNECTED

static const Y_DISPLAYMODE_enum	DISPLAYMODE_INVALID = Y_DISPLAYMODE_INVALID

static const Y_DISPLAYMODE_enum	DISPLAYMODE_MANUAL = Y_DISPLAYMODE_MANUAL

Static Public Attributes inherited from YFunction
static const string	ADVERTISEDVALUE_INVALID = YAPI_INVALID_STRING

static const string	FRIENDLYNAME_INVALID = YAPI_INVALID_STRING

static const YFUN_DESCR	FUNCTIONDESCRIPTOR_INVALID = Y_FUNCTIONDESCRIPTOR_INVALID

static const string	FUNCTIONID_INVALID = YAPI_INVALID_STRING

static const string	HARDWAREID_INVALID = YAPI_INVALID_STRING

static const string	LOGICALNAME_INVALID = YAPI_INVALID_STRING

Protected Member Functions
virtual int	_parseAttr (YJSONObject *json_val)

	YSegmentedDisplay (const string &func)

Protected Member Functions inherited from YFunction
YRETCODE	_buildSetRequest (const string &changeattr, const string *changeval, string &request, string &errmsg)

string	_escapeAttr (const string &changeval)

YRETCODE	_getDescriptor (YFUN_DESCR &fundescr, string &errMsg)

YRETCODE	_getDevice (YDevice *&dev, string &errMsg)

YRETCODE	_load_unsafe (int msValidity)

YRETCODE	_nextFunction (string &hwId)

int	_parse (YJSONObject *j)

YRETCODE	_setAttr (string attrname, string newvalue)

	YFunction (const string &func)

Protected Attributes
string	_displayedText

Y_DISPLAYMODE_enum	_displayMode

YSegmentedDisplayValueCallback	_valueCallbackSegmentedDisplay

Protected Attributes inherited from YFunction
string	_advertisedValue

u64	_cacheExpiration

string	_className

std::map< string, YDataStream * >	_dataStreams

string	_func

YFUN_DESCR	_fundescr

string	_funId

string	_hwId

string	_lastErrorMsg

YRETCODE	_lastErrorType

string	_logicalName

string	_serial

yCRITICAL_SECTION	_this_cs

void *	_userData

YFunctionValueCallback	_valueCallbackFunction

Friends
YSegmentedDisplay *	yFindSegmentedDisplay (const string &func)

YSegmentedDisplay *	yFirstSegmentedDisplay (void)

Additional Inherited Members
Static Protected Member Functions inherited from YFunction
static void	_AddToCache (const string &classname, const string &func, YFunction *obj)

static YFunction *	_FindFromCache (const string &classname, const string &func)

static void	_UpdateTimedReportCallbackList (YFunction *func, bool add)

static void	_UpdateValueCallbackList (YFunction *func, bool add)

Static Protected Attributes inherited from YFunction
static std::map< string, YFunction * >	_cache

Detailed Description

YSegmentedDisplay Class: SegmentedDisplay function interface

The SegmentedDisplay class allows you to drive segmented displays.

Definition at line 74 of file yocto_segmenteddisplay.h.

Constructor & Destructor Documentation

YSegmentedDisplay::YSegmentedDisplay ( const string & func )

protected

Definition at line 51 of file yocto_segmenteddisplay.cpp.

YSegmentedDisplay::~YSegmentedDisplay ( )

Definition at line 61 of file yocto_segmenteddisplay.cpp.

Member Function Documentation

int YSegmentedDisplay::_invokeValueCallback ( string value )

virtual

Reimplemented from YFunction.

Definition at line 252 of file yocto_segmenteddisplay.cpp.

int YSegmentedDisplay::_parseAttr ( YJSONObject * json_val )

protectedvirtual

Reimplemented from YFunction.

Definition at line 70 of file yocto_segmenteddisplay.cpp.

string YSegmentedDisplay::displayedText ( void )

inline

Definition at line 116 of file yocto_segmenteddisplay.h.

Y_DISPLAYMODE_enum YSegmentedDisplay::displayMode ( void )

inline

Definition at line 134 of file yocto_segmenteddisplay.h.

static YSegmentedDisplay* YSegmentedDisplay::Find ( string func )

inlinestatic

Definition at line 187 of file yocto_segmenteddisplay.h.

YSegmentedDisplay * YSegmentedDisplay::FindSegmentedDisplay ( string func )

static

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 201 of file yocto_segmenteddisplay.cpp.

static YSegmentedDisplay* YSegmentedDisplay::First ( void )

inlinestatic

Definition at line 211 of file yocto_segmenteddisplay.h.

YSegmentedDisplay * YSegmentedDisplay::FirstSegmentedDisplay ( void )

static

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 272 of file yocto_segmenteddisplay.cpp.

string YSegmentedDisplay::get_displayedText ( void )

Returns the text currently displayed on the screen.

Returns: a string corresponding to the text currently displayed on the screen

On failure, throws an exception or returns Y_DISPLAYEDTEXT_INVALID.

Definition at line 89 of file yocto_segmenteddisplay.cpp.

Y_DISPLAYMODE_enum YSegmentedDisplay::get_displayMode ( void )

Definition at line 136 of file yocto_segmenteddisplay.cpp.

YSegmentedDisplay* YSegmentedDisplay::next ( void )

inline

Definition at line 198 of file yocto_segmenteddisplay.h.

YSegmentedDisplay * YSegmentedDisplay::nextSegmentedDisplay ( void )

Continues the enumeration of segmented displays started using yFirstSegmentedDisplay().

Returns: a pointer to a YSegmentedDisplay object, corresponding to a segmented display currently online, or a NULL pointer if there are no more segmented displays to enumerate.

Definition at line 262 of file yocto_segmenteddisplay.cpp.

int YSegmentedDisplay::registerValueCallback ( YSegmentedDisplayValueCallback callback )

virtual

Registers the callback function that is invoked on every change of advertised value. The callback is invoked only during the execution of ySleep or yHandleEvents. This provides control over the time when the callback is triggered. For good responsiveness, remember to call one of these two functions periodically. To unregister a callback, pass a NULL pointer as argument.

Parameters

callback : the callback function to call, or a NULL pointer. The callback function should take two arguments: the function object of which the value has changed, and the character string describing the new advertised value.

Definition at line 233 of file yocto_segmenteddisplay.cpp.

int YSegmentedDisplay::set_displayedText ( const string & newval )

Changes the text currently displayed on the screen.

Parameters

newval : a string corresponding to the text currently displayed on the screen

Returns: YAPI_SUCCESS if the call succeeds.

On failure, throws an exception or returns a negative error code.

Definition at line 120 of file yocto_segmenteddisplay.cpp.

int YSegmentedDisplay::set_displayMode ( Y_DISPLAYMODE_enum newval )

Definition at line 158 of file yocto_segmenteddisplay.cpp.

int YSegmentedDisplay::setDisplayedText ( const string & newval )

inline

Definition at line 129 of file yocto_segmenteddisplay.h.

int YSegmentedDisplay::setDisplayMode ( Y_DISPLAYMODE_enum newval )

inline

Definition at line 138 of file yocto_segmenteddisplay.h.

Friends And Related Function Documentation

YSegmentedDisplay* yFindSegmentedDisplay ( const string & func )

friend

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 )

friend

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.

Member Data Documentation

string YSegmentedDisplay::_displayedText

protected

Definition at line 82 of file yocto_segmenteddisplay.h.

Y_DISPLAYMODE_enum YSegmentedDisplay::_displayMode

protected

Definition at line 83 of file yocto_segmenteddisplay.h.

YSegmentedDisplayValueCallback YSegmentedDisplay::_valueCallbackSegmentedDisplay

protected

Definition at line 84 of file yocto_segmenteddisplay.h.

const string YSegmentedDisplay::DISPLAYEDTEXT_INVALID = YAPI_INVALID_STRING

static

Definition at line 100 of file yocto_segmenteddisplay.h.

const Y_DISPLAYMODE_enum YSegmentedDisplay::DISPLAYMODE_AUTO1 = Y_DISPLAYMODE_AUTO1

static

Definition at line 103 of file yocto_segmenteddisplay.h.

const Y_DISPLAYMODE_enum YSegmentedDisplay::DISPLAYMODE_AUTO60 = Y_DISPLAYMODE_AUTO60

static

Definition at line 104 of file yocto_segmenteddisplay.h.

const Y_DISPLAYMODE_enum YSegmentedDisplay::DISPLAYMODE_DISCONNECTED = Y_DISPLAYMODE_DISCONNECTED

static

Definition at line 101 of file yocto_segmenteddisplay.h.

const Y_DISPLAYMODE_enum YSegmentedDisplay::DISPLAYMODE_INVALID = Y_DISPLAYMODE_INVALID

static

Definition at line 105 of file yocto_segmenteddisplay.h.

const Y_DISPLAYMODE_enum YSegmentedDisplay::DISPLAYMODE_MANUAL = Y_DISPLAYMODE_MANUAL

static

Definition at line 102 of file yocto_segmenteddisplay.h.

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

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation