Go to the source code of this file.
Classes | |
| class | YMultiCellWeighScale |
Macros | |
| #define | _Y_EXCITATION_ENUM |
| #define | Y_CELLCOUNT_INVALID (YAPI_INVALID_UINT) |
| #define | Y_COMMAND_INVALID (YAPI_INVALID_STRING) |
| #define | Y_COMPENSATION_INVALID (YAPI_INVALID_DOUBLE) |
| #define | Y_COMPTEMPADAPTRATIO_INVALID (YAPI_INVALID_DOUBLE) |
| #define | Y_COMPTEMPAVG_INVALID (YAPI_INVALID_DOUBLE) |
| #define | Y_COMPTEMPCHG_INVALID (YAPI_INVALID_DOUBLE) |
| #define | Y_ZEROTRACKING_INVALID (YAPI_INVALID_DOUBLE) |
Typedefs | |
| typedef void(* | YMultiCellWeighScaleTimedReportCallback) (YMultiCellWeighScale *func, YMeasure measure) |
| typedef void(* | YMultiCellWeighScaleValueCallback) (YMultiCellWeighScale *func, const string &functionValue) |
Enumerations | |
| enum | Y_EXCITATION_enum { Y_EXCITATION_OFF = 0, Y_EXCITATION_DC = 1, Y_EXCITATION_AC = 2, Y_EXCITATION_INVALID = -1, Y_EXCITATION_OFF = 0, Y_EXCITATION_DC = 1, Y_EXCITATION_AC = 2, Y_EXCITATION_INVALID = -1 } |
Functions | |
| YMultiCellWeighScale * | yFindMultiCellWeighScale (const string &func) |
| YMultiCellWeighScale * | yFirstMultiCellWeighScale (void) |
Macro Definition Documentation
| #define _Y_EXCITATION_ENUM |
Definition at line 58 of file yocto_multicellweighscale.h.
| #define Y_CELLCOUNT_INVALID (YAPI_INVALID_UINT) |
Definition at line 66 of file yocto_multicellweighscale.h.
| #define Y_COMMAND_INVALID (YAPI_INVALID_STRING) |
Definition at line 72 of file yocto_multicellweighscale.h.
| #define Y_COMPENSATION_INVALID (YAPI_INVALID_DOUBLE) |
Definition at line 70 of file yocto_multicellweighscale.h.
| #define Y_COMPTEMPADAPTRATIO_INVALID (YAPI_INVALID_DOUBLE) |
Definition at line 67 of file yocto_multicellweighscale.h.
| #define Y_COMPTEMPAVG_INVALID (YAPI_INVALID_DOUBLE) |
Definition at line 68 of file yocto_multicellweighscale.h.
| #define Y_COMPTEMPCHG_INVALID (YAPI_INVALID_DOUBLE) |
Definition at line 69 of file yocto_multicellweighscale.h.
| #define Y_ZEROTRACKING_INVALID (YAPI_INVALID_DOUBLE) |
Definition at line 71 of file yocto_multicellweighscale.h.
Typedef Documentation
| typedef void(* YMultiCellWeighScaleTimedReportCallback) (YMultiCellWeighScale *func, YMeasure measure) |
Definition at line 56 of file yocto_multicellweighscale.h.
| typedef void(* YMultiCellWeighScaleValueCallback) (YMultiCellWeighScale *func, const string &functionValue) |
Definition at line 54 of file yocto_multicellweighscale.h.
Enumeration Type Documentation
| enum Y_EXCITATION_enum |
| Enumerator | |
|---|---|
| Y_EXCITATION_OFF | |
| Y_EXCITATION_DC | |
| Y_EXCITATION_AC | |
| Y_EXCITATION_INVALID | |
| Y_EXCITATION_OFF | |
| Y_EXCITATION_DC | |
| Y_EXCITATION_AC | |
| Y_EXCITATION_INVALID | |
Definition at line 59 of file yocto_multicellweighscale.h.
Function Documentation
|
inline |
Retrieves a multi-cell weighing scale sensor 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 multi-cell weighing scale sensor is online at the time it is invoked. The returned object is nevertheless valid. Use the method YMultiCellWeighScale.isOnline() to test if the multi-cell weighing scale sensor is indeed online at a given time. In case of ambiguity when looking for a multi-cell weighing scale sensor 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 multi-cell weighing scale sensor
- Returns
- a YMultiCellWeighScale object allowing you to drive the multi-cell weighing scale sensor.
Definition at line 447 of file yocto_multicellweighscale.h.
|
inline |
Starts the enumeration of multi-cell weighing scale sensors currently accessible. Use the method YMultiCellWeighScale.nextMultiCellWeighScale() to iterate on next multi-cell weighing scale sensors.
- Returns
- a pointer to a YMultiCellWeighScale object, corresponding to the first multi-cell weighing scale sensor currently online, or a NULL pointer if there are none.
Definition at line 458 of file yocto_multicellweighscale.h.