class IO2GTableManager

Brief

The class creates and maintains trading tables in the ForexConnect memory.

Details

The IO2GTableManager allows creating and maintaining in-memory representations of the trading tables. The tables updates are handled by the ForexConnect API automatically. For implementation details, refer to the ForexConnect API Class Hierarchy section.

Alternatively, you can:

• Request the initial data from the trading server by calling the IO2GRequestFactory.createRefreshTableRequest or the IO2GLoginRules.getTableRefreshResponse methods.

• Capture the TablesUpdates responses.

• Maintain the received data in user-created structures.

Advantages of the IO2GTableManager usage

The following list summarizes the advantages that the IO2GTableManager usage provides:

• In-memory representation of the trading tables with up-to-date values by the descendants of the IO2GTable class.

• Access to the calculated fields (i.e. PipCost in the Offers table is accessible through the getPipCost method, UsableMargin in the Accounts table is accessible through the getUsableMargin method, etc.). All calculated fields are updated automatically.

• Access to the Summary table information through the methods of the IO2GSummaryTableRow class.

• Separate subscriptions to trading table events. The events are described in the IO2GTableListener interface documentation.

Note: The disadvantage of the table manager usage is the decreased performance. It decreases because the values of the calculated fields are computed with every price change. If your application does not need the values of the calculated fields, the table manager usage is not recommended.

Prerequisites

Before the login, you must indicate that your session uses the table manager by calling the IO2GSession.useTableManager method. For example,

mSession.useTableManager(Yes, NULL);

After indicating the usage of the table manager for your session, you must log in to the trading server by calling the IO2GSession.login method. For example,

mSession->login(mUserID, mPassword, mURL, mConnection);

Instantiating the class

An instance of the table manager can be obtained only after an IO2GSession object gets the Connected status.

You can track the trading tables data for all your accounts or for each account individually.
To get an instance of the class that tracks the data for all accounts, call the IO2GSession.getTableManager method. For example,

IO2GTableManager *tableManager = mSession->getTableManager();

To get an instance of the class that tracks the data for a specific account, call the IO2GSession.getTableManagerByAccount method. For example,

IO2GTableManager *tableManager = mSession->getTableManagerByAccount(mAccountID);

In order to use the trading tables data, an instance of the IO2GTableManager class must have the TablesLoaded status.

Note: If the connection between the ForexConnect API and the trading server is lost, you may need to re-create an instance of the IO2GTableManager class.
In case restoration of a connection fails, the session status changes to Disconnected and you must log in and create a new instance of the IO2GTableManager class.
In case the ForexConnect API restores the connection successfully, you can use the existing instance of the IO2GTableManager class.
For a detailed explanation of the session statuses, refer to the Session Statuses section.

For complete details of the table manager usage, refer to the How to use a table manager in ForexConnect API section.

Example

// Create a session
mSession = CO2GTransport::createSession();
 
// Specify that your session uses a table manager
mSession->useTableManager(Yes, NULL);
O2G2Ptr<SessionStatusListener> statusListener = new SessionStatusListener(mSession, mDBName, mPin);
mSession->subscribeSessionStatus(statusListener);
 
// Login into the trading server
mSession->login(mUserID, mPassword, mURL, mConnection);
while (!statusListener->isConnected() && !statusListener->hasError())
{
    uni::Sleep(50);
}
 
if (!statusListener->hasError())
{
    // Get an instance of table manager
    O2G2Ptr<IO2GTableManager> tableManager = mSession->getTableManager();
 
    // Check the table manager status
    while (tableManager->getStatus() != TablesLoaded &&
           tableManager->getStatus() != TablesLoadFailed)
    {
        uni::Sleep(50);
    }
    if (tableManager->getStatus() == TablesLoaded)
    {
        // Get an instance of the O2GTradesTable
        O2G2Ptr<IO2GTradesTable> tradeTable = dynamic_cast<IO2GTradesTable*>(tableManager->getTable(Trades));
 
        // Get row level information
        for (int i = 0; i < tradeTable->size(); i++)
        {
            O2G2Ptr<IO2GTradeTableRow> trade = tradeTable->getRow(i);
            std::cout << "TradeID: " << trade->getTradeID() <<
                         " Close = " <<  trade->getClose() <<
                         " GrossPL = " << trade->getGrossPL() << std::endl;
        }
    }
}