public class YDaisyChain extends YFunction
Modifier and Type | Class and Description |
---|---|
static interface |
YDaisyChain.TimedReportCallback
TimedReportCallback for DaisyChain
|
static interface |
YDaisyChain.UpdateCallback
Deprecated UpdateCallback for DaisyChain
|
Modifier and Type | Field and Description |
---|---|
protected int |
_childCount |
protected int |
_daisyState |
protected int |
_requiredChildCount |
protected YDaisyChain.UpdateCallback |
_valueCallbackDaisyChain |
static int |
CHILDCOUNT_INVALID
invalid childCount value
|
static int |
DAISYSTATE_CHILD_LOST |
static int |
DAISYSTATE_CHILD_MISSING |
static int |
DAISYSTATE_FIRMWARE_MISMATCH |
static int |
DAISYSTATE_INVALID |
static int |
DAISYSTATE_IS_CHILD |
static int |
DAISYSTATE_READY
invalid daisyState value
|
static int |
REQUIREDCHILDCOUNT_INVALID
invalid requiredChildCount value
|
_advertisedValue, _cacheExpiration, _className, _dataStreams, _func, _funId, _hwId, _lastErrorMsg, _lastErrorType, _logicalName, _serial, _userData, _valueCallbackFunction, _yapi, ADVERTISEDVALUE_INVALID, FUNCTIONDESCRIPTOR_INVALID, LOGICALNAME_INVALID
Modifier | Constructor and Description |
---|---|
protected |
YDaisyChain(String func) |
protected |
YDaisyChain(YAPIContext ctx,
String func) |
Modifier and Type | Method and Description |
---|---|
int |
_invokeValueCallback(String value) |
protected void |
_parseAttr(com.yoctopuce.YoctoAPI.YJSONObject json_val) |
static YDaisyChain |
FindDaisyChain(String func)
Retrieves a module chain for a given identifier.
|
static YDaisyChain |
FindDaisyChainInContext(YAPIContext yctx,
String func)
Retrieves a module chain for a given identifier in a YAPI context.
|
static YDaisyChain |
FirstDaisyChain()
Starts the enumeration of module chains currently accessible.
|
static YDaisyChain |
FirstDaisyChainInContext(YAPIContext yctx)
Starts the enumeration of module chains currently accessible.
|
int |
get_childCount()
Returns the number of child nodes currently detected.
|
int |
get_daisyState()
Returns the state of the daisy-link between modules.
|
int |
get_requiredChildCount()
Returns the number of child nodes expected in normal conditions.
|
int |
getChildCount()
Returns the number of child nodes currently detected.
|
int |
getDaisyState()
Returns the state of the daisy-link between modules.
|
int |
getRequiredChildCount()
Returns the number of child nodes expected in normal conditions.
|
YDaisyChain |
nextDaisyChain()
Continues the enumeration of module chains started using yFirstDaisyChain().
|
int |
registerValueCallback(YDaisyChain.UpdateCallback callback)
Registers the callback function that is invoked on every change of advertised value.
|
int |
set_requiredChildCount(int newval)
Changes the number of child nodes expected in normal conditions.
|
int |
setRequiredChildCount(int newval)
Changes the number of child nodes expected in normal conditions.
|
_AddToCache, _clearDataStreamCache, _download, _escapeAttr, _FindFromCache, _FindFromCacheInContext, _get_json_path_struct, _get_json_path, _json_get_array, _json_get_key, _json_get_string, _parse, _parserHelper, _setAttr, _throw, _UpdateTimedReportCallbackList, _UpdateValueCallbackList, _upload, _upload, _uploadEx, clearCache, describe, errMessage, errorMessage, errorType, errType, FindFunction, FindFunctionInContext, FirstFunction, FirstFunctionInContext, functionDescriptor, get_advertisedValue, get_errorMessage, get_errorType, get_friendlyName, get_functionDescriptor, get_functionId, get_hardwareId, get_logicalName, get_module, get_serialNumber, get_userData, getAdvertisedValue, getErrorMessage, getErrorType, getFriendlyName, getFunctionDescriptor, getFunctionId, getHardwareId, getLogicalName, getModule, getUserData, isOnline, isReadOnly, load, loadAttribute, module, muteValueCallbacks, nextFunction, registerValueCallback, set_advertisedValue, set_logicalName, set_userData, setLogicalName, setUserData, toString, unmuteValueCallbacks, userData
public static final int DAISYSTATE_READY
public static final int DAISYSTATE_IS_CHILD
public static final int DAISYSTATE_FIRMWARE_MISMATCH
public static final int DAISYSTATE_CHILD_MISSING
public static final int DAISYSTATE_CHILD_LOST
public static final int DAISYSTATE_INVALID
public static final int CHILDCOUNT_INVALID
public static final int REQUIREDCHILDCOUNT_INVALID
protected int _daisyState
protected int _childCount
protected int _requiredChildCount
protected YDaisyChain.UpdateCallback _valueCallbackDaisyChain
protected YDaisyChain(YAPIContext ctx, String func)
func
- : functionidprotected YDaisyChain(String func)
func
- : functionidprotected void _parseAttr(com.yoctopuce.YoctoAPI.YJSONObject json_val) throws Exception
_parseAttr
in class YFunction
Exception
public int get_daisyState() throws YAPI_Exception
YAPI_Exception
- on errorpublic int getDaisyState() throws YAPI_Exception
YAPI_Exception
- on errorpublic int get_childCount() throws YAPI_Exception
YAPI_Exception
- on errorpublic int getChildCount() throws YAPI_Exception
YAPI_Exception
- on errorpublic int get_requiredChildCount() throws YAPI_Exception
YAPI_Exception
- on errorpublic int getRequiredChildCount() throws YAPI_Exception
YAPI_Exception
- on errorpublic int set_requiredChildCount(int newval) throws YAPI_Exception
newval
- : an integer corresponding to the number of child nodes expected in normal conditionsYAPI_Exception
- on errorpublic int setRequiredChildCount(int newval) throws YAPI_Exception
newval
- : an integer corresponding to the number of child nodes expected in normal conditionsYAPI_Exception
- on errorpublic static YDaisyChain FindDaisyChain(String func)
func
- : a string that uniquely characterizes the module chain, for instance
MyDevice.daisyChain.public static YDaisyChain FindDaisyChainInContext(YAPIContext yctx, String func)
yctx
- : a YAPI contextfunc
- : a string that uniquely characterizes the module chain, for instance
MyDevice.daisyChain.public int registerValueCallback(YDaisyChain.UpdateCallback callback)
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.public int _invokeValueCallback(String value)
_invokeValueCallback
in class YFunction
public YDaisyChain nextDaisyChain()
public static YDaisyChain FirstDaisyChain()
public static YDaisyChain FirstDaisyChainInContext(YAPIContext yctx)
yctx
- : a YAPI context.Copyright © 2023. All rights reserved.