ldas-tools-framecpp 2.7.0
Loading...
Searching...
No Matches
Public Member Functions | List of all members
FrameCPP::Common::ContainerBase< Obj > Class Template Referenceabstract

The base class for all containers. More...

#include <ContainerBase.hh>

Public Member Functions

virtual ~ContainerBase ()
 Destructor.
 
virtual Obj operator[] (unsigned int index)=0
 Container indexing.
 
virtual const Obj operator[] (unsigned int index) const =0
 Container indexing.
 
virtual unsigned int size () const =0
 Get container size.
 
unsigned int getSize () const
 Get container size.
 

Detailed Description

template<class Obj>
class FrameCPP::Common::ContainerBase< Obj >

The base class for all containers.

Most of the LIGO Frame components are containers which contain other frame components. For example, the RawData object is a container for AdcData, SerData, log messages, and other information. In a frame file, these containers are implemented as linked-lists. However, in the FrameCPP library these are implemented by a container class, "Container". This class standardizes the interface and maximizes code re-use.

ContainerBase is the base class for these container objects. The container classes themselves are templates, so this class allows the user to perform queries on the containers which do not require knowledge of the template type (the template type specifies what Frame class is stored in the container).

The methods defined are (they are all pure virtual):

The destructor is also declared virtual so that the container can be destructed with only a pointer to the ContainerBase parent.

Todo
Implement iterators which dereference to Base*'s. This will allow the todo: STL iterator model to be used with this class.

Constructor & Destructor Documentation

◆ ~ContainerBase()

template<class Obj >
virtual FrameCPP::Common::ContainerBase< Obj >::~ContainerBase ( )
virtual

Destructor.

Member Function Documentation

◆ getSize()

template<class Obj >
unsigned int FrameCPP::Common::ContainerBase< Obj >::getSize ( ) const
inline

Get container size.

◆ operator[]() [1/2]

template<class Obj >
virtual const Obj FrameCPP::Common::ContainerBase< Obj >::operator[] ( unsigned int index) const
pure virtual

Container indexing.

Exceptions
range_error

◆ operator[]() [2/2]

template<class Obj >
virtual Obj FrameCPP::Common::ContainerBase< Obj >::operator[] ( unsigned int index)
pure virtual

Container indexing.

Exceptions
range_error

◆ size()

template<class Obj >
virtual unsigned int FrameCPP::Common::ContainerBase< Obj >::size ( ) const
pure virtual

Get container size.


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