knx
ETS configurable knx-stack
|
This class represents a single group object. More...
#include <group_object.h>
Public Member Functions | |
GroupObject () | |
The constructor. More... | |
GroupObject (const GroupObject &other) | |
The copy constructor. More... | |
virtual | ~GroupObject () |
The destructor. More... | |
bool | responseUpdateEnable () |
Check if the update flag (U) was set. More... | |
bool | transmitEnable () |
Check if the transmit flag (T) was set. More... | |
bool | valueReadOnInit () |
Check if the initialisation flag (I) was set. More... | |
bool | writeEnable () |
Check if the write flag (W) was set. More... | |
bool | readEnable () |
Check if the read flag (R) was set. More... | |
bool | communicationEnable () |
Check if the communication flag (C) was set. More... | |
Priority | priority () |
Get the priority of the group object. More... | |
ComFlag | commFlag () |
Return the current state of the group object. More... | |
void | commFlag (ComFlag value) |
Set the current state of the group object. More... | |
void | requestObjectRead () |
Request the read of a communication object. More... | |
void | objectWritten () |
Mark a communication object as written. More... | |
size_t | valueSize () |
returns the size of the group object in Byte. More... | |
size_t | sizeInTelegram () |
returns the size of the group object in Byte as it is in a telegram. More... | |
uint8_t * | valueRef () |
returns the pointer to the value of the group object. More... | |
uint16_t | asap () |
returns the Application Service Access Point of the group object. More... | |
void | callback (GroupObjectUpdatedHandler handler) |
register a callback for this group object. More... | |
GroupObjectUpdatedHandler | callback () |
returns the registered callback More... | |
KNXValue | value (const Dpt &type) |
return the current value of the group object. More... | |
void | value (const KNXValue &value, const Dpt &type) |
set the current value of the group object and changes the state of the group object to WriteRequest. More... | |
void | valueNoSend (const KNXValue &value, const Dpt &type) |
set the current value of the group object. More... | |
bool | tryValue (KNXValue &value, const Dpt &type) |
set the current value of the group object. More... | |
KNXValue | value () |
return the current value of the group object. More... | |
void | value (const KNXValue &value) |
set the current value of the group object and changes the state of the group object to WriteRequest. More... | |
void | valueNoSend (const KNXValue &value) |
set the current value of the group object. More... | |
bool | tryValue (KNXValue &value) |
set the current value of the group object. More... | |
Dpt | dataPointType () |
returns the currently configured datapoint type. More... | |
void | dataPointType (Dpt value) |
sets the datapoint type of the group object. More... | |
Friends | |
class | GroupObjectTableObject |
This class represents a single group object.
In german they are called "Kommunikationsobjekt" or "KO".
Definition at line 41 of file group_object.h.
GroupObject::GroupObject | ( | ) |
The constructor.
Definition at line 12 of file group_object.cpp.
GroupObject::GroupObject | ( | const GroupObject & | other | ) |
The copy constructor.
Definition at line 22 of file group_object.cpp.
|
virtual |
The destructor.
Definition at line 34 of file group_object.cpp.
uint16_t GroupObject::asap | ( | ) |
returns the Application Service Access Point of the group object.
In reality this is just the number of the group object. (in german "KO-Nr")
Definition at line 106 of file group_object.cpp.
GroupObjectUpdatedHandler GroupObject::callback | ( | ) |
returns the registered callback
Definition at line 213 of file group_object.cpp.
void GroupObject::callback | ( | GroupObjectUpdatedHandler | handler | ) |
register a callback for this group object.
The registered callback will be called if the group object was changed from the bus.
Definition at line 207 of file group_object.cpp.
ComFlag GroupObject::commFlag | ( | ) |
Return the current state of the group object.
See ComFlag
Definition at line 158 of file group_object.cpp.
void GroupObject::commFlag | ( | ComFlag | value | ) |
Set the current state of the group object.
Application code should only use this to set the state to Ok after reading a Updated to mark the changed group object as processed. This is optional.
Definition at line 163 of file group_object.cpp.
bool GroupObject::communicationEnable | ( | ) |
Check if the communication flag (C) was set.
(K-flag in german)
Definition at line 84 of file group_object.cpp.
Dpt GroupObject::dataPointType | ( | ) |
returns the currently configured datapoint type.
Definition at line 245 of file group_object.cpp.
void GroupObject::dataPointType | ( | Dpt | value | ) |
sets the datapoint type of the group object.
Definition at line 239 of file group_object.cpp.
void GroupObject::objectWritten | ( | ) |
Mark a communication object as written.
Calling this function triggers the sending of a write-group-value telegram.
This sets the state of the group object to WriteRequest
Definition at line 173 of file group_object.cpp.
Priority GroupObject::priority | ( | ) |
Get the priority of the group object.
Definition at line 93 of file group_object.cpp.
bool GroupObject::readEnable | ( | ) |
Check if the read flag (R) was set.
(L-flag in german)
Definition at line 72 of file group_object.cpp.
void GroupObject::requestObjectRead | ( | ) |
Request the read of a communication object.
Calling this function triggers the sending of a read-group-value telegram, to read the value of the communication object from the bus.
When the answer is received, the communication object's value will be updated.
This sets the state of the group objecte to ReadRequest
Definition at line 168 of file group_object.cpp.
bool GroupObject::responseUpdateEnable | ( | ) |
Check if the update flag (U) was set.
(A-flag in german)
Definition at line 40 of file group_object.cpp.
size_t GroupObject::sizeInTelegram | ( | ) |
returns the size of the group object in Byte as it is in a telegram.
For Group objects with size smaller than 1 byte (for example Dpt 1) this method will return 0.
Definition at line 183 of file group_object.cpp.
bool GroupObject::transmitEnable | ( | ) |
Check if the transmit flag (T) was set.
(UE-flag in german)
Definition at line 48 of file group_object.cpp.
bool GroupObject::tryValue | ( | KNXValue & | value | ) |
set the current value of the group object.
value | the value the group object is set to |
The parameters must fit the group object and dhe datapoint type must be set with dataPointType(). Otherwise it will stay unchanged.
Definition at line 251 of file group_object.cpp.
set the current value of the group object.
value | the value the group object is set to |
type | the datapoint type used for the conversion. |
The parameters must fit the group object. Otherwise it will stay unchanged.
Definition at line 233 of file group_object.cpp.
KNXValue GroupObject::value | ( | ) |
return the current value of the group object.
The datapoint type must be set with dataPointType(). Otherwise the returned value is invalid.
Definition at line 263 of file group_object.cpp.
return the current value of the group object.
type | the datapoint type used for the conversion. If this doesn't fit to the group object the returned value is invalid. |
Definition at line 226 of file group_object.cpp.
void GroupObject::value | ( | const KNXValue & | value | ) |
set the current value of the group object and changes the state of the group object to WriteRequest.
value | the value the group object is set to |
The parameters must fit the group object and dhe datapoint type must be set with dataPointType(). Otherwise it will stay unchanged.
Definition at line 257 of file group_object.cpp.
set the current value of the group object and changes the state of the group object to WriteRequest.
value | the value the group object is set to |
type | the datapoint type used for the conversion. |
The parameters must fit the group object. Otherwise it will stay unchanged.
Definition at line 219 of file group_object.cpp.
void GroupObject::valueNoSend | ( | const KNXValue & | value | ) |
set the current value of the group object.
value | the value the group object is set to |
The parameters must fit the group object and dhe datapoint type must be set with dataPointType(). Otherwise it will stay unchanged.
Definition at line 269 of file group_object.cpp.
set the current value of the group object.
value | the value the group object is set to |
type | the datapoint type used for the conversion. |
The parameters must fit the group object. Otherwise it will stay unchanged.
Definition at line 275 of file group_object.cpp.
bool GroupObject::valueReadOnInit | ( | ) |
Check if the initialisation flag (I) was set.
Definition at line 56 of file group_object.cpp.
uint8_t * GroupObject::valueRef | ( | ) |
returns the pointer to the value of the group object.
This can be used if a datapoint type is not supported or if you want do your own conversion.
Definition at line 101 of file group_object.cpp.
size_t GroupObject::valueSize | ( | ) |
returns the size of the group object in Byte.
For Group objects with size smaller than 1 byte (for example Dpt 1) this method will return 1.
Definition at line 178 of file group_object.cpp.
bool GroupObject::writeEnable | ( | ) |
Check if the write flag (W) was set.
(S-flag in german)
Definition at line 64 of file group_object.cpp.
|
friend |
Definition at line 43 of file group_object.h.