Generic hardware access library
HAL::ReadCommand Class Reference

SequencerCommand to perform a read operation into from a hardware device. More...

#include <ReadCommand.hh>

Inheritance diagram for HAL::ReadCommand:
HAL::SequencerCommand

List of all members.

Public Member Functions

 ReadCommand (std::string item, CommandSequence &sequence)
virtual ~ReadCommand ()
void excecute (const HardwareDeviceInterface &device) const throw ( IllegalOperationException, BusAdapterException, MaskBoundaryException)
 This routine is common to all Sequencer commands.
void setOffsetPointer (uint32_t *offsetPtr)
 This is used by the ReadFactory.
void setResultPointer (uint32_t *dataPtr)
 This is used by the ReadFactory.
void setOffset (uint32_t offset)
 This is used by the ReadFactory.

Private Attributes

CommandSequencesequence
std::string item
uint32_t * resultPtr
uint32_t * offsetPtr
uint32_t offset

Detailed Description

SequencerCommand to perform a read operation into from a hardware device.

This Command corresponds to the read method in the HardwareDeviceInterface. The read value is put into a variable. The syntax is :

read item $varname [offset]

  • 'offset' is an optional parameter (default is 0) and can be a constant or a variable name.
See also:
ReadFactory
Author:
Christoph Schwick
Revision:
1.1
Date:
2007/03/05 18:02:10

Definition at line 37 of file ReadCommand.hh.


Constructor & Destructor Documentation

HAL::ReadCommand::ReadCommand ( std::string  item,
HAL::CommandSequence sequence 
)
Parameters:
sequencedenotes the Sequence to which this command belongs. This reference is needed to store the read value in a variable of the sequence.

Definition at line 4 of file ReadCommand.cc.

virtual HAL::ReadCommand::~ReadCommand ( ) [inline, virtual]

Definition at line 47 of file ReadCommand.hh.


Member Function Documentation

This routine is common to all Sequencer commands.

It does what it pretends to do.

Implements HAL::SequencerCommand.

Definition at line 12 of file ReadCommand.cc.

void HAL::ReadCommand::setOffset ( uint32_t  offset)

This is used by the ReadFactory.

Definition at line 19 of file ReadCommand.cc.

void HAL::ReadCommand::setOffsetPointer ( uint32_t *  offsetPtr)

This is used by the ReadFactory.

Definition at line 23 of file ReadCommand.cc.

void HAL::ReadCommand::setResultPointer ( uint32_t *  dataPtr)

This is used by the ReadFactory.

Definition at line 27 of file ReadCommand.cc.


Member Data Documentation

std::string HAL::ReadCommand::item [private]

Definition at line 71 of file ReadCommand.hh.

uint32_t HAL::ReadCommand::offset [private]

Definition at line 74 of file ReadCommand.hh.

uint32_t* HAL::ReadCommand::offsetPtr [private]

Definition at line 73 of file ReadCommand.hh.

uint32_t* HAL::ReadCommand::resultPtr [private]

Definition at line 72 of file ReadCommand.hh.

Definition at line 70 of file ReadCommand.hh.


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