automotive-message-broker  0.14.0
Public Member Functions | Public Attributes | List of all members
AsyncRangePropertyReply Class Reference

The AsyncRangePropertyReply class is used by a source to reply to an AsyncRangePropertyRequest. The source should set success to 'true' and populate the 'values' member if the request was successful. If the request is not successful, 'success' should be set to 'false' and the 'error' member should be set. More...

#include <abstractroutingengine.h>

Inheritance diagram for AsyncRangePropertyReply:
Inheritance graph
[legend]
Collaboration diagram for AsyncRangePropertyReply:
Collaboration graph
[legend]

Public Member Functions

 AsyncRangePropertyReply (AsyncRangePropertyRequest request)
 
- Public Member Functions inherited from AsyncRangePropertyRequest
 AsyncRangePropertyRequest (const AsyncRangePropertyRequest &request)
 

Public Attributes

AsyncPropertyReply::Error error
 error this is set if there was an error in the request. "success" will also be set to false.
 
std::list< AbstractPropertyType * > values
 values if the request was successful, this will contain a list of values meeting the criteria of the request.
 
bool success
 success this will be true if the request was successful. If not, this is false and error is set.
 
- Public Attributes inherited from AsyncRangePropertyRequest
PropertyList properties
 properties list of properties to request
 
std::string sourceUuid
 sourceUuid if the sink wishes to request a specific source, this should be set to the uuid of the source.
 
Zone::Type zone
 zone if the sink wishes to request a specific zone, this should be set to the desired zone .
 
GetRangedPropertyCompletedSignal completed
 completed callback 'completed' is called when the ranged request is complete. The reply from this request is passed into the completed call. The completed callback must free the reply before it returns or there will be a leak.
 
double timeBegin
 timeBegin Set this to request values for the specified property beggining at this time. Time is seconds\ since the unix epoc. Set this to '0' if you do not want values within a time range.
 
double timeEnd
 timeEnd Set this to request values for the specified property beggining at this time. Time is seconds\ since the unix epoc. Set this to '0' if you do not want values within a time range.
 
int32_t sequenceBegin
 sequenceBegin set this to request values with a sequence >= to the sequenceBegin value. Set to -1 if you don't want values within a sequence ranges.
 
int32_t sequenceEnd
 sequenceEnd set this to request values with a sequence <= to the sequenceEnd value. Set to -1 if you don't want values within a sequence ranges.
 
std::string pid
 pid requesting process id
 

Detailed Description

The AsyncRangePropertyReply class is used by a source to reply to an AsyncRangePropertyRequest. The source should set success to 'true' and populate the 'values' member if the request was successful. If the request is not successful, 'success' should be set to 'false' and the 'error' member should be set.

Examples:
/home/kev/src/automotive-message-broker/lib/abstractroutingengine.h.

The documentation for this class was generated from the following file: