/search.css" rel="stylesheet" type="text/css"/> /search.js">
| Classes | Job Modules | Data Objects | Services | Algorithms | Tools | Packages | Directories | Tracs |

In This Package:

Public Types | Public Member Functions | Static Public Member Functions | Private Attributes
DybArchiveList Class Reference

#include <DybArchiveList.h>

List of all members.

Public Types

typedef TemporalDataObject contained_type
typedef std::list< DataObject * >
::value_type 
value_type
typedef std::list< DataObject * >
::reference 
reference
typedef std::list< DataObject * >
::const_reference 
const_reference
typedef std::list< DataObject * >
::size_type 
size_type
typedef std::list< DataObject * >
::iterator 
iterator
typedef std::list< DataObject * >
::const_iterator 
const_iterator
typedef std::list< DataObject * >
::reverse_iterator 
reverse_iterator
typedef std::list< DataObject * >
::const_reverse_iterator 
const_reverse_iterator
typedef std::vector
< TemporalDataObject * >
::pointer 
pointer
typedef std::vector
< TemporalDataObject * >
::const_pointer 
const_pointer

Public Member Functions

 DybArchiveList ()
 Constructors.
 DybArchiveList (const DybArchiveList &value)
 Copy Constructor.
virtual ~DybArchiveList ()
 Destructor.
virtual const CLID & clID () const
 Retrieve pointer to class defininition structure.
DybArchiveList::iterator begin ()
 Clone operator.
DybArchiveList::const_iterator begin () const
 Return a const_iterator pointing to the beginning of the container.
DybArchiveList::iterator end ()
 Return an iterator pointing to the end of the container.
DybArchiveList::const_iterator end () const
 Return a const_iterator pointing to the end of the container.
DybArchiveList::reverse_iterator rbegin ()
 Return a reverse_iterator pointing to the beginning of the reversed container.
DybArchiveList::const_reverse_iterator rbegin () const
 Return a const_reverse_iterator pointing to the beginning of the reversed container.
DybArchiveList::reverse_iterator rend ()
 Return a reverse_iterator pointing to the end of the reversed container.
DybArchiveList::const_reverse_iterator rend () const
 Return a const_reverse_iterator pointing to the end of the reversed container.
DybArchiveList::size_type size () const
 Return the size of the container Size means the number of objects stored in the container, independently on the amount of information stored in each object.
virtual long numberOfObjects () const
 The same as size(), return number of objects in the container.
DybArchiveList::size_type max_size () const
 Return the largest possible size of the container.
bool empty () const
 Return true if the size of the container is 0.
DybArchiveList::reference front ()
 Return reference to the first element.
DybArchiveList::const_reference front () const
 Return const_reference to the first element.
DybArchiveList::reference back ()
 Return reference to the last element.
DybArchiveList::const_reference back () const
 Return const_reference to the last element.
void push_back (DybArchiveList::const_reference value)
 push_back = append = insert a new element at the end of the container
void push_front (DybArchiveList::const_reference value)
 push_back = insert a new element at the beginning of the container
void pop_back ()
 pop_back = remove the last element from the container The removed object will be deleted (see the method release)
DybArchiveList::iterator insert (DybArchiveList::iterator position, DybArchiveList::const_reference value)
 Insert "value" before "position".
DybArchiveList::iterator erase (DybArchiveList::iterator position)
 Erase the object at "position" from the container.
DybArchiveList::iterator erase (DybArchiveList::iterator first, DybArchiveList::iterator last)
 Erase the range [first, last) from the container.
void clear ()
 Clear the entire content of the container and delete all contained objects.
virtual long index (const DataObject *obj) const
 Return distance of a given object from the beginning of its container It correcponds to the "index" ( from 0 to size()-1 ) If "obj" not found, return -1.
virtual long index (const TemporalDataObject *obj) const
 Return distance of a given object from the beginning of its container It correcponds to the "index" ( from 0 to size()-1 ) If "obj" not found, return -1.
virtual DataObject * dataObject (long dist) const
 Return const pointer to an object of a given distance.
virtual TemporalDataObjecttemporalDataObject (long dist) const
 Return const pointer to an object of a given distance.
virtual std::ostream & fillStream (std::ostream &s) const
 Fill the output stream (ASCII)

Static Public Member Functions

static const CLID & classID ()

Private Attributes

std::list< DataObject * > m_list
 The STL list.

Detailed Description

Definition at line 18 of file DybArchiveList.h.


Member Typedef Documentation

Definition at line 21 of file DybArchiveList.h.

typedef std::list<DataObject*>::value_type DybArchiveList::value_type

Definition at line 22 of file DybArchiveList.h.

typedef std::list<DataObject*>::reference DybArchiveList::reference

Definition at line 24 of file DybArchiveList.h.

typedef std::list<DataObject*>::const_reference DybArchiveList::const_reference

Definition at line 25 of file DybArchiveList.h.

typedef std::list<DataObject*>::size_type DybArchiveList::size_type

Definition at line 27 of file DybArchiveList.h.

typedef std::list<DataObject*>::iterator DybArchiveList::iterator

Definition at line 29 of file DybArchiveList.h.

typedef std::list<DataObject*>::const_iterator DybArchiveList::const_iterator

Definition at line 30 of file DybArchiveList.h.

typedef std::list<DataObject*>::reverse_iterator DybArchiveList::reverse_iterator

Definition at line 32 of file DybArchiveList.h.

Definition at line 33 of file DybArchiveList.h.

Definition at line 39 of file DybArchiveList.h.

Definition at line 40 of file DybArchiveList.h.


Constructor & Destructor Documentation

DybArchiveList::DybArchiveList ( )

Constructors.

Definition at line 9 of file DybArchiveList.cpp.

  : m_list(0) {
}
DybArchiveList::DybArchiveList ( const DybArchiveList value)

Copy Constructor.

Definition at line 14 of file DybArchiveList.cpp.

  : DataObject(*this),
    m_list(value.m_list) {
}
DybArchiveList::~DybArchiveList ( ) [virtual]

Destructor.

Definition at line 20 of file DybArchiveList.cpp.

                                {
  clear();
}

Member Function Documentation

const CLID & DybArchiveList::clID ( ) const [virtual]

Retrieve pointer to class defininition structure.

Definition at line 25 of file DybArchiveList.cpp.

                                       { 
  return DybArchiveList::classID(); 
}
const CLID & DybArchiveList::classID ( ) [static]

Definition at line 29 of file DybArchiveList.cpp.

                                    {
  // TODO - Fix this.
  static CLID clid = TemporalDataObject::classID() + CLID_ObjectList; 
  return clid;
}
DybArchiveList::iterator DybArchiveList::begin ( )

Clone operator.

Return an iterator pointing to the beginning of the container

Definition at line 46 of file DybArchiveList.cpp.

                                              {
  return m_list.begin();    
}
DybArchiveList::const_iterator DybArchiveList::begin ( ) const

Return a const_iterator pointing to the beginning of the container.

Definition at line 51 of file DybArchiveList.cpp.

                                                          {
  return m_list.begin();
}
DybArchiveList::iterator DybArchiveList::end ( )

Return an iterator pointing to the end of the container.

Definition at line 56 of file DybArchiveList.cpp.

                                            {
  return m_list.end();
}
DybArchiveList::const_iterator DybArchiveList::end ( ) const

Return a const_iterator pointing to the end of the container.

Definition at line 61 of file DybArchiveList.cpp.

                                                        {
  return m_list.end();
}
DybArchiveList::reverse_iterator DybArchiveList::rbegin ( )

Return a reverse_iterator pointing to the beginning of the reversed container.

Definition at line 67 of file DybArchiveList.cpp.

                                                       {
  return m_list.rbegin();
}
DybArchiveList::const_reverse_iterator DybArchiveList::rbegin ( ) const

Return a const_reverse_iterator pointing to the beginning of the reversed container.

Definition at line 72 of file DybArchiveList.cpp.

                                                                   {
  return m_list.rbegin();
}
DybArchiveList::reverse_iterator DybArchiveList::rend ( )

Return a reverse_iterator pointing to the end of the reversed container.

Definition at line 77 of file DybArchiveList.cpp.

                                                     {
  return m_list.rend();
}
DybArchiveList::const_reverse_iterator DybArchiveList::rend ( ) const

Return a const_reverse_iterator pointing to the end of the reversed container.

Definition at line 82 of file DybArchiveList.cpp.

                                                                 {
  return m_list.rend();
}
DybArchiveList::size_type DybArchiveList::size ( ) const

Return the size of the container Size means the number of objects stored in the container, independently on the amount of information stored in each object.

Definition at line 89 of file DybArchiveList.cpp.

                                                    {
  return m_list.size();
}
long DybArchiveList::numberOfObjects ( ) const [virtual]

The same as size(), return number of objects in the container.

Definition at line 94 of file DybArchiveList.cpp.

                                           {
  return m_list.size();
}
DybArchiveList::size_type DybArchiveList::max_size ( ) const

Return the largest possible size of the container.

Definition at line 99 of file DybArchiveList.cpp.

                                                        {
  return m_list.max_size();
}
bool DybArchiveList::empty ( ) const

Return true if the size of the container is 0.

Definition at line 104 of file DybArchiveList.cpp.

                                  {
  return m_list.empty();
}
DybArchiveList::reference DybArchiveList::front ( )

Return reference to the first element.

Definition at line 109 of file DybArchiveList.cpp.

                                               {
  return m_list.front();
}
DybArchiveList::const_reference DybArchiveList::front ( ) const

Return const_reference to the first element.

Definition at line 114 of file DybArchiveList.cpp.

                                                           {
  return m_list.front();
}
DybArchiveList::reference DybArchiveList::back ( )

Return reference to the last element.

Definition at line 119 of file DybArchiveList.cpp.

                                              {
  return m_list.back();
}
DybArchiveList::const_reference DybArchiveList::back ( ) const

Return const_reference to the last element.

Definition at line 124 of file DybArchiveList.cpp.

                                                          {
  return m_list.back();
}
void DybArchiveList::push_back ( DybArchiveList::const_reference  value)

push_back = append = insert a new element at the end of the container

Definition at line 129 of file DybArchiveList.cpp.

                                                                    {
  value->addRef();
  m_list.push_back(value);
}
void DybArchiveList::push_front ( DybArchiveList::const_reference  value)

push_back = insert a new element at the beginning of the container

Definition at line 135 of file DybArchiveList.cpp.

                                                                     {
  value->addRef();
  m_list.push_front(value);
}
void DybArchiveList::pop_back ( )

pop_back = remove the last element from the container The removed object will be deleted (see the method release)

Definition at line 142 of file DybArchiveList.cpp.

                               {
  DybArchiveList::value_type position = m_list.back();
  position->release();
  m_list.pop_back();
}
DybArchiveList::iterator DybArchiveList::insert ( DybArchiveList::iterator  position,
DybArchiveList::const_reference  value 
)

Insert "value" before "position".

Definition at line 149 of file DybArchiveList.cpp.

                                                                                       {
  value->addRef();
  DybArchiveList::iterator i = m_list.insert(position, value);
  return i;
}
DybArchiveList::iterator DybArchiveList::erase ( DybArchiveList::iterator  position)

Erase the object at "position" from the container.

The removed object will be deleted.

Definition at line 158 of file DybArchiveList.cpp.

                                                                              {
  (*position)->release();
  // Removing from the container itself
  return m_list.erase(position);
}
DybArchiveList::iterator DybArchiveList::erase ( DybArchiveList::iterator  first,
DybArchiveList::iterator  last 
)

Erase the range [first, last) from the container.

The removed object will be deleted

Definition at line 166 of file DybArchiveList.cpp.

                                                                              {
  for( DybArchiveList::iterator iter = first; iter != last; iter++ )  {
    (*iter)->release();
  }
  // Removing from the container itself
  return m_list.erase(first, last);
}
void DybArchiveList::clear ( )

Clear the entire content of the container and delete all contained objects.

Definition at line 176 of file DybArchiveList.cpp.

                              {
  erase(begin(), end());
}
long DybArchiveList::index ( const DataObject *  obj) const [virtual]

Return distance of a given object from the beginning of its container It correcponds to the "index" ( from 0 to size()-1 ) If "obj" not found, return -1.

Definition at line 183 of file DybArchiveList.cpp.

                                                        {
  long i = 0;
  DybArchiveList::const_iterator   iter;
  for( iter = begin(); iter != end(); iter++ )  {
    if( obj == (*iter) ) {
      return i;
    }
    i++;
  }
  return -1;
}
long DybArchiveList::index ( const TemporalDataObject obj) const [virtual]

Return distance of a given object from the beginning of its container It correcponds to the "index" ( from 0 to size()-1 ) If "obj" not found, return -1.

Definition at line 198 of file DybArchiveList.cpp.

                                                                {
  long i = 0;
  DybArchiveList::const_iterator   iter;
  for( iter = begin(); iter != end(); iter++ )  {
    if( obj == dynamic_cast<TemporalDataObject*>(*iter) ) {
      return i;
    }
    i++;
  }
  return -1;
}
DataObject * DybArchiveList::dataObject ( long  dist) const [virtual]

Return const pointer to an object of a given distance.

Definition at line 211 of file DybArchiveList.cpp.

                                                        {
  long i = 0;
  DybArchiveList::const_iterator   iter;
  for( iter = begin(); iter != end(); iter++ )  {
    if( dist == i ) {
      return *iter;
    }
    i++;
  }
  return 0;
}
TemporalDataObject * DybArchiveList::temporalDataObject ( long  dist) const [virtual]

Return const pointer to an object of a given distance.

Definition at line 224 of file DybArchiveList.cpp.

                                                                        {
  long i = 0;
  DybArchiveList::const_iterator   iter;
  for( iter = begin(); iter != end(); iter++ )  {
    if( dist == i ) {
      return dynamic_cast<TemporalDataObject*>(*iter);
    }
    i++;
  }
  return 0;
}
std::ostream & DybArchiveList::fillStream ( std::ostream &  s) const [virtual]

Fill the output stream (ASCII)

Definition at line 237 of file DybArchiveList.cpp.

                                                            {
  s << "class DybArchiveList :    size = "
    << std::setw(12)
    << size() << "\n";
  // Output the base class
  //ObjectContainerBase::fillStream(s);
  if ( 0 != size() ) {
    s << "\nContents of the STL list :";
    long   count = 0;
    DybArchiveList::const_iterator iter;
    for( iter = m_list.begin(); iter != m_list.end(); iter++, count++ ) {
      s << "\nIndex "
        << std::setw(12)
        << count
        << " of object of type "<< **iter;
    }
  }
  return s;
}

Member Data Documentation

std::list<DataObject*> DybArchiveList::m_list [private]

The STL list.

Definition at line 163 of file DybArchiveList.h.


The documentation for this class was generated from the following files:
| Classes | Job Modules | Data Objects | Services | Algorithms | Tools | Packages | Directories | Tracs |

Generated on Fri May 16 2014 10:08:31 for DataUtilities by doxygen 1.7.4