#include <yocto_voltageoutput.h>

Inheritance diagram for YVoltageOutput:

Public Member Functions
virtual int	_invokeValueCallback (string value)

double	currentVoltage (void)

double	get_currentVoltage (void)

double	get_voltageAtStartUp (void)

string	get_voltageTransition (void)

YVoltageOutput *	next (void)

YVoltageOutput *	nextVoltageOutput (void)

virtual int	registerValueCallback (YVoltageOutputValueCallback callback)

int	set_currentVoltage (double newval)

int	set_voltageAtStartUp (double newval)

int	set_voltageTransition (const string &newval)

int	setCurrentVoltage (double newval)

int	setVoltageAtStartUp (double newval)

int	setVoltageTransition (const string &newval)

double	voltageAtStartUp (void)

virtual int	voltageMove (double V_target, int ms_duration)

string	voltageTransition (void)

	~YVoltageOutput ()

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 YVoltageOutput *	Find (string func)

static YVoltageOutput *	FindVoltageOutput (string func)

static YVoltageOutput *	First (void)

static YVoltageOutput *	FirstVoltageOutput (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 double	CURRENTVOLTAGE_INVALID = YAPI_INVALID_DOUBLE

static const double	VOLTAGEATSTARTUP_INVALID = YAPI_INVALID_DOUBLE

static const string	VOLTAGETRANSITION_INVALID = YAPI_INVALID_STRING

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)

	YVoltageOutput (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
double	_currentVoltage

YVoltageOutputValueCallback	_valueCallbackVoltageOutput

double	_voltageAtStartUp

string	_voltageTransition

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
YVoltageOutput *	yFindVoltageOutput (const string &func)

YVoltageOutput *	yFirstVoltageOutput (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

YVoltageOutput Class: VoltageOutput function interface

The Yoctopuce application programming interface allows you to change the value of the voltage output.

Definition at line 66 of file yocto_voltageoutput.h.

Constructor & Destructor Documentation

YVoltageOutput::YVoltageOutput ( const string & func )

protected

Definition at line 51 of file yocto_voltageoutput.cpp.

YVoltageOutput::~YVoltageOutput ( )

Definition at line 62 of file yocto_voltageoutput.cpp.

Member Function Documentation

int YVoltageOutput::_invokeValueCallback ( string value )

virtual

Reimplemented from YFunction.

Definition at line 313 of file yocto_voltageoutput.cpp.

int YVoltageOutput::_parseAttr ( YJSONObject * json_val )

protectedvirtual

Reimplemented from YFunction.

Definition at line 73 of file yocto_voltageoutput.cpp.

double YVoltageOutput::currentVoltage ( void )

inline

Definition at line 119 of file yocto_voltageoutput.h.

static YVoltageOutput* YVoltageOutput::Find ( string func )

inlinestatic

Definition at line 215 of file yocto_voltageoutput.h.

YVoltageOutput * YVoltageOutput::FindVoltageOutput ( string func )

static

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

Returns: a YVoltageOutput object allowing you to drive the voltage output.

Definition at line 262 of file yocto_voltageoutput.cpp.

static YVoltageOutput* YVoltageOutput::First ( void )

inlinestatic

Definition at line 239 of file yocto_voltageoutput.h.

YVoltageOutput * YVoltageOutput::FirstVoltageOutput ( void )

static

Starts the enumeration of voltage outputs currently accessible. Use the method YVoltageOutput.nextVoltageOutput() to iterate on next voltage outputs.

Returns: a pointer to a YVoltageOutput object, corresponding to the first voltage output currently online, or a NULL pointer if there are none.

Definition at line 357 of file yocto_voltageoutput.cpp.

double YVoltageOutput::get_currentVoltage ( void )

Returns the output voltage set point, in V.

Returns: a floating point number corresponding to the output voltage set point, in V

On failure, throws an exception or returns Y_CURRENTVOLTAGE_INVALID.

Definition at line 120 of file yocto_voltageoutput.cpp.

double YVoltageOutput::get_voltageAtStartUp ( void )

Returns the selected voltage output at device startup, in V.

Returns: a floating point number corresponding to the selected voltage output at device startup, in V

On failure, throws an exception or returns Y_VOLTAGEATSTARTUP_INVALID.

Definition at line 213 of file yocto_voltageoutput.cpp.

string YVoltageOutput::get_voltageTransition ( void )

Definition at line 142 of file yocto_voltageoutput.cpp.

YVoltageOutput* YVoltageOutput::next ( void )

inline

Definition at line 226 of file yocto_voltageoutput.h.

YVoltageOutput * YVoltageOutput::nextVoltageOutput ( void )

Continues the enumeration of voltage outputs started using yFirstVoltageOutput().

Returns: a pointer to a YVoltageOutput object, corresponding to a voltage output currently online, or a NULL pointer if there are no more voltage outputs to enumerate.

Definition at line 347 of file yocto_voltageoutput.cpp.

int YVoltageOutput::registerValueCallback ( YVoltageOutputValueCallback 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 294 of file yocto_voltageoutput.cpp.

int YVoltageOutput::set_currentVoltage ( double newval )

Changes the output voltage, in V. Valid range is from 0 to 10V.

Parameters

newval : a floating point number corresponding to the output voltage, in V

Returns: YAPI_SUCCESS if the call succeeds.

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

Definition at line 97 of file yocto_voltageoutput.cpp.

int YVoltageOutput::set_voltageAtStartUp ( double newval )

Changes the output voltage at device start up. Remember to call the matching module saveToFlash() method, otherwise this call has no effect.

Parameters

newval : a floating point number corresponding to the output voltage at device start up

Returns: YAPI_SUCCESS if the call succeeds.

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

Definition at line 190 of file yocto_voltageoutput.cpp.

int YVoltageOutput::set_voltageTransition ( const string & newval )

Definition at line 164 of file yocto_voltageoutput.cpp.

int YVoltageOutput::setCurrentVoltage ( double newval )

inline

Definition at line 107 of file yocto_voltageoutput.h.

int YVoltageOutput::setVoltageAtStartUp ( double newval )

inline

Definition at line 142 of file yocto_voltageoutput.h.

int YVoltageOutput::setVoltageTransition ( const string & newval )

inline

Definition at line 128 of file yocto_voltageoutput.h.

double YVoltageOutput::voltageAtStartUp ( void )

inline

Definition at line 154 of file yocto_voltageoutput.h.

int YVoltageOutput::voltageMove	(	double	V_target,
		int	ms_duration
	)

virtual

Performs a smooth transistion of output voltage. Any explicit voltage change cancels any ongoing transition process.

Parameters

V_target	: new output voltage value at the end of the transition (floating-point number, representing the end voltage in V)
ms_duration	: total duration of the transition, in milliseconds

Returns: YAPI_SUCCESS when the call succeeds.

Definition at line 333 of file yocto_voltageoutput.cpp.

string YVoltageOutput::voltageTransition ( void )

inline

Definition at line 124 of file yocto_voltageoutput.h.

Friends And Related Function Documentation

YVoltageOutput* yFindVoltageOutput ( const string & func )

friend

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

Returns: a YVoltageOutput object allowing you to drive the voltage output.

Definition at line 276 of file yocto_voltageoutput.h.

YVoltageOutput* yFirstVoltageOutput ( void )

friend

Starts the enumeration of voltage outputs currently accessible. Use the method YVoltageOutput.nextVoltageOutput() to iterate on next voltage outputs.

Returns: a pointer to a YVoltageOutput object, corresponding to the first voltage output currently online, or a NULL pointer if there are none.

Definition at line 287 of file yocto_voltageoutput.h.

Member Data Documentation

double YVoltageOutput::_currentVoltage

protected

Definition at line 74 of file yocto_voltageoutput.h.

YVoltageOutputValueCallback YVoltageOutput::_valueCallbackVoltageOutput

protected

Definition at line 77 of file yocto_voltageoutput.h.

double YVoltageOutput::_voltageAtStartUp

protected

Definition at line 76 of file yocto_voltageoutput.h.

string YVoltageOutput::_voltageTransition

protected

Definition at line 75 of file yocto_voltageoutput.h.

const double YVoltageOutput::CURRENTVOLTAGE_INVALID = YAPI_INVALID_DOUBLE

static

Definition at line 93 of file yocto_voltageoutput.h.

const double YVoltageOutput::VOLTAGEATSTARTUP_INVALID = YAPI_INVALID_DOUBLE

static

Definition at line 95 of file yocto_voltageoutput.h.

const string YVoltageOutput::VOLTAGETRANSITION_INVALID = YAPI_INVALID_STRING

static

Definition at line 94 of file yocto_voltageoutput.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