yocto_hubport.h File Reference

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

Include dependency graph for yocto_hubport.h:

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

Go to the source code of this file.

Classes
class	YHubPort

Macros
#define	_Y_ENABLED_ENUM
#define	_Y_PORTSTATE_ENUM
#define	Y_BAUDRATE_INVALID   (YAPI_INVALID_UINT)

Typedefs
typedef void(*	YHubPortValueCallback) (YHubPort *func, const string &functionValue)

Enumerations
enum	Y_ENABLED_enum {   Y_ENABLED_FALSE = 0, Y_ENABLED_TRUE = 1, Y_ENABLED_INVALID = -1, Y_ENABLED_FALSE = 0,   Y_ENABLED_TRUE = 1, Y_ENABLED_INVALID = -1, Y_ENABLED_FALSE = 0, Y_ENABLED_TRUE = 1,   Y_ENABLED_INVALID = -1, Y_ENABLED_FALSE = 0, Y_ENABLED_TRUE = 1, Y_ENABLED_INVALID = -1,   Y_ENABLED_FALSE = 0, Y_ENABLED_TRUE = 1, Y_ENABLED_INVALID = -1, Y_ENABLED_FALSE = 0,   Y_ENABLED_TRUE = 1, Y_ENABLED_INVALID = -1 }
enum	Y_PORTSTATE_enum {   Y_PORTSTATE_OFF = 0, Y_PORTSTATE_OVRLD = 1, Y_PORTSTATE_ON = 2, Y_PORTSTATE_RUN = 3,   Y_PORTSTATE_PROG = 4, Y_PORTSTATE_INVALID = -1 }

Functions
YHubPort *	yFindHubPort (const string &func)
YHubPort *	yFirstHubPort (void)

Macro Definition Documentation

#define _Y_ENABLED_ENUM

Definition at line 56 of file yocto_hubport.h.

#define _Y_PORTSTATE_ENUM

Definition at line 64 of file yocto_hubport.h.

#define Y_BAUDRATE_INVALID   (YAPI_INVALID_UINT)

Definition at line 77 of file yocto_hubport.h.

Typedef Documentation

typedef void(* YHubPortValueCallback) (YHubPort *func, const string &functionValue)

Definition at line 54 of file yocto_hubport.h.

Enumeration Type Documentation

enum Y_ENABLED_enum

Enumerator
Y_ENABLED_FALSE
Y_ENABLED_TRUE
Y_ENABLED_INVALID
Y_ENABLED_FALSE
Y_ENABLED_TRUE
Y_ENABLED_INVALID
Y_ENABLED_FALSE
Y_ENABLED_TRUE
Y_ENABLED_INVALID
Y_ENABLED_FALSE
Y_ENABLED_TRUE
Y_ENABLED_INVALID
Y_ENABLED_FALSE
Y_ENABLED_TRUE
Y_ENABLED_INVALID
Y_ENABLED_FALSE
Y_ENABLED_TRUE
Y_ENABLED_INVALID

Definition at line 57 of file yocto_hubport.h.

enum Y_PORTSTATE_enum

Enumerator
Y_PORTSTATE_OFF
Y_PORTSTATE_OVRLD
Y_PORTSTATE_ON
Y_PORTSTATE_RUN
Y_PORTSTATE_PROG
Y_PORTSTATE_INVALID

Definition at line 68 of file yocto_hubport.h.

Function Documentation

YHubPort* yFindHubPort ( const string &  func )

inline

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

Returns

a YHubPort object allowing you to drive the Yocto-hub port.

Definition at line 288 of file yocto_hubport.h.

YHubPort* yFirstHubPort ( void  )

inline

Starts the enumeration of Yocto-hub ports currently accessible. Use the method YHubPort.nextHubPort() to iterate on next Yocto-hub ports.

Returns

a pointer to a YHubPort object, corresponding to the first Yocto-hub port currently online, or a NULL pointer if there are none.

Definition at line 299 of file yocto_hubport.h.