EventTypeWithSymbol< Symbol > Struct Template Reference

Event type parametrized by a symbol. More...

#include <EventType.hpp>

Inheritance diagram for EventTypeWithSymbol< Symbol >:

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

Public Member Functions
virtual const Symbol &	getEventSymbol () const &noexcept=0
	Returns event symbol that identifies this event type in subscription.
virtual const std::optional< Symbol > &	getEventSymbolOpt () const &noexcept=0
	Returns event symbol that identifies this event type in subscription.
virtual void	setEventSymbol (const Symbol &eventSymbol) noexcept=0
	Changes event symbol that identifies this event type in subscription.
Public Member Functions inherited from EventType
virtual std::int64_t	getEventTime () const noexcept
	Returns time when event was created or zero when time is not available.
virtual void	setEventTime (std::int64_t) noexcept
	Changes event creation time.
virtual void *	toGraal () const =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 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 Entity
virtual	~Entity () noexcept=default
	The default virtual d-tor.

Detailed Description

template<typename Symbol>
struct EventTypeWithSymbol< Symbol >

Event type parametrized by a symbol.

Template Parameters

Symbol

The type od symbol

Member Function Documentation

getEventSymbol()

template<typename Symbol >

virtual const Symbol & EventTypeWithSymbol< Symbol >::getEventSymbol ( ) const &

pure virtualnoexcept

Returns event symbol that identifies this event type in subscription.

Returns

The event symbol.

Implemented in Candle, MarketEvent, and Message.

getEventSymbolOpt()

template<typename Symbol >

virtual const std::optional< Symbol > & EventTypeWithSymbol< Symbol >::getEventSymbolOpt ( ) const &

pure virtualnoexcept

Returns event symbol that identifies this event type in subscription.

Returns

The event symbol or std::nullopt.

Implemented in Candle, MarketEvent, and Message.

setEventSymbol()

template<typename Symbol >

virtual void EventTypeWithSymbol< Symbol >::setEventSymbol ( const Symbol & eventSymbol )

pure virtualnoexcept

Changes event symbol that identifies this event type in subscription.

Parameters

eventSymbol

event symbol.

Implemented in Candle, MarketEvent, and Message.