com.apama.position
Event SubscriptionDetails


This event contains all the details of the subscription request that was made by the Position Service Interface.

This is information is returned when a subscription is made, and can also be requested at any point by querying the Position Service Interface.
See Also:
com.apama.position.PSInterface - The user-level interface that can be used to subscribe/unsubscribe and query the Position Service

Member summary
 stringtrackerName

The name of the Position Tracker that was subscribed to.
 stringtrackerType

The type of the Position Tracker that was subscribed to.
 com.apama.position.PositionConfigParamsconfig

A PositionConfigParams object containing any subscription configuration that was used.
 contexttrackerContext

The context of the Position Tracker that was subscribed to.
 integerrefCount

A reference count of how many subscriptions have been made to this specific Position Tracker instance.
 com.apama.position.PositioncurrentPosition

The current position for this subscription.
 
Action summary
 com.apama.position.PositionConfigParamsgetConfig()

Helper action to return the dictionary containing all the configuration information that was used to subscribe to the Position Service.
 com.apama.position.PositiongetPosition()

Helper action to return the current position for this subscription.
 stringgetTrackerName()

Helper action to return the name of the Position Tracker.
 stringgetTrackerType()

Helper action to return the type of the Position Tracker.
 
Member detail

config

            com.apama.position.PositionConfigParams config
        
A PositionConfigParams object containing any subscription configuration that was used.

currentPosition

            com.apama.position.Position currentPosition
        
The current position for this subscription.

refCount

            integer refCount
        
A reference count of how many subscriptions have been made to this specific Position Tracker instance.

trackerContext

            context trackerContext
        
The context of the Position Tracker that was subscribed to.

trackerName

            string trackerName
        
The name of the Position Tracker that was subscribed to.

trackerType

            string trackerType
        
The type of the Position Tracker that was subscribed to.
Action detail

getConfig

            com.apama.position.PositionConfigParams getConfig()
        
Helper action to return the dictionary containing all the configuration information that was used to subscribe to the Position Service.
Returns:
A PositionConfigParams object containing all the configuration information that was used to subscribe to the Position Service.

getPosition

            com.apama.position.Position getPosition()
        
Helper action to return the current position for this subscription.
Returns:
A Position object containing the current position for this subscription

getTrackerName

            string getTrackerName()
        
Helper action to return the name of the Position Tracker.
Returns:
The name of the Position Tracker that was subscribed to

getTrackerType

            string getTrackerType()
        
Helper action to return the type of the Position Tracker.
Returns:
The type of the Position Tracker that was subscribed to