Apama Capital Markets Foundation  10.7.0.0
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
com::softwareag::marketdata::MarketDataPublisher Class Reference

#include <Connectivity_MDPublisher.h>

Inheritance diagram for com::softwareag::marketdata::MarketDataPublisher:
com::softwareag::marketdata::BBAPublisher com::softwareag::marketdata::DepthPublisher com::softwareag::marketdata::EPPublisher com::softwareag::marketdata::NewsDataPublisher com::softwareag::marketdata::OrderPublisher com::softwareag::marketdata::QuotebookPublisher com::softwareag::marketdata::TradePublisher

Public Member Functions

 MarketDataPublisher (void *dataManagerPtr)
 
void SetExtraParam (const std::string &subKey, const std::string &paramName, const std::string &type, const std::string &value, const std::string &description)
 
void SetExtraParams (const std::string &subKey, const ExtraParamList &extraParamList)
 
void SetExtraParamValue (const std::string &subKey, const std::string &paramName, const std::string &value)
 
void SetExtraParamsValue (const std::string &subKey, const ExtraParamValueList &extraParamValueList)
 
void RemoveExtraParam (const std::string &subKey, const std::string &paramName, bool permanent=false)
 
void RemoveExtraParams (const std::string &subKey, const StringList &paramNames, bool permanent=false)
 

Protected Attributes

void * dataManagerPtr_
 

Detailed Description

MarketDataPublisher class which contains all the methods for managing extra params in Market data message.

Constructor & Destructor Documentation

com::softwareag::marketdata::MarketDataPublisher::MarketDataPublisher ( void *  dataManagerPtr)
inline

MarketDataPublisher constructor

Parameters
dataManagerPtrGeneric void* pointer to take any stream.

Member Function Documentation

void com::softwareag::marketdata::MarketDataPublisher::RemoveExtraParam ( const std::string &  subKey,
const std::string &  paramName,
bool  permanent = false 
)

Remove the Extra Param Value (and optionally schema) for a single parameter for the supplied subKey to send at the next commit.

Parameters
subKeyThe subscription key this Extra Param Data is for.
paramNameThe parameter name/key as a const char* to remove.
permanentIf false (default) will only blank the value. If true, will remove the value and schema.
void com::softwareag::marketdata::MarketDataPublisher::RemoveExtraParams ( const std::string &  subKey,
const StringList paramNames,
bool  permanent = false 
)

Remove the Extra Param Value (and optionally schema) for multiple parameters for the supplied subKey to send at the next commit.

Parameters
subKeyThe subscription key this Extra Param Data is for.
paramNamesThe list of parameter name/key as a StringList to remove.
permanentIf false (default) will only blank the values. If true, will remove the values and schemas.
void com::softwareag::marketdata::MarketDataPublisher::SetExtraParam ( const std::string &  subKey,
const std::string &  paramName,
const std::string &  type,
const std::string &  value,
const std::string &  description 
)

Set the Extra Param Schema and Value for a single parameter for the supplied subKey to send at the next commit.

Parameters
subKeyThe subscription key this Extra Param Data is for.
paramNameThe parameter name/key as a const char* for this Extra Param Data.
typeThe type of the parameter value (eg. "integer", "string", "dictionary<integer, boolean>", etc) as a const char* for this Extra Param Data.
valueThe value as a const char* for this Extra Param Data.
descriptionThe description as a const char* for this Extra Param Data.
void com::softwareag::marketdata::MarketDataPublisher::SetExtraParams ( const std::string &  subKey,
const ExtraParamList extraParamList 
)

Set the Extra Param Schema and Value for multiple parameters for the supplied subKey to send at the next commit.

Parameters
subKeyThe subscription key this Extra Param Data is for.
extraParamListThe list of Extra Param Data (name, type, value, description).
void com::softwareag::marketdata::MarketDataPublisher::SetExtraParamsValue ( const std::string &  subKey,
const ExtraParamValueList extraParamValueList 
)

Set the Extra Param Value for multiple parameters for the supplied subKey to send at the next commit.

Parameters
subKeyThe subscription key this Extra Param Data is for.
extraParamValueListThe list of Extra Param Values Data (name, value).
void com::softwareag::marketdata::MarketDataPublisher::SetExtraParamValue ( const std::string &  subKey,
const std::string &  paramName,
const std::string &  value 
)

Set the Extra Param Value for a single parameter for the supplied subKey to send at the next commit.

Parameters
subKeyThe subscription key this Extra Param Data is for.
paramNameThe parameter name/key as a const char* for this Extra Param Data.
valueThe value as a const char* for this Extra Param Data.

Member Data Documentation

void* com::softwareag::marketdata::MarketDataPublisher::dataManagerPtr_
protected

Generic data manager holder


The documentation for this class was generated from the following file: