CandleSession Struct Reference

Session attribute of CandleSymbol defines trading used to build the candles. More...

#include <CandleSession.hpp>

Inheritance diagram for CandleSession:

Public Member Functions
const SessionFilter &	getSessionFilter () const &noexcept
	Returns a session filter that corresponds to this session attribute.
std::string	changeAttributeForSymbol (const StringLike &symbol) const override
	Returns candle event symbol string with this session attribute set.
const std::string &	toString () const &noexcept
	Returns string representation of this candle session attribute.

Static Public Member Functions
static std::reference_wrapper< const CandleSession >	parse (const StringLike &s)
	Parses string representation of the candle session attribute into an object.
static std::reference_wrapper< const CandleSession >	getAttributeForSymbol (const StringLike &symbol)
	Returns candle session attribute of the given candle symbol string.
static std::string	normalizeAttributeForSymbol (const StringLike &symbol) noexcept
	Returns candle symbol string with the normalized representation of the candle session attribute.

Static Public Attributes
static const CandleSession	ANY {SessionFilter::ANY, "false"}
	All trading sessions are used to build candles.
static const CandleSession	REGULAR {SessionFilter::REGULAR, "true"}
	Only regular trading session data is used to build candles.
static const CandleSession	DEFAULT = ANY
	The default trading session is CandleSession::ANY.
static const std::string	ATTRIBUTE_KEY = "tho"
	The attribute key that is used to store the value of CandleSession in a symbol string using methods of MarketEventSymbols class.

Detailed Description

Session attribute of CandleSymbol defines trading used to build the candles.

Implementation details

This attribute is encoded in a symbol string with MarketEventSymbols.getAttributeStringByKey, changeAttributeStringByKey, and removeAttributeStringByKey methods.

CandleSession::ANY session is a default. The key to use with these methods is available via CandleSession::ATTRIBUTE_KEY constant. The value that this key shall be set to is equal to the corresponding CandleSession::toString()

Member Function Documentation

changeAttributeForSymbol()

std::string CandleSession::changeAttributeForSymbol ( const StringLike & symbol ) const

overridevirtual

Returns candle event symbol string with this session attribute set.

Parameters

symbol

original candle event symbol.

Returns

candle event symbol string with this session attribute set.

Implements CandleSymbolAttribute.

References ATTRIBUTE_KEY, DEFAULT, and toString().

getAttributeForSymbol()

std::reference_wrapper< const CandleSession > CandleSession::getAttributeForSymbol ( const StringLike & symbol )

static

Returns candle session attribute of the given candle symbol string.

The result is CandleSession::DEFAULT if the symbol does not have a candle session attribute.

Parameters

symbol

The candle symbol string.

Returns

The candle session attribute of the given candle symbol string.

References ATTRIBUTE_KEY, and DEFAULT.

getSessionFilter()

const SessionFilter & CandleSession::getSessionFilter ( ) const &

noexcept

Returns a session filter that corresponds to this session attribute.

Returns

The session filter that corresponds to this session attribute.

normalizeAttributeForSymbol()

std::string CandleSession::normalizeAttributeForSymbol ( const StringLike & symbol )

staticnoexcept

Returns candle symbol string with the normalized representation of the candle session attribute.

Parameters

symbol

candle symbol string.

Returns

The candle symbol string with the normalized representation of the candle session attribute.

References ATTRIBUTE_KEY, and DEFAULT.

parse()

std::reference_wrapper< const CandleSession > CandleSession::parse ( const StringLike & s )

static

Parses string representation of the candle session attribute into an object.

Any string returned by CandleSession::toString() can be parsed, and a case is ignored for parsing.

Parameters

s	The string representation of the candle session attribute.

Returns

The candle session attribute (reference).

Exceptions

InvalidArgumentException

if the argument is empty or invalid

toString()

const std::string & CandleSession::toString ( ) const &

noexcept

Returns string representation of this candle session attribute.

The string representation of the candle session attribute is a lower case string that corresponds to its name. For example, CandleSession::ANY is represented as "any".

Returns

string representation of this candle session attribute.

Referenced by changeAttributeForSymbol().

Member Data Documentation

ATTRIBUTE_KEY

const std::string CandleSession::ATTRIBUTE_KEY = "tho"

static

The attribute key that is used to store the value of CandleSession in a symbol string using methods of MarketEventSymbols class.

The value of this constant is "tho", which is an abbreviation for "trading hours only". The value that this key shall be set to is equal to the corresponding CandleSession::toString()

Referenced by changeAttributeForSymbol(), getAttributeForSymbol(), and normalizeAttributeForSymbol().