classes/Util/TextLoop_8h_source.shtml

//-*-C++-*-

/***************************************************************************

 *

 *   Copyright (C) 2008 by Willem van Straten

 *   Licensed under the Academic Free License version 2.1

 *

 ***************************************************************************/


// psrchive/Util/units/TextLoop.h


#ifndef __Pulsar_TextLoop_h

#define __Pulsar_TextLoop_h


#include "TextIndex.h"

#include "Functor.h"

#include <stack>


class TextLoop : public Reference::Able

{

public:


  TextLoop ();


  void set_container (TextInterface::Parser*);


  void add_index (TextIndex*);


  void loop ();


  Functor< void() > job;


  std::string get_index_state () const;


protected:


  typedef std::stack< Reference::To<TextIndex> > Stack;

  Stack indeces;


  Reference::To<TextInterface::Parser> container;


  void loop ( Stack& indeces );


  std::string index_state;

};


#endif

Functor
Implements an adaptable function object in compliance with the STL.
Definition Functor.h:39

Reference::Able
Manages Reference::To references to the instance.
Definition ReferenceAble.h:35

Reference::To
Template class manages Reference::Able objects.
Definition ReferenceTo.h:25

TextIndex
Parses and manages a named set of indeces.
Definition TextIndex.h:18

TextInterface::Parser
An array of Value interfaces.
Definition TextInterfaceParser.h:31

TextLoop::container
Reference::To< TextInterface::Parser > container
The container interface to configure on each loop.
Definition TextLoop.h:48

TextLoop::index_state
std::string index_state
Current state of each index.
Definition TextLoop.h:54

TextLoop::loop
void loop()
Execute the job for each index in the stack.
Definition TextLoop.C:30

TextLoop::set_container
void set_container(TextInterface::Parser *)
Set the interface of the container to which the named indeces apply.
Definition TextLoop.C:24

TextLoop::TextLoop
TextLoop()
Default constructor.
Definition TextLoop.C:13

TextLoop::get_index_state
std::string get_index_state() const
Retrieve the index state.
Definition TextLoop.C:73

TextLoop::Stack
std::stack< Reference::To< TextIndex > > Stack
The indeces over which to loop.
Definition TextLoop.h:44

TextLoop::add_index
void add_index(TextIndex *)
Add an index over which to loop.
Definition TextLoop.C:18

TextLoop::job
Functor< void() > job
Job defined by derived types.
Definition TextLoop.h:36