TBTK
TBTK::IndexedDataTree< Data, false > Class Template Reference
Inheritance diagram for TBTK::IndexedDataTree< Data, false >:
TBTK::Serializable

Classes

class  ConstIterator
 
class  Iterator
 

Public Member Functions

 IndexedDataTree ()
 
 IndexedDataTree (const std::string &serialization, Mode mode)
 
virtual ~IndexedDataTree ()
 
void add (const Data &data, const Index &index)
 
bool get (Data &data, const Index &index) const
 
Data & get (const Index &index)
 
const Data & get (const Index &index) const
 
void clear ()
 
unsigned int getSizeInBytes () const
 
virtual std::string serialize (Mode mode) const
 
Iterator begin ()
 
ConstIterator begin () const
 
ConstIterator cbegin () const
 
Iterator end ()
 
ConstIterator end () const
 
ConstIterator cend () const
 

Additional Inherited Members

- Public Types inherited from TBTK::Serializable
enum  Mode { Debug, Binary, XML, JSON }
 
- Static Public Member Functions inherited from TBTK::Serializable
static bool hasID (const std::string &serialization, Mode mode)
 
static std::string getID (const std::string &serialization, Mode mode)
 
static std::string extractComponent (const std::string &serialization, const std::string &containerID, const std::string &componentID, const std::string &componentName, Mode mode)
 
- Static Protected Member Functions inherited from TBTK::Serializable
static bool validate (const std::string &serialization, const std::string &id, Mode mode)
 
static std::string getContent (const std::string &serialization, Mode mode)
 
static std::vector< std::string > split (const std::string &content, Mode mode)
 
static std::string serialize (bool b, Mode mode)
 
static void deserialize (const std::string &serialization, bool *b, Mode mode)
 
static std::string serialize (int i, Mode mode)
 
static void deserialize (const std::string &serialization, int *i, Mode mode)
 
static std::string serialize (unsigned int u, Mode mode)
 
static void deserialize (const std::string &serialization, unsigned int *u, Mode mode)
 
static std::string serialize (double d, Mode mode)
 
static void deserialize (const std::string &serialization, double *d, Mode mode)
 
static std::string serialize (std::complex< double > c, Mode mode)
 
static void deserialize (const std::string &serialization, std::complex< double > *c, Mode mode)
 
static std::string serialize (Statistics s, Mode mode)
 
static void deserialize (const std::string &serialization, Statistics *s, Mode mode)
 
static std::string extract (const std::string &serialization, Mode mode, std::string component)
 

Constructor & Destructor Documentation

template<typename Data >
TBTK::IndexedDataTree< Data, false >::IndexedDataTree ( )

Constructor.

template<typename Data >
TBTK::IndexedDataTree< Data, false >::IndexedDataTree ( const std::string &  serialization,
Mode  mode 
)

Constructor. Constructs the IndexedDataTree from a serialization string.

template<typename Data >
TBTK::IndexedDataTree< Data, false >::~IndexedDataTree ( )
virtual

Destructor.

Member Function Documentation

template<typename Data >
void TBTK::IndexedDataTree< Data, false >::add ( const Data &  data,
const Index index 
)

Add indexed data.

template<typename Data >
IndexedDataTree< Data, false >::Iterator TBTK::IndexedDataTree< Data, false >::begin ( )

Create Iterator.

Returns
Iterator pointing at the first element in the IndexedDataTree.
template<typename Data >
IndexedDataTree< Data, false >::ConstIterator TBTK::IndexedDataTree< Data, false >::begin ( ) const

Create Iterator.

Returns
Iterator pointing at the first element in the IndexedDataTree.
template<typename Data >
IndexedDataTree< Data, false >::ConstIterator TBTK::IndexedDataTree< Data, false >::cbegin ( ) const

Create Iterator for constant elements.

Returns
Iterator pointing at the first element in the IndexedDataTree.
template<typename Data >
IndexedDataTree< Data, false >::ConstIterator TBTK::IndexedDataTree< Data, false >::cend ( ) const

Get Iterator for constatne elements that points to the end.

Returns
An Iterator pointing at the end of the IndexedDataTree.
template<typename Data >
void TBTK::IndexedDataTree< Data, false >::clear ( )

Clear.

template<typename Data >
IndexedDataTree< Data, false >::Iterator TBTK::IndexedDataTree< Data, false >::end ( )

Get Iterator pointing to the end.

Returns
An Iterator pointing at the end of the IndexedDataTree.
template<typename Data >
IndexedDataTree< Data, false >::ConstIterator TBTK::IndexedDataTree< Data, false >::end ( ) const

Get Iterator pointing to the end.

Returns
An Iterator pointing at the end of the IndexedDataTree.
template<typename Data >
bool TBTK::IndexedDataTree< Data, false >::get ( Data &  data,
const Index index 
) const

Get data.

template<typename Data >
Data & TBTK::IndexedDataTree< Data, false >::get ( const Index index)

Get data.

Parameters
indexIndex for which to extract the data for.
Returns
Reference to the element.
Exceptions
ElementNotFoundExceptionIf the no element with the requested Index exists.
template<typename Data >
const Data & TBTK::IndexedDataTree< Data, false >::get ( const Index index) const

Get data.

Parameters
indexIndex for which to extract the data for.
Returns
Reference to the element.
Exceptions
ElementNotFoundExceptionIf the no element with the requested Index exists.
template<typename Data >
unsigned int TBTK::IndexedDataTree< Data, false >::getSizeInBytes ( ) const

Get size in bytes.

template<typename Data >
std::string TBTK::IndexedDataTree< Data, false >::serialize ( Mode  mode) const
virtual

Serilaize.

Implements TBTK::Serializable.


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