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

SequencerCommand to set a single bit in the hardware. More...

#include <SetBitCommand.hh>

Inheritance diagram for HAL::SetBitCommand:
HAL::SequencerCommand

List of all members.

Public Member Functions

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

Private Attributes

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

Detailed Description

SequencerCommand to set a single bit in the hardware.

The syntax is :

setBit item [verifyFlag] [offset]

  • 'verifyFlag' is an optional parameter which must have the value "HAL_DO_VERIFY" or "HAL_NO_VERIFY".
  • 'offset' is an optional parameter which can be a constant or a variable. If 'offset' is provided also 'verifyFlag' must be provided.
See also:
SetBitFactory
Author:
Christoph Schwick
Revision:
1.1
Date:
2007/03/05 18:02:10

Definition at line 37 of file SetBitCommand.hh.

Constructor & Destructor Documentation

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

Definition at line 4 of file SetBitCommand.cc.

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

Definition at line 42 of file SetBitCommand.hh.

Member Function Documentation

void HAL::SetBitCommand::excecute ( const HardwareDeviceInterface &  device) const throw ( BusAdapterException ) [virtual]

This routine is common to all Sequencer commands.

It does what it pretends to do.

Implements HAL::SequencerCommand.

Definition at line 17 of file SetBitCommand.cc.

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

This is needed by the ResetBitFactory.

Definition at line 22 of file SetBitCommand.cc.

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

This is needed by the ResetBitFactory.

Definition at line 26 of file SetBitCommand.cc.

void HAL::SetBitCommand::setVerify ( )

This is used by the WriteFactory.

Definition at line 13 of file SetBitCommand.cc.

Member Data Documentation

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

Definition at line 64 of file SetBitCommand.hh.

uint32_t HAL::SetBitCommand::offset [private]

Definition at line 66 of file SetBitCommand.hh.

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

Definition at line 65 of file SetBitCommand.hh.

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

Definition at line 63 of file SetBitCommand.hh.

HalVerifyOption HAL::SetBitCommand::verifyFlag [private]

Definition at line 67 of file SetBitCommand.hh.

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