OnixS C++ CME MDP Premium Market Data Handler 5.10.3
Users' manual and API documentation
Loading...
Searching...
No Matches
ListSetting< Type, Container > Class Template Reference

#include <OnixS/CME/MDH/SettingGroup.h>

Public Types

typedef Type Item
typedef Container Items
typedef Items::size_type Size
typedef Items::const_iterator Iterator

Public Member Functions

 ListSetting (const SettingGroup *group=nullptr)
 ListSetting (const ListSetting &other)
template<class InputIterator>
 ListSetting (InputIterator first, InputIterator last)
 operator const Items & () const
bool empty () const
Size size () const
Iterator begin () const
Iterator end () const
const Itemoperator[] (Size index) const
template<class Initializer>
void initialize (Initializer initializer)
void push_back (const Item &item)
void clear ()
ListSettingoperator= (const ListSetting &other)
template<class InputIterator>
ListSettingassign (InputIterator first, InputIterator last)
ListSettingassignNoControl (const ListSetting &other)

Detailed Description

template<class Type, class Container = std::vector<Type>>
class OnixS::CME::MDH::ListSetting< Type, Container >

Definition at line 181 of file SettingGroup.h.

Member Typedef Documentation

◆ Item

template<class Type, class Container = std::vector<Type>>
typedef Type Item

Alias for the type representing the list item.

Definition at line 185 of file SettingGroup.h.

◆ Items

template<class Type, class Container = std::vector<Type>>
typedef Container Items

Internal container used to store items.

Definition at line 188 of file SettingGroup.h.

◆ Iterator

template<class Type, class Container = std::vector<Type>>
typedef Items::const_iterator Iterator

Constant iterator over the items.

Definition at line 194 of file SettingGroup.h.

◆ Size

template<class Type, class Container = std::vector<Type>>
typedef Items::size_type Size

Type in which items are counted.

Definition at line 191 of file SettingGroup.h.

Constructor & Destructor Documentation

◆ ListSetting() [1/3]

template<class Type, class Container = std::vector<Type>>
ListSetting ( const SettingGroup * group = nullptr)
inlineexplicit

Initializes the instance belonging to the given group of settings.

Definition at line 198 of file SettingGroup.h.

◆ ListSetting() [2/3]

template<class Type, class Container = std::vector<Type>>
ListSetting ( const ListSetting< Type, Container > & other)
inline

Initializes as a copy the other instance.

Definition at line 204 of file SettingGroup.h.

◆ ListSetting() [3/3]

template<class Type, class Container = std::vector<Type>>
template<class InputIterator>
ListSetting ( InputIterator first,
InputIterator last )
inline

Initializes as copy of the given range of items.

Definition at line 212 of file SettingGroup.h.

Member Function Documentation

◆ assign()

template<class Type, class Container = std::vector<Type>>
template<class InputIterator>
ListSetting & assign ( InputIterator first,
InputIterator last )
inline

Re-initialize the list as a copy of the given range.

Definition at line 289 of file SettingGroup.h.

◆ assignNoControl()

template<class Type, class Container = std::vector<Type>>
ListSetting & assignNoControl ( const ListSetting< Type, Container > & other)
inline

Unmanaged assignment of the list.

The given member must be used when the given instance is part of the other managed collection. It's not supposed to be invoked when the instance is manipulated in ordinary way.

Definition at line 302 of file SettingGroup.h.

◆ begin()

template<class Type, class Container = std::vector<Type>>
Iterator begin ( ) const
inline

Returns iterator pointing to the beginning of the list.

Definition at line 237 of file SettingGroup.h.

◆ clear()

template<class Type, class Container = std::vector<Type>>
void clear ( )
inline

Removes all items from the list.

Iterators and references related to the given list are invalidated.

Definition at line 274 of file SettingGroup.h.

◆ empty()

template<class Type, class Container = std::vector<Type>>
bool empty ( ) const
inline

Indicates whether the list is an empty one.

Definition at line 225 of file SettingGroup.h.

◆ end()

template<class Type, class Container = std::vector<Type>>
Iterator end ( ) const
inline

Returns iterator pointing to the item beyond the last one.

Definition at line 243 of file SettingGroup.h.

◆ initialize()

template<class Type, class Container = std::vector<Type>>
template<class Initializer>
void initialize ( Initializer initializer)
inline

Performs managed initialization of the list using the given functional object.

Definition at line 257 of file SettingGroup.h.

◆ operator const Items &()

template<class Type, class Container = std::vector<Type>>
operator const Items & ( ) const
inline

Implicit conversion into the container keeping items.

Definition at line 219 of file SettingGroup.h.

◆ operator=()

template<class Type, class Container = std::vector<Type>>
ListSetting & operator= ( const ListSetting< Type, Container > & other)
inline

Re-initialize the list as a copy of the other one.

Definition at line 280 of file SettingGroup.h.

◆ operator[]()

template<class Type, class Container = std::vector<Type>>
const Item & operator[] ( Size index) const
inline

Provides access to the items by its index.

Definition at line 249 of file SettingGroup.h.

◆ push_back()

template<class Type, class Container = std::vector<Type>>
void push_back ( const Item & item)
inline

Appends the given item to the tail of the list.

Definition at line 263 of file SettingGroup.h.

◆ size()

template<class Type, class Container = std::vector<Type>>
Size size ( ) const
inline

Returns number of items in the given list.

Definition at line 231 of file SettingGroup.h.