automotive-message-broker  0.12
 All Classes Functions Variables Typedefs Enumerations Enumerator Pages
Public Types | Public Member Functions | Protected Attributes | List of all members
AbstractSource Class Referenceabstract
Inheritance diagram for AbstractSource:
AbstractSink

Public Types

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.
 

Public Member Functions

 AbstractSource (AbstractRoutingEngine *engine, map< string, string > config)
 
virtual void getPropertyAsync (AsyncPropertyReply *reply)=0
 pure virtual methods: More...
 
virtual void getRangePropertyAsync (AsyncRangePropertyReply *reply)=0
 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 ( More...
 
virtual AsyncPropertyReplysetProperty (AsyncSetPropertyRequest request)=0
 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 ( More...
 
virtual void subscribeToPropertyChanges (VehicleProperty::Property property)=0
 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. More...
 
virtual void unsubscribeToPropertyChanges (VehicleProperty::Property property)=0
 unsubscribeToPropertyChanges is called when a sink requests to unsubscribe from a given property's changes. More...
 
virtual int supportedOperations ()=0
 supportedOperations More...
 
virtual PropertyInfo getPropertyInfo (const VehicleProperty::Property &property)
 getPropertyInfo used to return specific information about a property More...
 
virtual PropertyList supported ()=0
 supported More...
 
- Public Member Functions inherited from AbstractSink
 AbstractSink (AbstractRoutingEngine *engine, map< string, string > config)
 
virtual const string uuid ()=0
 Pure virtual methods: More...
 
virtual void propertyChanged (AbstractPropertyType *value)
 propertyChanged is called when a subscribed to property changes. More...
 
virtual void supportedChanged (const PropertyList &supportedProperties)=0
 

Protected Attributes

AbstractRoutingEngineroutingEngine
 routingEngine the core routing engine used to send property updates to sink plugins. More...
 
- Protected Attributes inherited from AbstractSink
AbstractRoutingEngineroutingEngine
 routingEngine is the core of AMB. It is used to pass plugin and property information to other plugins
 
map< string, string > configuration
 

Member Function Documentation

virtual void AbstractSource::getPropertyAsync ( AsyncPropertyReply reply)
pure 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
PropertyInfo AbstractSource::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.
virtual void AbstractSource::getRangePropertyAsync ( AsyncRangePropertyReply reply)
pure virtual

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
virtual AsyncPropertyReply* AbstractSource::setProperty ( AsyncSetPropertyRequest  request)
pure 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
virtual void AbstractSource::subscribeToPropertyChanges ( VehicleProperty::Property  property)
pure 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
virtual PropertyList AbstractSource::supported ( )
pure virtual

supported

Returns
returns the supported properties.
virtual int AbstractSource::supportedOperations ( )
pure virtual

supportedOperations

Returns
returns the supported operations.
See Also
Operations
virtual void AbstractSource::unsubscribeToPropertyChanges ( VehicleProperty::Property  property)
pure 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

Member Data Documentation

AbstractRoutingEngine* AbstractSource::routingEngine
protected

routingEngine the core routing engine used to send property updates to sink plugins.

See Also
AbstractRoutingEngine

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