automotive-message-broker  0.14.803
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
Public Member Functions | Friends | List of all members
WheelSourcePlugin Class Reference
Inheritance diagram for WheelSourcePlugin:
AbstractSource AbstractSink

Public Member Functions

 WheelSourcePlugin (AbstractRoutingEngine *re, map< string, string > config)
 
const string uuid ()
 Pure virtual methods:
 
void getPropertyAsync (AsyncPropertyReply *reply)
 pure virtual methods:
 
void getRangePropertyAsync (AsyncRangePropertyReply *reply)
 getRangePropertyAsync is called when a sink requests a series of values for a given property within a specified time or sequencial range. This will only be called if the source support the Ranged Operation (
 
AsyncPropertyReplysetProperty (AsyncSetPropertyRequest request)
 setProperty is called when a sink requests to set a value for a given property. This is only called if the source supports the Set Operation (
 
void subscribeToPropertyChanges (VehicleProperty::Property property)
 subscribeToPropertyChanges is called when a sink requests a subscription. Source plugins can keep track of subscriptions and may wish to sleep if there are no subscriptions.
 
void unsubscribeToPropertyChanges (VehicleProperty::Property property)
 unsubscribeToPropertyChanges is called when a sink requests to unsubscribe from a given property's changes.
 
PropertyList supported ()
 supported
 
int supportedOperations ()
 supportedOperations
 
void supportedChanged (const PropertyList &)
 
map< string, string > getConfiguration ()
 
PropertyInfo getPropertyInfo (const VehicleProperty::Property &property)
 getPropertyInfo used to return specific information about a property
 
- Public Member Functions inherited from AbstractSource
 AbstractSource (AbstractRoutingEngine *engine, map< string, string > config)
 
- Public Member Functions inherited from AbstractSink
 AbstractSink (AbstractRoutingEngine *engine, map< string, string > config)
 
virtual void propertyChanged (AbstractPropertyType *value)
 propertyChanged is called when a subscribed to property changes.
 

Friends

class WheelPrivate
 

Additional Inherited Members

- Public Types inherited from AbstractSource
enum  Operations { Get = 0x01, Set = 0x02, GetRanged = 0x04 }
 The Operations enum is a bitmask flag used to specify which operations are supported by the source plugin.
 
- Protected Attributes inherited from AbstractSource
AbstractRoutingEngineroutingEngine
 routingEngine the core routing engine used to send property updates to sink plugins.
 

Member Function Documentation

void WheelSourcePlugin::getPropertyAsync ( AsyncPropertyReply reply)
virtual

pure virtual methods:

getPropertyAsync is called when a sink requests the value for given property. This is only called if the source supports the Get operation (

See Also
Operation)
Parameters
replythe reply variable.
See Also
AsyncPropertyReply

Implements AbstractSource.

PropertyInfo WheelSourcePlugin::getPropertyInfo ( const VehicleProperty::Property &  property)
virtual

getPropertyInfo used to return specific information about a property

See Also
PropertyInfo the source should override this otherwise a PropertyInfo::invalid() will be returned for the property
Parameters
propertythe property to get info for.
Returns
a PropertyInfo object.

Implements AbstractSource.

void WheelSourcePlugin::getRangePropertyAsync ( AsyncRangePropertyReply reply)
inlinevirtual

getRangePropertyAsync is called when a sink requests a series of values for a given property within a specified time or sequencial range. This will only be called if the source support the Ranged Operation (

See Also
Operations)
Parameters
replyis the reply variable.
See Also
AsyncRangePropertyReply

Implements AbstractSource.

AsyncPropertyReply* WheelSourcePlugin::setProperty ( AsyncSetPropertyRequest  request)
virtual

setProperty is called when a sink requests to set a value for a given property. This is only called if the source supports the Set Operation (

See Also
Operation)
Parameters
requestthe requested property to set.
Returns
returns a pointer to the new value for the property.
See Also
AsyncPropertyReply

Implements AbstractSource.

void WheelSourcePlugin::subscribeToPropertyChanges ( VehicleProperty::Property  property)
virtual

subscribeToPropertyChanges is called when a sink requests a subscription. Source plugins can keep track of subscriptions and may wish to sleep if there are no subscriptions.

Parameters
propertythe property that is being subscribed.
See Also
unsubscribeToPropertyChanges

Implements AbstractSource.

PropertyList WheelSourcePlugin::supported ( )
virtual

supported

Returns
returns the supported properties.

Implements AbstractSource.

void WheelSourcePlugin::supportedChanged ( const PropertyList &  supportedProperties)
inlinevirtual

supportedChanged() is called when the supported properties changes

  • supportedProperties the new list of supported properties.

Implements AbstractSink.

int WheelSourcePlugin::supportedOperations ( )
virtual

supportedOperations

Returns
returns the supported operations.
See Also
Operations

Implements AbstractSource.

void WheelSourcePlugin::unsubscribeToPropertyChanges ( VehicleProperty::Property  property)
virtual

unsubscribeToPropertyChanges is called when a sink requests to unsubscribe from a given property's changes.

Parameters
propertythe property to unsubscribe to
See Also
subscribeToPropertyChanges

Implements AbstractSource.

const string WheelSourcePlugin::uuid ( )
virtual

Pure virtual methods:

uuid() is a unique identifier

Returns
a guid-style unique identifier

Implements AbstractSink.


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