Raritan PX2/PX3 JSON-RPC API
LhxParameter.idl
1 #ifndef __LHXMODEL_PARAMETER_IDL__
2 #define __LHXMODEL_PARAMETER_IDL__
3 
4 #include <Event.idl>
5 
7 module lhxmodel {
8 
10  interface Parameter_2_0_1 {
11 
12  constant int ERR_INVALID_PARAMS = 1;
13  constant int ERR_READ_ONLY = 2;
14 
16  enumeration Unit {
17  NONE,
22  BAR,
26  VOLT,
31  TIME,
37  OHM,
40  LITERS_PER_HOUR
41  };
42 
44  structure Status {
45  boolean switchedOn;
46  boolean active;
47  boolean overflow;
48  boolean underflow;
49  boolean valid;
50  };
51 
53  structure MetaData {
55  string id;
56  double defaultValue;
57  double min;
58  double max;
59  boolean read_only;
60  int decDigits;
61  };
62 
64  structure Value {
65  time timestamp;
67  double value;
68  };
69 
71  valueobject MetaDataChangedEvent extends idl.Event {
72  MetaData oldMetaData;
74  };
75 
77  valueobject ValueChangedEvent extends idl.Event {
78  Value newValue;
79  };
80 
86  MetaData getMetaData();
87 
93  Value getValue();
94 
100  int getRawValue();
101 
112  int setRawValue(in int rawValue, in boolean validateRange);
113 
114  };
115 
116 }
117 
118 #endif /* !__LHXMODEL_PARAMETER_IDL__ */
Liters/minute.
Definition: LhxParameter.idl:39
Siemens.
Definition: LhxParameter.idl:24
Volt.
Definition: LhxParameter.idl:26
No unit.
Definition: LhxParameter.idl:17
boolean active
Active.
Definition: LhxParameter.idl:46
Newton.
Definition: LhxParameter.idl:33
double value
The value of the parameter.
Definition: LhxParameter.idl:67
Hours.
Definition: LhxParameter.idl:28
Percent.
Definition: LhxParameter.idl:38
string id
Parameter ID.
Definition: LhxParameter.idl:55
double min
Minimum value.
Definition: LhxParameter.idl:57
Absolute temperature.
Definition: LhxParameter.idl:20
Parameter Status.
Definition: LhxParameter.idl:44
boolean underflow
Underflow.
Definition: LhxParameter.idl:48
MetaData newMetaData
Metadata after change.
Definition: LhxParameter.idl:73
LHX Model.
Definition: Lhx.idl:9
LHX Parameter Interface.
Definition: LhxParameter.idl:10
Basic IDL definitions.
Definition: Event.idl:6
Relative temperature.
Definition: LhxParameter.idl:21
Unit
Parameter Unit.
Definition: LhxParameter.idl:16
Status status
The state of the parameter.
Definition: LhxParameter.idl:66
Unit unit
Parameter unit.
Definition: LhxParameter.idl:54
Relative humidity.
Definition: LhxParameter.idl:35
double defaultValue
Default value.
Definition: LhxParameter.idl:56
Parameter Metadata.
Definition: LhxParameter.idl:53
boolean read_only
true for read-only parameters
Definition: LhxParameter.idl:59
Meter.
Definition: LhxParameter.idl:25
Seconds.
Definition: LhxParameter.idl:30
Pascal.
Definition: LhxParameter.idl:23
Ampere.
Definition: LhxParameter.idl:27
Time.
Definition: LhxParameter.idl:31
boolean valid
Valid.
Definition: LhxParameter.idl:49
Minutes.
Definition: LhxParameter.idl:29
boolean overflow
Overflow.
Definition: LhxParameter.idl:47
time timestamp
Timestamp of last sample.
Definition: LhxParameter.idl:65
Parameter Value.
Definition: LhxParameter.idl:64
Binary.
Definition: LhxParameter.idl:19
Number.
Definition: LhxParameter.idl:18
Ohm.
Definition: LhxParameter.idl:37
Bar.
Definition: LhxParameter.idl:22
int decDigits
Number of decimal digits.
Definition: LhxParameter.idl:60
double max
Maximum value.
Definition: LhxParameter.idl:58
Gramms.
Definition: LhxParameter.idl:34
Hertz.
Definition: LhxParameter.idl:36
boolean switchedOn
LHX On / Off.
Definition: LhxParameter.idl:45
Meters/second.
Definition: LhxParameter.idl:32