OnixS C++ CME MDP Premium Market Data Handler  5.8.9
API Documentation
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 180 of file SettingGroup.h.

Member Typedef Documentation

typedef Type Item

Alias for the type representing the list item.

Definition at line 184 of file SettingGroup.h.

typedef Container Items

Internal container used to store items.

Definition at line 187 of file SettingGroup.h.

typedef Items::const_iterator Iterator

Constant iterator over the items.

Definition at line 193 of file SettingGroup.h.

typedef Items::size_type Size

Type in which items are counted.

Definition at line 190 of file SettingGroup.h.

Constructor & Destructor Documentation

ListSetting ( const SettingGroup group = nullptr)
inlineexplicit

Initializes the instance belonging to the given group of settings.

Definition at line 197 of file SettingGroup.h.

ListSetting ( const ListSetting< Type, Container > &  other)
inline

Initializes as a copy the other instance.

Definition at line 203 of file SettingGroup.h.

ListSetting ( InputIterator  first,
InputIterator  last 
)
inline

Initializes as copy of the given range of items.

Definition at line 211 of file SettingGroup.h.

Member Function Documentation

ListSetting& assign ( InputIterator  first,
InputIterator  last 
)
inline

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

Definition at line 288 of file SettingGroup.h.

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 301 of file SettingGroup.h.

Iterator begin ( ) const
inline

Returns iterator pointing to the beginning of the list.

Definition at line 236 of file SettingGroup.h.

void clear ( )
inline

Removes all items from the list.

Iterators and references related to the given list are invalidated.

Definition at line 273 of file SettingGroup.h.

bool empty ( ) const
inline

Indicates whether the list is an empty one.

Definition at line 224 of file SettingGroup.h.

Iterator end ( ) const
inline

Returns iterator pointing to the item beyond the last one.

Definition at line 242 of file SettingGroup.h.

void initialize ( Initializer  initializer)
inline

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

Definition at line 256 of file SettingGroup.h.

operator const Items & ( ) const
inline

Implicit conversion into the container keeping items.

Definition at line 218 of file SettingGroup.h.

ListSetting& operator= ( const ListSetting< Type, Container > &  other)
inline

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

Definition at line 279 of file SettingGroup.h.

const Item& operator[] ( Size  index) const
inline

Provides access to the items by its index.

Definition at line 248 of file SettingGroup.h.

void push_back ( const Item item)
inline

Appends the given item to the tail of the list.

Definition at line 262 of file SettingGroup.h.

Size size ( ) const
inline

Returns number of items in the given list.

Definition at line 230 of file SettingGroup.h.


The documentation for this class was generated from the following file: