com.apama.md.symbol
Event SymbolConversionTableInterface


The Symbol Conversion Table Interface allows the user to convert symbol names from inbound names to outbound names.

This is primarily used to normalise a symbol name between multiple connections across different exchanges. However, it can also be used by the synthetic datasources (such as the Forward-To-Spot-Convertor, Spreader, etc) to alter the symbol name they are publishing altered data for. For example, there may be multiple FTSC Sessions active all handling the symbol "EUR/USD", but publishing different futures prices for it, so they may use the Symbol Conversion Service to publish these prices with different symbol names.
Since:
CMF 2.1.1

Member summary
 action<string, string, action<string, string>, action<string, string, string>>openToWrite

Opens the symbol name conversion table for the specified Session for Write access.
 action<string, string, action<string, string>, action<string, string, string>>openToRead

Opens the symbol name conversion table for the specified Session for Write access.
 action<string> returns stringgetConvertedSymbol

Returns the converted symbol name for the original name passed into the function.
 action<string> returns sequence<string>getConvertedSymbols

Returns a sequence of converted symbol names for the original name passed into the function.
 action<dictionary<string, string>> returns booleansetConvertedSymbols

This function allows the user to populate the symbol name conversion table with symbol names and the symbol name to convert them to.
 action<> returns dictionary<string, sequence<string>>getAllConvertedSymbols

This function returns all the symbol conversions that are in the current table as a dictionary. This function requires the symbol name conversion table has been opened for access already, otherwise an empty dictionary will be returned.
 action<>flushCache

This function flushes the internal cache of conversions that have been returned. An internal cache is used for performance reasons, but this must be flushed if the symbol conversion table is modified, otherwise the old conversion names will be returned.
 
Member detail

flushCache

            action<> flushCache
        
This function flushes the internal cache of conversions that have been returned. An internal cache is used for performance reasons, but this must be flushed if the symbol conversion table is modified, otherwise the old conversion names will be returned.

getAllConvertedSymbols

            action<> returns dictionary<string, sequence<string>> getAllConvertedSymbols
        
This function returns all the symbol conversions that are in the current table as a dictionary. This function requires the symbol name conversion table has been opened for access already, otherwise an empty dictionary will be returned.

getConvertedSymbol

            action<string> returns string getConvertedSymbol
        
Returns the converted symbol name for the original name passed into the function.

If no conversion was possible, the original symbol name is returned. This function requires the symbol name conversion table has been opened already, otherwise the original symbol name is returned.

getConvertedSymbols

            action<string> returns sequence<string> getConvertedSymbols
        
Returns a sequence of converted symbol names for the original name passed into the function.

If no conversion was possible, a sequence containing only the original symbol name is returned. This function requires the symbol name conversion table has been opened already, otherwise a sequence containing only the original symbol name is returned.

openToRead

            action<string, string, action<string, string>, action<string, string, string>> openToRead
        
Opens the symbol name conversion table for the specified Session for Write access.

openToWrite

            action<string, string, action<string, string>, action<string, string, string>> openToWrite
        
Opens the symbol name conversion table for the specified Session for Write access.

setConvertedSymbols

            action<dictionary<string, string>> returns boolean setConvertedSymbols
        
This function allows the user to populate the symbol name conversion table with symbol names and the symbol name to convert them to.

This function also populates the reverse lookup name so that the table can be used bi-directionally. This function requires the symbol name conversion table has been opened for Write access already, otherwise it will return an error.