com.apama.position
Event PositionConfigParams


The Position Config Parameter event object is used to provide configuration when creating the Position Service Interface and when subscribing to the Position Service.

This configuration event object is also used when making a request to adjust the position of a subscription too.

As the configuration is stored in a dictionary, various actions are provided to get the configuration value back as a primitive data type and/or a subset of reference data types.
Member summary
 dictionary<string, string>config

A dictionary of configuration parameter names, and their corresponding value (as a string) to be passed to the Position Tracker implementation on subscription.
 dictionary<string, context>configCtxs

A dictionary of configuration parameter names, and the corresponding context information to be passed to the Position Tracker implementation on subscription.
 
Action summary
 voidaddContextParam(string paramName, context paramValue)

This function adds a parameter name and its corresponding context value to the list of configuration parameters.
 voidaddParam(string paramName, string paramValue)

This function adds a parameter name and its corresponding value (as a string) to the list of configuration parameters.
 booleangetBooleanParameter(string paramName)

This function gets the value of a specified parameter name as a boolean type that has been added to this list of configuration parameters.
 contextgetContextParam(string paramName)

This function gets the value of a specified parameter name as a context type that has been added to this list of configuration parameters.
 decimalgetDecimalParameter(string paramName)

This function gets the value of a specified parameter name as a decimal type that has been added to this list of configuration parameters.
 floatgetFloatParameter(string paramName)

This function gets the value of a specified parameter name as a float type that has been added to this list of configuration parameters.
 integergetIntegerParameter(string paramName)

This function gets the value of a specified parameter name as a integer type that has been added to this list of configuration parameters.
 stringgetParam(string paramName)

This function gets the value of a specified parameter name as a string type that has been added to this list of configuration parameters.
 stringgetStringParameter(string paramName)

This function gets the value of a specified parameter name as a string type that has been added to this list of configuration parameters.
 sequence<string>getStringSequenceParameter(string paramName)

This function gets the value of a specified parameter name as a sequence<string> type that has been added to this list of configuration parameters.
 booleanhasParam(string paramName)

This function allows the user to check whether the specified parameter name has been added to this list of configuration parameters.
 voidremoveParam(string paramName)

This function removes the specified parameter name from the list of configuration parameters.
 
Member detail

config

            dictionary<string, string> config
        
A dictionary of configuration parameter names, and their corresponding value (as a string) to be passed to the Position Tracker implementation on subscription.

configCtxs

            dictionary<string, context> configCtxs
        
A dictionary of configuration parameter names, and the corresponding context information to be passed to the Position Tracker implementation on subscription.
Action detail

addContextParam

            void addContextParam(string paramName, context paramValue)
        
This function adds a parameter name and its corresponding context value to the list of configuration parameters.

If the parameter name already exists, it will be overwritten with this new value. An error will be logged if the parameter name was already used by a non-context type.
Parameters:
paramName - The name of the parameter to add to the list of configuration parameters
paramValue - The context value of the parameter to be added to the list

addParam

            void addParam(string paramName, string paramValue)
        
This function adds a parameter name and its corresponding value (as a string) to the list of configuration parameters.

If the parameter name already exists, it will be overwritten with this new value. An error will be logged if the parameter name was already used by a context type.
Parameters:
paramName - The name of the parameter to add to the list of configuration parameters
paramValue - The value (as a string) of the parameter to be added to the list

getBooleanParameter

            boolean getBooleanParameter(string paramName)
        
This function gets the value of a specified parameter name as a boolean type that has been added to this list of configuration parameters.
Parameters:
paramName - The name of the parameter to get the value for from the list
Returns:
The context if it has been added, or false if the parameter has not been added to the list

getContextParam

            context getContextParam(string paramName)
        
This function gets the value of a specified parameter name as a context type that has been added to this list of configuration parameters.
Parameters:
paramName - The name of the parameter to get the value for from the list
Returns:
The context if it has been added, or a default context if the parameter has not been added to the list

getDecimalParameter

            decimal getDecimalParameter(string paramName)
        
This function gets the value of a specified parameter name as a decimal type that has been added to this list of configuration parameters.
Parameters:
paramName - The name of the parameter to get the value for from the list
Returns:
The context if it has been added, or a value of 0.0d if the parameter has not been added to the list

getFloatParameter

            float getFloatParameter(string paramName)
        
This function gets the value of a specified parameter name as a float type that has been added to this list of configuration parameters.
Parameters:
paramName - The name of the parameter to get the value for from the list
Returns:
The context if it has been added, or a value of 0.0 if the parameter has not been added to the list

getIntegerParameter

            integer getIntegerParameter(string paramName)
        
This function gets the value of a specified parameter name as a integer type that has been added to this list of configuration parameters.
Parameters:
paramName - The name of the parameter to get the value for from the list
Returns:
The context if it has been added, or -1 if the parameter has not been added to the list

getParam

            string getParam(string paramName)
        
This function gets the value of a specified parameter name as a string type that has been added to this list of configuration parameters.
Parameters:
paramName - The name of the parameter to get the value for from the list
Returns:
The value (as a string) if it has been added, or an empty string if the parameter has not been added to the list

getStringParameter

            string getStringParameter(string paramName)
        
This function gets the value of a specified parameter name as a string type that has been added to this list of configuration parameters.
Parameters:
paramName - The name of the parameter to get the value for from the list
Returns:
The context if it has been added, or an empty string if the parameter has not been added to the list

getStringSequenceParameter

            sequence<string> getStringSequenceParameter(string paramName)
        
This function gets the value of a specified parameter name as a sequence<string> type that has been added to this list of configuration parameters.
Parameters:
paramName - The name of the parameter to get the value for from the list
Returns:
The sequence if it has been added, or an empty sequence if the parameter has not been added to the list

hasParam

            boolean hasParam(string paramName)
        
This function allows the user to check whether the specified parameter name has been added to this list of configuration parameters.
Parameters:
paramName - The name of the parameter to check has been added to the list
Returns:
true if the configuration parameter exists, false otherwise

removeParam

            void removeParam(string paramName)
        
This function removes the specified parameter name from the list of configuration parameters.
Parameters:
paramName - The name of the parameter to be removed from the list of configuration parameters