Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
M2MReportHandler Class Reference
#include <m2mreporthandler.h>
Inherits M2MTimerObserver.
Public Types | |
| enum | |
Enum defining which write attributes are set. More... | |
Public Member Functions | |
| virtual | ~M2MReportHandler () |
| Destructor. | |
| void | set_under_observation (bool observed) |
| Sets that object is under observation. | |
| void | set_value (float value) |
| Sets the value of the given resource. | |
| void | set_notification_trigger (uint16_t obj_instance_id=0) |
| Sets notification trigger. | |
| bool | parse_notification_attribute (const char *query, M2MBase::BaseType type, M2MResourceInstance::ResourceType resource_type=M2MResourceInstance::OPAQUE) |
| Parses the received query for notification attribute. | |
| void | set_default_values () |
| Set back to default values. | |
| uint8_t | attribute_flags () const |
| Return write attribute flags. | |
| void | set_observation_token (const uint8_t *token, const uint8_t length) |
| Sets the observation token value. | |
| void | get_observation_token (uint8_t *token, uint8_t &token_length) const |
| Provides a copy of the observation token of the object. | |
| uint16_t | observation_number () const |
| Returns the observation number. | |
| void | add_observation_level (M2MBase::Observation obs_level) |
| Adds the observation level for the object. | |
| void | remove_observation_level (M2MBase::Observation obs_level) |
| Removes the observation level for the object. | |
| M2MBase::Observation | observation_level () const |
| Returns the observation level of the object. | |
| bool | is_under_observation () const |
| Returns whether this resource is under observation or not. | |
Detailed Description
This class is handles all the observation related operations.
Definition at line 37 of file m2mreporthandler.h.
Member Enumeration Documentation
| anonymous enum |
Enum defining which write attributes are set.
Definition at line 52 of file m2mreporthandler.h.
Constructor & Destructor Documentation
| ~M2MReportHandler | ( | ) | [virtual] |
Destructor.
Definition at line 57 of file m2mreporthandler.cpp.
Member Function Documentation
| void add_observation_level | ( | M2MBase::Observation | obs_level ) |
Adds the observation level for the object.
- Parameters:
-
observation_level The level of observation.
Definition at line 521 of file m2mreporthandler.cpp.
| uint8_t attribute_flags | ( | ) | const |
Return write attribute flags.
Definition at line 491 of file m2mreporthandler.cpp.
| void get_observation_token | ( | uint8_t * | token, |
| uint8_t & | token_length | ||
| ) | const |
Provides a copy of the observation token of the object.
- Parameters:
-
value[OUT] A pointer to the value of the token. value_length[OUT] The length of the token pointer.
Definition at line 510 of file m2mreporthandler.cpp.
| bool is_under_observation | ( | ) | const |
Returns whether this resource is under observation or not.
- Returns:
- True if the resource is under observation, else false,
Definition at line 536 of file m2mreporthandler.cpp.
| M2MBase::Observation observation_level | ( | ) | const |
Returns the observation level of the object.
- Returns:
- The observation level of the object.
Definition at line 531 of file m2mreporthandler.cpp.
| uint16_t observation_number | ( | ) | const |
Returns the observation number.
- Returns:
- The observation number of the object.
Definition at line 516 of file m2mreporthandler.cpp.
| bool parse_notification_attribute | ( | const char * | query, |
| M2MBase::BaseType | type, | ||
| M2MResourceInstance::ResourceType | resource_type = M2MResourceInstance::OPAQUE |
||
| ) |
Parses the received query for notification attribute.
- Parameters:
-
query Query to be parsed for attributes. type Type of the Base Object. resource_type Type of the Resource.
- Returns:
- true if required attributes are present else false.
Definition at line 126 of file m2mreporthandler.cpp.
| void remove_observation_level | ( | M2MBase::Observation | obs_level ) |
Removes the observation level for the object.
- Parameters:
-
observation_level The level of observation.
Definition at line 526 of file m2mreporthandler.cpp.
| void set_default_values | ( | ) |
Set back to default values.
Definition at line 399 of file m2mreporthandler.cpp.
| void set_notification_trigger | ( | uint16_t | obj_instance_id = 0 ) |
Sets notification trigger.
- Parameters:
-
obj_instance_id,Object instance id that has changed
Definition at line 104 of file m2mreporthandler.cpp.
| void set_observation_token | ( | const uint8_t * | token, |
| const uint8_t | length | ||
| ) |
Sets the observation token value.
- Parameters:
-
token A pointer to the token of the resource. length The length of the token pointer.
Definition at line 496 of file m2mreporthandler.cpp.
| void set_under_observation | ( | bool | observed ) |
Sets that object is under observation.
- Parameters:
-
Value for the observation. handler,Handler object for sending observation callbacks.
Definition at line 63 of file m2mreporthandler.cpp.
| void set_value | ( | float | value ) |
Sets the value of the given resource.
- Parameters:
-
value,Value of the observed resource.
Definition at line 78 of file m2mreporthandler.cpp.
Generated on Tue Jul 12 2022 19:01:39 by
1.7.2