O2GSummaryTable

class O2GSummaryTable

Parents
	`O2GTable`

Brief

The class keeps in memory the up-to-date summary information per the instrument traded.

Details

The class is an in-memory representation of the Summary table.
In order to keep this representation in sync with the trading server, you must instantiate the class and listen to the updates coming from the trading server. The class provides methods to find summary for every currently traded instrument represented by the O2GSummaryTableRow.

Prerequisites

The class is available only through the use of the O2GTableManager. An O2GTableManager object must have the O2GTableManagerStatus.TablesLoaded status.
For complete instructions on the table manager usage, see the How to use table manager in ForexConnect API section.

Instantiating the class

In order to get summary information for the first time, you must obtain an instance of the class by calling the O2GTableManager.getTable method with the O2GTableType.Summary argument. For example,

O2GSummaryTable summaryTable = (O2GSummaryTable)tableManager.getTable(O2GTableType.Summary);

Receiving notifications about the Summary table updates

In order to keep the O2GSummaryTable data current, your application must listen to the Summary table updates coming from the trading server. These updates represent inserts into the table, changes of the summary information, and deletions from the table. An instance of the class implementing the IO2GTableListener interface must be subscribed to the table updates. Subscription to each update type is done individually. Before the logout, you must unsubscribe the listener from every update type separately. The table below shows the subscription/unsubsription syntax for the O2GSummaryTable:

Update type	Subscribe syntax	Unsubscribe syntax
Insert	`summaryTable.subscribeUpdate(O2GTableUpdateType.Insert, tableListener);`	`summaryTable.unsubscribeUpdate(O2GTableUpdateType.Insert, tableListener);`
Update	`summaryTable.subscribeUpdate(O2GTableUpdateType.Update, tableListener);`	`summaryTable.unsubscribeUpdate(O2GTableUpdateType.Update, tableListener);`
Delete	`summaryTable.subscribeUpdate(O2GTableUpdateType.Delete, tableListener);`	`summaryTable.unsubscribeUpdate(O2GTableUpdateType.Delete, tableListener);`

The type defined in the fxcore2.dll assembly. The namespace is fxcore2.

Public Properties
Columns	Gets an instance of the class that provides access to the list of table columns.
Count	Gets the number of rows in the reader.
Type	Gets the type of a trading table.

Public Methods
findRow	Finds a row in the `O2GSummaryTable` by an OfferID.
forEachRow	Iterates through the rows of the table and raises event `EachRow`.
forEachRow	Iterates through the rows of the table and call RowDelegate on each row.
getCell	Gets the value of a cell.
getGenericRow	Gets a generic row by its index.
getNextGenericRow	Gets the next row from `O2GTable`.
getNextGenericRowByColumnValue	Gets the next row from `O2GTable` based on the column value.
getNextGenericRowByColumnValues	Gets the next row from `O2GTable` based on any of the column values.
getNextGenericRowByMultiColumnValues	Gets the next row from `O2GTable` based on the multiple columns values.
getNextRow	Gets the next row from the `O2GSummaryTable`.
getNextRowByColumnValue	Gets the next row from `O2GSummaryTable` based on the column value.
getNextRowByColumnValues	Gets the next row from `O2GSummaryTable` based on any of the column values.
getNextRowByMultiColumnValues	Gets the next row from `O2GSummaryTable` based on the multiple columns values.
getRow	Gets a row from the `O2GSummaryTable` by its index.
getStatus	Gets the status of the table.
isCellChanged	Checks whether the cell is changed.
isCellValid	Checks whether the cell value can be used or not.
subscribeStatus	Subscribes table listener to changes of table status.
subscribeUpdate	Subscribes table listener to table updates.
unsubscribeStatus	Unsubscribes table listener from changes of table status.
unsubscribeUpdate	Unsubscribes table listener from table updates.

Events
RowAdded	The event is fired when a new row appears in the table.
RowChanged	The event is fired when a row is changed.
RowDeleted	The event is fired when a row is deleted.
StatusChanged	The event is fired when the table's status changes.

back