SharedEntity Struct Reference

A base abstract "shared entity" class. Has some helpers for dynamic polymorphism. More...

#include <SharedEntity.hpp>

Inheritance diagram for SharedEntity:

Public Types
using	Ptr = std::shared_ptr<SharedEntity>
	The alias to a type of shared pointer to the SharedEntity object.

Public Member Functions
template<typename T>
bool	is () const noexcept
	Checks that the 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 or std::shared_ptr<T>{nullptr} if the object is not managed by std::shared_ptr.
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 or std::shared_ptr<T>{nullptr} if the object is not managed by std::shared_ptr.
virtual std::string	toString () const
	Returns a string representation of the current object.
Public Member Functions inherited from Entity
virtual	~Entity () noexcept
	The default virtual d-tor.

Detailed Description

A base abstract "shared entity" class. Has some helpers for dynamic polymorphism.

Member Function Documentation

is()

template<typename T>

bool SharedEntity::is ( ) const

inlinenoexcept

Checks that the 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 Parameters

T	The type to check

Returns

true if the type belongs to the type hierarchy in which the current type resides.

sharedAs() [1/2]

template<typename T>

std::shared_ptr< T > SharedEntity::sharedAs ( ) const

inlinenoexcept

Returns a pointer to the current object wrapped in a smart pointer to type T or std::shared_ptr<T>{nullptr} if the object is not managed by std::shared_ptr.

Template Parameters

T	The type to convert to a pointer to

Returns

a smart pointer to type T or std::shared_ptr<T>{nullptr} if the object is not managed by std::shared_ptr.

sharedAs() [2/2]

template<typename T>

std::shared_ptr< T > SharedEntity::sharedAs ( )

inlinenoexcept

Returns a pointer to the current object wrapped in a smart pointer to type T or std::shared_ptr<T>{nullptr} if the object is not managed by std::shared_ptr.

Template Parameters

T	The type to convert to a pointer to

Returns

a smart pointer to type T or std::shared_ptr<T>{nullptr} if the object is not managed by std::shared_ptr.

toString()

virtual std::string SharedEntity::toString ( ) const

inlinevirtual

Returns a string representation of the current object.

Returns

a string representation

Reimplemented in AdditionalUnderlyings, AnalyticOrder, Candle, CFI::Attribute, CFI, CFI::Value, DXEndpoint, DXFeed, DXFeedSubscription, DXFeedTimeSeriesSubscription, DXPublisher, EventType, Greeks, IndexedTxModel< E >, IndexedTxModel< O >, IndexedTxModelListener< E >, InstrumentProfile, Message, OptionSale, Order, OtcMarketsOrder, PriceIncrements, Profile, Quote, Series, SpreadOrder, Summary, TextMessage, TheoPrice, TimeAndSale, TimeSeriesTxModel< E >, TimeSeriesTxModelListener< E >, Trade, TradeETH, and Underlying.