C# Class qXL.TopicMap

Show file Open project: exxeleron/qXL Class Usage Examples

Public Methods

Method	Description
AddTopic ( TopicInfo ti ) : void	Allows adding of the TopicInfo structure to the map.
ContainsColumn ( string tab, string sym, string col ) : bool	Verifies whether given column for given symbol in given table is mapped to some topic already
ContainsSymbol ( string tab, string sym ) : bool	Verifies whether symbol for given table is already present in internal mappings.
ContainsTopic ( ExcelRtdServer topic ) : bool	Verifies whether given topic exists in internal mappings
GetMapKeys ( ExcelRtdServer topic ) : Tuple	Provides mapping between given topic id from Excel RTD and table,symbol,column from kdb+
GetSymbols ( string tab ) : string[]	Provides means of getting all symbols for given table that are mapped to some topic already.
GetTables ( ) : IEnumerable	Lists all the tables that contain mapping for Excel topic ids for RTD.
GetTopicCount ( string tab, string sym ) : int	Counts topics connected with given table and symbol
GetTopics ( string tab, string sym, string col ) : IEnumerable	Provides mapping between tab-sym-col triple and list of Excel topic ids for RTD formula. Topics connected with historical values for given symbol are kept together with the Topic for the symbol itself.
RemoveTopic ( ExcelRtdServer topic ) : void	Removes given topic from internal mpapings

Method Details

AddTopic() public method

Allows adding of the TopicInfo structure to the map.

public AddTopic ( TopicInfo ti ) : void
ti	TopicInfo	object to be stored in map
return	void

ContainsColumn() public method

Verifies whether given column for given symbol in given table is mapped to some topic already

public ContainsColumn ( string tab, string sym, string col ) : bool
tab	string	table
sym	string	symbol
col	string	column
return	bool

ContainsSymbol() public method

Verifies whether symbol for given table is already present in internal mappings.

public ContainsSymbol ( string tab, string sym ) : bool
tab	string	table
sym	string	symbol
return	bool

ContainsTopic() public method

Verifies whether given topic exists in internal mappings

public ContainsTopic ( ExcelRtdServer topic ) : bool
topic	ExcelDna.Integration.Rtd.ExcelRtdServer	topic id
return	bool

GetMapKeys() public method

Provides mapping between given topic id from Excel RTD and table,symbol,column from kdb+

public GetMapKeys ( ExcelRtdServer topic ) : Tuple
topic	ExcelDna.Integration.Rtd.ExcelRtdServer	RTD formula topic id
return	Tuple

GetSymbols() public method

Provides means of getting all symbols for given table that are mapped to some topic already.

public GetSymbols ( string tab ) : string[]
tab	string	table
return	string[]

GetTables() public method

Lists all the tables that contain mapping for Excel topic ids for RTD.

public GetTables ( ) : IEnumerable
return	IEnumerable

GetTopicCount() public method

Counts topics connected with given table and symbol

public GetTopicCount ( string tab, string sym ) : int
tab	string	table
sym	string	symbol
return	int

GetTopics() public method

Provides mapping between tab-sym-col triple and list of Excel topic ids for RTD formula. Topics connected with historical values for given symbol are kept together with the Topic for the symbol itself.

public GetTopics ( string tab, string sym, string col ) : IEnumerable
tab	string	table
sym	string	symbol
col	string	column
return	IEnumerable

RemoveTopic() public method

Removes given topic from internal mpapings

public RemoveTopic ( ExcelRtdServer topic ) : void
topic	ExcelDna.Integration.Rtd.ExcelRtdServer	topic id to be removed
return	void