Generic hardware access library
Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes
HAL::CommandSequenceReader Class Reference

The Interface for a Reader of command sequences. More...

#include <CommandSequenceReader.hh>

Inheritance diagram for HAL::CommandSequenceReader:
HAL::CommandSequenceASCIIReader

List of all members.

Public Member Functions

bool next (std::list< std::string > &commandStringList)
 Delivers the next command in the sequence.
virtual void rescan ()=0
 Resets the reader to the start.
virtual ~CommandSequenceReader ()

Protected Member Functions

 CommandSequenceReader ()
 The constructor is PROTECTED.

Protected Attributes

std::list< std::list
< std::string > > 		commandList
bool firstAccess

Private Attributes

std::list< std::list
< std::string > >::iterator 		it

Detailed Description

The Interface for a Reader of command sequences.

This interface is used in the constructor of the CommandSequence to build up the sequence. This class should not be instantiated directly. It is the child classes which implement the different methods for retrieving commands from different media (file, database, memory, ...) or from different representation formats (ASCII, XML, ...). The functionality to retrieve the data from the reader is implemented in this class.

Author:
Christoph Schwick
Revision:
1.1
Date:
2007/03/05 18:02:09

Definition at line 30 of file CommandSequenceReader.hh.

Constructor & Destructor Documentation

HAL::CommandSequenceReader::~CommandSequenceReader ( ) [virtual]

Definition at line 7 of file CommandSequenceReader.cc.

HAL::CommandSequenceReader::CommandSequenceReader ( ) [protected]

The constructor is PROTECTED.

Nobody should ever instantiate this class directly.

Definition at line 3 of file CommandSequenceReader.cc.

Member Function Documentation

bool HAL::CommandSequenceReader::next ( std::list< std::string > &  commandStringList)

Delivers the next command in the sequence.

Parameters:
commandStringListis a reference to a list of strings which contains the complete command.
Returns:
false if there is no more command.

Definition at line 10 of file CommandSequenceReader.cc.

virtual void HAL::CommandSequenceReader::rescan ( ) [pure virtual]

Resets the reader to the start.

The Sequence can now be read another time.

Implemented in HAL::CommandSequenceASCIIReader.

Member Data Documentation

std::list< std::list< std::string > > HAL::CommandSequenceReader::commandList [protected]

Definition at line 52 of file CommandSequenceReader.hh.

bool HAL::CommandSequenceReader::firstAccess [protected]

Definition at line 53 of file CommandSequenceReader.hh.

std::list< std::list< std::string > >::iterator HAL::CommandSequenceReader::it [private]

Definition at line 55 of file CommandSequenceReader.hh.

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