com.apama.position.tracker.generic
Event GenericTrackerInterface


This interface allows the Generic Position Tracker to update/publish the position it is tracking, as well as querying information about this Generic Position Tracker instance.

This interface is similar to the com.apama.position.tracker.PositionTrackerManagerInterface interface, but with various actions overridden to provide more information specific to the Generic Position Tracker implementation

This interface should not be created directly by applications. Instead, this interface is created by the Generic Position Tracker Factory object (com.apama.position.tracker.generic.GenericPositionTrackerFactory) when a new Position Tracker has been registered with the Position Service.
See Also:
com.apama.position.tracker.generic.GenericPositionTrackerFactory - The user-level interface that is used to create an instance of the Generic Position Tracker Interface

Member summary
 action<> returns stringgetTrackerName

Helper action to return the name of the Position Tracker.
 action<> returns stringgetTrackerType

Helper action to return the type of the Position Tracker.
 action<> returns com.apama.position.tracker.PSTrackerManagerInterfacegetTrackerMgrIface

This action returns the underlying Position Tracker Manager interface that was returned by the Position Service when the Generic Position Tracker was registered.
 action<integer, com.apama.position.tracker.generic.SliceKeycom.apama.position.Position>updateAbsolutePosition

This action causes the cached position of the specified instance to be updated by an absolute position, and the update is then published to the set of publication contexts for that instance.
 action<integer, com.apama.position.tracker.generic.SliceKeycom.apama.position.Position>updateRelativePosition

This action causes the cached position of the specified instance to be updated by a relative position, and the update is then published to the set of publication contexts for that instance.
 action<integer, com.apama.position.tracker.generic.SliceKeycom.apama.position.Position>updateAbsolutePositionWithoutPublication

This action causes the cached position of the specified instance to be updated by an absolute position. This action is similar to the updateAbsolutePosition() action, but the position update is not published.
 action<integer, com.apama.position.tracker.generic.SliceKeycom.apama.position.Position>updateRelativePositionWithoutPublication

This action causes the cached position of the specified instance to be updated by a relative position. This action is similar to the updateRelativePosition() action, but the position update is not published.
 action<integer, com.apama.oms.OrderState> returns dictionary<string, string>getOrderUpdateExtraParams

This is a helper action to return a set of extra parameters based on the order that has caused a position to be updated.
 
Member detail

getOrderUpdateExtraParams

            action<integer, com.apama.oms.OrderState> returns dictionary<string, string> getOrderUpdateExtraParams
        
This is a helper action to return a set of extra parameters based on the order that has caused a position to be updated.


param subscriptionId The identifier of the subscription whose position should be updated
param orderMon The OrderState event object that caused a position update
return A dictionary containing the order state as a stringified set of parameters

getTrackerMgrIface

            action<> returns com.apama.position.tracker.PSTrackerManagerInterface getTrackerMgrIface
        
This action returns the underlying Position Tracker Manager interface that was returned by the Position Service when the Generic Position Tracker was registered.

This interface can be used to update/publish the position it is tracking, as well as querying information about this Generic Position Tracker instance.

return The Position Tracker Manager Interface object

getTrackerName

            action<> returns string getTrackerName
        
Helper action to return the name of the Position Tracker.

return The name of the Generic Position Tracker implementation that was created

getTrackerType

            action<> returns string getTrackerType
        
Helper action to return the type of the Position Tracker.

return The type of the Generic Position Tracker implementation that was created

updateAbsolutePosition

            action<integer, com.apama.position.tracker.generic.SliceKeycom.apama.position.PositionupdateAbsolutePosition
        
This action causes the cached position of the specified instance to be updated by an absolute position, and the update is then published to the set of publication contexts for that instance.


param subscriptionId The ID of the Position Tracker instance whose current position should be published
param position The Position object that the instance position should be updated to

updateAbsolutePositionWithoutPublication

            action<integer, com.apama.position.tracker.generic.SliceKeycom.apama.position.PositionupdateAbsolutePositionWithoutPublication
        
This action causes the cached position of the specified instance to be updated by an absolute position. This action is similar to the updateAbsolutePosition() action, but the position update is not published.


param subscriptionId The ID of the Position Tracker instance whose current position should be published
param position The Position object that the instance position should be updated to

updateRelativePosition

            action<integer, com.apama.position.tracker.generic.SliceKeycom.apama.position.PositionupdateRelativePosition
        
This action causes the cached position of the specified instance to be updated by a relative position, and the update is then published to the set of publication contexts for that instance.


param subscriptionId The ID of the Position Tracker instance whose current position should be published
param position The Position object that the instance position should be updated relative to

updateRelativePositionWithoutPublication

            action<integer, com.apama.position.tracker.generic.SliceKeycom.apama.position.PositionupdateRelativePositionWithoutPublication
        
This action causes the cached position of the specified instance to be updated by a relative position. This action is similar to the updateRelativePosition() action, but the position update is not published.


param subscriptionId The ID of the Position Tracker instance whose current position should be published
param position The Position object that the instance position should be updated relative to