HAL::CheckCommand Class Reference

SequencerCommand to check the value of an item agains an expectation. More...

#include <CheckCommand.hh>

Inheritance diagram for HAL::CheckCommand:

List of all members.

Public Member Functions
	CheckCommand (std::string item, CommandSequence &sequence)
virtual	~CheckCommand ()
void	excecute (const HardwareDeviceInterface &device) const throw ( IllegalOperationException, BusAdapterException )
	This routine is common to all Sequencer commands.
void	setOffsetPointer (uint32_t *offsetPtr)
	This is used by the CheckFactory.
void	setExpectationPointer (uint32_t *dataPtr)
	This is used by the CheckFactory.
void	setExpectation (uint32_t offset)
	This is used by the CheckFactory.
void	setOffset (uint32_t offset)
	This is used by the CheckFactory.
void	setFailMessage (std::list< std::string > failMessageList)
	This is used by the CheckFactory.
Private Attributes
CommandSequence &	sequence
std::string	item
uint32_t *	expectationPtr
uint32_t	expectation
uint32_t *	offsetPtr
uint32_t	offset
std::list< std::string >	failMessageList

---

Detailed Description

SequencerCommand to check the value of an item agains an expectation.

This Command corresponds to the check method in the HardwareDeviceInterface. The syntax is :

check item expectation [offset] [faultMessage]

• 'expectation' is a constant or a variable containing the expected value for the item.
• 'faultMessage' contains an optional string to be printed in case the read value for the item is not the same as the expectation.
• 'offset' is an optional parameter (default is 0) and can be a constant or a variable name.

See also:

CheckFactory

Author:

Christoph Schwick

Revision:

1.1

Date:

2007/03/05 18:02:09

Definition at line 42 of file CheckCommand.hh.

---

Constructor & Destructor Documentation

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

Parameters:

sequence

denotes 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 5 of file CheckCommand.cc.

virtual HAL::CheckCommand::~CheckCommand

(

)

[inline, virtual]

Definition at line 52 of file CheckCommand.hh.

---

Member Function Documentation

void HAL::CheckCommand::excecute

(

const HardwareDeviceInterface &

device

)

const throw ( IllegalOperationException, BusAdapterException ) [virtual]

This routine is common to all Sequencer commands.

It does what it pretends to do.

Implements HAL::SequencerCommand.

Definition at line 14 of file CheckCommand.cc.

void HAL::CheckCommand::setExpectation

(

uint32_t

offset

)

This is used by the CheckFactory.

Definition at line 47 of file CheckCommand.cc.

void HAL::CheckCommand::setExpectationPointer

(

uint32_t *

dataPtr

)

This is used by the CheckFactory.

Definition at line 55 of file CheckCommand.cc.

void HAL::CheckCommand::setFailMessage

(

std::list< std::string >

failMessageList

)

This is used by the CheckFactory.

Definition at line 59 of file CheckCommand.cc.

void HAL::CheckCommand::setOffset

(

uint32_t

offset

)

This is used by the CheckFactory.

Definition at line 43 of file CheckCommand.cc.

void HAL::CheckCommand::setOffsetPointer

(

uint32_t *

offsetPtr

)

This is used by the CheckFactory.

Definition at line 51 of file CheckCommand.cc.

---

Member Data Documentation

uint32_t HAL::CheckCommand::expectation [private]

Definition at line 87 of file CheckCommand.hh.

uint32_t* HAL::CheckCommand::expectationPtr [private]

Definition at line 86 of file CheckCommand.hh.

std::list< std::string > HAL::CheckCommand::failMessageList [private]

Definition at line 90 of file CheckCommand.hh.

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

Definition at line 85 of file CheckCommand.hh.

uint32_t HAL::CheckCommand::offset [private]

Definition at line 89 of file CheckCommand.hh.

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

Definition at line 88 of file CheckCommand.hh.

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

Definition at line 84 of file CheckCommand.hh.

---

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

• /home/cschwick/hal/generic/include/hal/CheckCommand.hh
• /home/cschwick/hal/generic/src/common/CheckCommand.cc