dxfcpp::MarketEvent Struct Reference

Base class for all market events. More...

#include <MarketEvent.hpp>

Inheritance diagram for dxfcpp::MarketEvent:

Public Types
using	Ptr = std::shared_ptr<MarketEvent>
	The alias to a type of shared pointer to the MarketEvent object.
Public Types inherited from dxfcpp::EventTypeWithSymbol< std::string >
using	Ptr
	The alias to a type of shared pointer to the EventTypeWithSymbol's child object.
Public Types inherited from dxfcpp::EventType
using	Ptr = std::shared_ptr<EventType>
	The alias to a type of shared pointer to the EventType object.
Public Types inherited from dxfcpp::SharedEntity
using	Ptr = std::shared_ptr<SharedEntity>
	The alias to a type of shared pointer to the SharedEntity object.

Public Member Functions
const std::string &	getEventSymbol () const &noexcept override
	Returns symbol of this event.
const std::optional< std::string > &	getEventSymbolOpt () const &noexcept override
	Returns symbol of this event.
void	setEventSymbol (const std::string &eventSymbol) noexcept override
	Changes symbol of this event.
std::int64_t	getEventTime () const noexcept override
	Returns time when event was created or zero when time is not available.
void	setEventTime (std::int64_t eventTime) noexcept override
	Changes event creation time.
Public Member Functions inherited from dxfcpp::EventType
virtual void *	toGraal () const noexcept=0
	Allocates memory for the dxFeed Graal SDK structure (recursively if necessary).
std::string	toString () const noexcept override
	Returns a string representation of the current object.
Public Member Functions inherited from dxfcpp::SharedEntity
template<typename T >
bool	is () const noexcept
	Checks that pointer to the current type could be converted to type T* In other words: whether type T belongs to the type hierarchy in which the current type resides.
template<typename T >
std::shared_ptr< T >	sharedAs () noexcept
	Returns a pointer to the current object wrapped in a smart pointer to type T.
template<typename T >
std::shared_ptr< T >	sharedAs () const noexcept
	Returns a pointer to the current object wrapped in a smart pointer to type T.
Public Member Functions inherited from dxfcpp::Entity
virtual	~Entity () noexcept=default
	The default virtual d-tor.

Protected Member Functions
	MarketEvent (std::string eventSymbol) noexcept
	Protected constructor for concrete implementation classes that initializes eventSymbol property.

Detailed Description

Base class for all market events.

All market events are POCO that extend this class. Market event classes are simple beans with setter and getter methods for their properties and minimal business logic. All market events have eventSymbol property that is defined by this class.

Constructor & Destructor Documentation

MarketEvent()

dxfcpp::MarketEvent::MarketEvent ( std::string eventSymbol )

inlineexplicitprotectednoexcept

Protected constructor for concrete implementation classes that initializes eventSymbol property.

Parameters

eventSymbol

The event symbol.

Member Function Documentation

getEventSymbol()

const std::string & dxfcpp::MarketEvent::getEventSymbol ( ) const &

inlineoverridevirtualnoexcept

Returns symbol of this event.

Returns

symbol of this event or dxfcpp::String::NUL (std::string{"<null>"})

Implements dxfcpp::EventTypeWithSymbol< std::string >.

getEventSymbolOpt()

const std::optional< std::string > & dxfcpp::MarketEvent::getEventSymbolOpt ( ) const &

inlineoverridevirtualnoexcept

Returns symbol of this event.

Returns

symbol of this event or std::nullopt.

Implements dxfcpp::EventTypeWithSymbol< std::string >.

getEventTime()

std::int64_t dxfcpp::MarketEvent::getEventTime ( ) const

inlineoverridevirtualnoexcept

Returns time when event was created or zero when time is not available.

This event time is available only when the corresponding DXEndpoint is created with DXENDPOINT_EVENT_TIME_PROPERTY and the data source has embedded event times. This is typically true only for data events that are read from historical tape files and from OnDemandService. Events that are coming from a network connections do not have an embedded event time information and this method will return zero for them, meaning that event was received just now.

Default implementation returns 0.

Returns

The difference, measured in milliseconds, between the event creation time and midnight, January 1, 1970 UTC or zero when time is not available.

Reimplemented from dxfcpp::EventType.

setEventSymbol()

void dxfcpp::MarketEvent::setEventSymbol ( const std::string & eventSymbol )

inlineoverridevirtualnoexcept

Changes symbol of this event.

Parameters

eventSymbol

The symbol of this event.

Implements dxfcpp::EventTypeWithSymbol< std::string >.

setEventTime()

void dxfcpp::MarketEvent::setEventTime ( std::int64_t )

inlineoverridevirtualnoexcept

Changes event creation time.

Default implementation does nothing.

Parameters

eventTime

the difference, measured in milliseconds, between the event creation time and midnight, January 1, 1970 UTC.

Reimplemented from dxfcpp::EventType.