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

SequencerCommand to perform a write operation into a hardware device. More...

#include <WriteCommand.hh>

Inheritance diagram for HAL::WriteCommand:
HAL::SequencerCommand

List of all members.

Public Member Functions

 WriteCommand (std::string item, CommandSequence &sequence)
virtual ~WriteCommand ()
void excecute (const HardwareDeviceInterface &device) const throw ( BusAdapterException, MaskBoundaryException )
 This routine is common to all Sequencer commands.
void setVerify ()
 This is used by the WriteFactory.
void setOffsetPointer (uint32_t *offsetPtr)
 This is used by the WriteFactory.
void setDataPointer (uint32_t *dataPtr)
 This is used by the WriteFactory.
void setData (uint32_t data)
 This is used by the WriteFactory.
void setOffset (uint32_t offset)
 This is used by the WriteFactory.

Private Attributes

CommandSequence & sequence
std::string item
uint32_t * dataPtr
uint32_t * offsetPtr
uint32_t offset
uint32_t constantData
HalVerifyOption verifyFlag

Detailed Description

SequencerCommand to perform a write operation into a hardware device.

Syntax:

write item data [verifyFlag] [offset]

  • 'verifyFlag' is an optional parameter which must have the value "HAL_DO_VERIFY" or "HAL_NO_VERIFY".
  • 'offset' is an optional paramenter. 'data' and 'offset' might be variables or constants. If 'offset' is provided also 'verifyFlag' must be provided.
See also:
WriteFactory
Author:
Christoph Schwick
Revision:
1.1
Date:
2007/03/05 18:02:10

Definition at line 37 of file WriteCommand.hh.

Constructor & Destructor Documentation

HAL::WriteCommand::WriteCommand ( std::string  item,
HAL::CommandSequence &  sequence 
)

Definition at line 4 of file WriteCommand.cc.

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

Definition at line 42 of file WriteCommand.hh.

Member Function Documentation

void HAL::WriteCommand::excecute ( const HardwareDeviceInterface &  device) const throw ( BusAdapterException, MaskBoundaryException ) [virtual]

This routine is common to all Sequencer commands.

It does what it pretends to do.

Implements HAL::SequencerCommand.

Definition at line 19 of file WriteCommand.cc.

void HAL::WriteCommand::setData ( uint32_t  data)

This is used by the WriteFactory.

Definition at line 29 of file WriteCommand.cc.

void HAL::WriteCommand::setDataPointer ( uint32_t *  dataPtr)

This is used by the WriteFactory.

Definition at line 37 of file WriteCommand.cc.

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

This is used by the WriteFactory.

Definition at line 25 of file WriteCommand.cc.

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

This is used by the WriteFactory.

Definition at line 33 of file WriteCommand.cc.

void HAL::WriteCommand::setVerify ( )

This is used by the WriteFactory.

Definition at line 15 of file WriteCommand.cc.

Member Data Documentation

uint32_t HAL::WriteCommand::constantData [private]

Definition at line 78 of file WriteCommand.hh.

uint32_t* HAL::WriteCommand::dataPtr [private]

Definition at line 76 of file WriteCommand.hh.

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

Definition at line 75 of file WriteCommand.hh.

uint32_t HAL::WriteCommand::offset [private]

Definition at line 78 of file WriteCommand.hh.

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

Definition at line 77 of file WriteCommand.hh.

CommandSequence& HAL::WriteCommand::sequence [private]

Definition at line 74 of file WriteCommand.hh.

HalVerifyOption HAL::WriteCommand::verifyFlag [private]

Definition at line 79 of file WriteCommand.hh.

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