class O2GSummaryTable
Parents | |
|
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 instrument currently traded, represented by the O2GSummaryTableRow
.
Prerequisites
The class is available only through the use of the O2GTableManager
. An O2GTableManager
object must have the O2GTableManagerStatus.TABLES_LOADED 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 |
|
|
UPDATE |
|
|
DELETE |
|
|
Example
Get Offer ID, net profit/loss and amount for the instument traded [show]
The namespace is com.fxcore2
.
Public Methods | |
Finds a row in the |
|
Gets a cell of the table. |
|
Gets the columns of the table. |
|
Gets the next row from the |
|
Gets the next row from |
|
Gets the next row from |
|
Gets the next row from |
|
Gets a row from the |
|
Gets the type of the table. |
|
Gets a flag indicating whether the value of the cell is changed. |