Inheritance diagram for ExampleSourcePlugin:

Public Member Functions
	ExampleSourcePlugin (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 (

AsyncPropertyReply *	setProperty (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 &)

void	randomizeProperties ()

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.

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
AbstractRoutingEngine *	routingEngine
	routingEngine the core routing engine used to send property updates to sink plugins.

Member Function Documentation

void ExampleSourcePlugin::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

reply the reply variable.

See Also: AsyncPropertyReply

Implements AbstractSource.

PropertyInfo ExampleSourcePlugin::getPropertyInfo ( const VehicleProperty::Property & property )

inlinevirtual

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

property the property to get info for.

Returns: a PropertyInfo object.

Implements AbstractSource.

void ExampleSourcePlugin::getRangePropertyAsync ( AsyncRangePropertyReply * reply )

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

reply is the reply variable.

See Also: AsyncRangePropertyReply

Implements AbstractSource.

AsyncPropertyReply* ExampleSourcePlugin::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

request the requested property to set.

Returns: returns a pointer to the new value for the property.

See Also: AsyncPropertyReply

Implements AbstractSource.

void ExampleSourcePlugin::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

property the property that is being subscribed.