IterationPack::AlgorithmTrackerComposite Class Reference

This class acts a composite container for other AlgorithmTracker objects. More...

#include <IterationPack_AlgorithmTrackerComposite.hpp>

Inheritance diagram for IterationPack::AlgorithmTrackerComposite:

Inheritance graph
[legend]
List of all members.

Overridden from AlgorithmTracker

void initialize ()
 
void output_iteration (const Algorithm &algo) const
 
void output_final (const Algorithm &algo, EAlgoReturn algo_return) const
 

Public Types

typedef Teuchos::RCP< AlgorithmTrackertrack_ptr_t
 
typedef std::list< track_ptr_ttrack_list_t
 

Public Member Functions

 AlgorithmTrackerComposite (const ostream_ptr_t &journal_out)
 
track_list_ttracks ()
 Give access to the list of AlgorithmTracker object pointers.
const track_list_ttracks () const
 

Detailed Description

This class acts a composite container for other AlgorithmTracker objects.

This class exposes a std::list<AlgorithmTracker*> object and lets the client manipulate the list. It is up to the client to maintain this list.

See the "Composite" pattern in "Design Patterns", Gama et al, 1995.

Definition at line 46 of file IterationPack_AlgorithmTrackerComposite.hpp.


Member Typedef Documentation

typedef Teuchos::RCP<AlgorithmTracker> IterationPack::AlgorithmTrackerComposite::track_ptr_t

Definition at line 50 of file IterationPack_AlgorithmTrackerComposite.hpp.

typedef std::list<track_ptr_t> IterationPack::AlgorithmTrackerComposite::track_list_t

Definition at line 52 of file IterationPack_AlgorithmTrackerComposite.hpp.


Constructor & Destructor Documentation

IterationPack::AlgorithmTrackerComposite::AlgorithmTrackerComposite ( const ostream_ptr_t journal_out  ) 

Definition at line 35 of file IterationPack_AlgorithmTrackerComposite.cpp.


Member Function Documentation

track_list_t& IterationPack::AlgorithmTrackerComposite::tracks (  ) 

Give access to the list of AlgorithmTracker object pointers.

const track_list_t& IterationPack::AlgorithmTrackerComposite::tracks (  )  const

void IterationPack::AlgorithmTrackerComposite::initialize (  )  [virtual]

Reimplemented from IterationPack::AlgorithmTracker.

Definition at line 39 of file IterationPack_AlgorithmTrackerComposite.cpp.

void IterationPack::AlgorithmTrackerComposite::output_iteration ( const Algorithm algo  )  const [virtual]

Reimplemented from IterationPack::AlgorithmTracker.

Definition at line 47 of file IterationPack_AlgorithmTrackerComposite.cpp.

void IterationPack::AlgorithmTrackerComposite::output_final ( const Algorithm algo,
EAlgoReturn  algo_return 
) const [virtual]

Reimplemented from IterationPack::AlgorithmTracker.

Definition at line 57 of file IterationPack_AlgorithmTrackerComposite.cpp.


The documentation for this class was generated from the following files:
Generated on Tue Jul 13 09:28:37 2010 for IterationPack: General framework for building iterative algorithms by  doxygen 1.4.7