Represents subscription to time-series of events. More...

#include <TimeSeriesSubscriptionSymbol.hpp>

Inheritance diagram for dxfcpp::TimeSeriesSubscriptionSymbol:

Public Member Functions
	TimeSeriesSubscriptionSymbol (const SymbolWrapper &eventSymbol, std::int64_t fromTime) noexcept
	Creates time-series subscription symbol with a specified event symbol and subscription time.

std::int64_t	getFromTime () const
	Returns the subscription time.

void *	toGraal () const noexcept override
	Allocates memory for the dxFeed Graal SDK structure (recursively if necessary).

std::string	toString () const noexcept override
	Returns string representation of this time-series subscription symbol.

Public Member Functions inherited from dxfcpp::IndexedEventSubscriptionSymbol
	IndexedEventSubscriptionSymbol (const SymbolWrapper &eventSymbol, const IndexedEventSource &source) noexcept
	Creates indexed event subscription symbol with a specified event symbol and source.

virtual const std::unique_ptr< SymbolWrapper > &	getEventSymbol () const
	Returns the wrapped event symbol (CandleSymbol, WildcardSymbol, etc).

virtual const IndexedEventSource &	getSource () const
	Returns indexed event source.

Static Public Member Functions
static void	freeGraal (void *graalNative) noexcept
	Releases the memory occupied by the dxFeed Graal SDK structure (recursively if necessary).

Additional Inherited Members
Static Protected Member Functions inherited from dxfcpp::IndexedEventSubscriptionSymbol
static void	freeGraal (void *graalNative) noexcept
	Releases the memory occupied by the dxFeed Graal SDK structure (recursively if necessary).

static IndexedEventSubscriptionSymbol	fromGraal (void *graalNative) noexcept
	Creates an object of the current type and fills it with data from the the dxFeed Graal SDK structure (recursively if necessary).

Detailed Description

Represents subscription to time-series of events.

This is symbol is observed by ObservableSubscriptionChangeListener methods symbolsAdded and symbolsRemoved when time-series subscription is created via DXFeedTimeSeriesSubscription class.

Instances of this class can be used with DXFeedSubscription to specify subscription for time series events from a specific time. By default, subscribing to time-series events by their event symbol object, the subscription is performed to a stream of new events as they happen only.

TimeSeriesEvent represents a special subtype of IndexedEvent. The source identifier of a time-series event is always zero and thus

Equality and hash codes

This is a FilteredSubscriptionSymbol. Time-series subscription symbols are compared based on their eventSymbol only. It means, that a set of time-series subscription symbols can contain at most one time-series subscription for each event symbol.

Constructor & Destructor Documentation

◆ TimeSeriesSubscriptionSymbol()

dxfcpp::TimeSeriesSubscriptionSymbol::TimeSeriesSubscriptionSymbol	(	const SymbolWrapper &	eventSymbol,
		std::int64_t	fromTime )

noexcept

Creates time-series subscription symbol with a specified event symbol and subscription time.

Parameters

eventSymbol	the wrapped event symbol (CandleSymbol, WildcardSymbol, etc).
fromTime	the subscription time.

Member Function Documentation

◆ freeGraal()

void dxfcpp::TimeSeriesSubscriptionSymbol::freeGraal ( void * graalNative )

staticnoexcept

Releases the memory occupied by the dxFeed Graal SDK structure (recursively if necessary).

Parameters

graalNative The pointer to the dxFeed Graal SDK structure.

◆ getFromTime()

int64_t dxfcpp::TimeSeriesSubscriptionSymbol::getFromTime ( ) const

Returns the subscription time.

Returns: the subscription time.

◆ toGraal()

void * dxfcpp::TimeSeriesSubscriptionSymbol::toGraal ( ) const

overridevirtualnoexcept

Allocates memory for the dxFeed Graal SDK structure (recursively if necessary).

Fills the dxFeed Graal SDK structure's fields by the data of the current entity (recursively if necessary). Returns the pointer to the filled structure.

Returns: The pointer to the filled dxFeed Graal SDK structure

Reimplemented from dxfcpp::IndexedEventSubscriptionSymbol.

◆ toString()

std::string dxfcpp::TimeSeriesSubscriptionSymbol::toString ( ) const