Generic hardware access library
HAL Namespace Reference

Classes

class  ASCIIFileAddressTableContainerTester
class  ExceptionTester
class  PollItemCommandTester
class  VME64xAddressTableASCIIReaderTester
class  VME64xCrateTester
class  VME64xDeviceTester
class  VME64xDummyBusAdapterTester
class  VME64xFunctionTesterStandard
class  VME64xMappedWindowTesterStandard
class  VME64xMixedCrateTester
class  VMEAddressTableTester
class  VMEConfigurationSpaceAddressReaderTester
class  VMEConfigurationSpaceHandlerTester
class  XMLAddressTableTester
class  AbstractCommandFactory
class  AddCommand
 Adding a constant to a varible. More...
class  AddFactory
 The class constructs Add Commands. More...
class  AddressOutOfLimitsException
 Indicates that an address is not in the range of the address defined in an addressTable. More...
class  AddressTable
 Implementation of a AddressTableInterface. More...
class  AddressTableContainerInterface
 Creates AddressTables and keeps them. More...
class  AddressTableInterface
 The user interface for the AddressTable. More...
class  AddressTableItem
 Contains data of an AddressTable item. More...
class  AddressTableReader
 An interface defining how to read AddressTableItems from an implementation of this class. More...
class  AMSortFunctor
class  ASCIIFileAddressTableContainer
 Retrieves AddressTables for a given SerialNumber. More...
class  ASCIIFileModuleMapper
 Reads an ASCII file to map serialNumbers to typeIds and baseAddresses. More...
class  BusAdapterException
 Thrown if there is a problem in the BusAdapter. More...
class  CheckCommand
 SequencerCommand to check the value of an item agains an expectation. More...
class  CheckFactory
 The class constructs Check Commands. More...
class  CommandCreator
 A class to construct SequencerCommand Objects. More...
class  CommandSequence
 A series of commands which can be excecuted at once. More...
class  CommandSequenceASCIIReader
 Reads a command sequence from a plain ASCII file. More...
class  CommandSequencer
class  CommandSequenceReader
 The Interface for a Reader of command sequences. More...
class  DefineCommand
 SequencerCommand to define a new Variable. More...
class  DefineFactory
 The class constructs Define Commands. More...
class  DeviceIdentifier
 Contains information to identifiy a hardware device unambiguously on the bus. More...
class  DOMToPCIMapConverter
 Converts a DOM-tree to a list of AddressTableItems. More...
class  DOMToVMEMapConverter
 Converts a DOM-tree to a list of AddressTableItems. More...
class  GeneralHardwareAddress
 Specifies the address and access mode for an item. More...
class  GotoCommand
 SequencerCommand to define a new Goto. More...
class  GotoFactory
 The class constructs Goto Commands. More...
struct  HalHash
 Template class for a hash function. More...
struct  HalHash< std::string >
class  HardwareAccessException
 The baseclass of all exceptions thrown in this library. More...
class  HardwareDevice
 The implementation of the hardwareDeviceInterface. More...
class  HardwareDeviceInterface
 The interface to ALL hardware devices. More...
class  HardwareProblemException
 Indicates a problem with the hardware. More...
class  IllegalOperationException
 Indicates the use of a operation in an inapropriate context. More...
class  IllegalValueException
 Indicates a wrong value used in the program. More...
class  LabelCommand
 SequencerCommand to define a new Label. More...
class  LabelFactory
 The class constructs Label Commands. More...
class  StopWatch
class  MaskBoundaryException
 Indicates that a value has bits set which are outside of a specified mask. More...
class  ModuleMapperInterface
 An interface to retrieve information on a module with a given serial number. More...
class  NoSuchDeviceException
 Indicates a wrong value used in the program. More...
class  NoSuchFileException
 Indicates a wrong value used in the program. More...
class  NoSuchItemException
 Indicates a wrong value used in the program. More...
class  PCIAddressTable
 The Address Table for PCI Devices. More...
class  PCIAddressTableASCIIReader
 A class to read in an ASCII file with an AddressTable description. More...
class  PCIAddressTableDOMReader
 A class to read DOM representation of a PCIAddressTable. More...
class  PCIAddressTableDynamicReader
 A reader which can be used to create PCIAddressTables dynamically. More...
class  PCIAddressTableXMLFileReader
 A class to read a file with an XML representation of a PCIAddressTable. More...
class  PCIBusAdapterInterface
 Interface to the PCI-bus hardware. More...
class  PCIDevice
 Implementation of a PCI Hardware device. More...
class  PCIDeviceIdentifier
 Some extensions to the DeviceIdentifier for PCI. More...
class  PCIHardwareAddress
 Specifies address and access mode for PCI items. More...
class  PollItemCommand
 SequencerCommand to poll an item. More...
class  PollItemFactory
 The class constructs PollItem Commands. More...
class  PrintCommand
 SequencerCommand to print something on the console. More...
class  PrintFactory
 The class constructs Print Commands. More...
class  ReadCommand
 SequencerCommand to perform a read operation into from a hardware device. More...
class  ReadFactory
 The class constructs Read Commands. More...
class  ResetBitCommand
 SequencerCommand to set a single bit in the hardware. More...
class  ResetBitFactory
 The class constructs resetBit Commands. More...
class  SequencerCommand
 Interface for the a command for the CommandSequencer. More...
class  SequencerSyntaxError
 Indicates a syntax error in a CommandSequence. More...
class  SetBitCommand
 SequencerCommand to set a single bit in the hardware. More...
class  SetBitFactory
 The class constructs setBit Commands. More...
class  StaticVMEConfiguration
class  StaticVMEConfigurationASCIIFileReader
class  StaticVMEConfigurationReader
class  StaticVMEItem
class  TimeoutException
 Indicates that a timeout has expired. More...
class  UnmaskedReadCommand
 SequencerCommand to perform a unmaskedRead operation from from a hardware device. More...
class  UnmaskedReadFactory
 The class constructs UnmaskedRead Commands. More...
class  UnmaskedWriteCommand
 SequencerCommand to perform a unmaskedWrite operation into a hardware device. More...
class  UnmaskedWriteFactory
 The class constructs unmaskedWrite Commands. More...
class  UnsupportedException
 Indicates that the call or option is not supported by the current implementation. More...
class  VerifyException
 Indicates an Error during verification of a written value. More...
class  VME64xAddressTableASCIIReader
 A class to read in an ASCII file with an AddressTable description. More...
class  VME64xCrate
 Browses the contents of a crate and delivers the VME-Modules contained in the crate. More...
class  VME64xDevice
class  VME64xFunction
class  VME64xHardwareAddress
 Specifies address and access mode for VME64x items. More...
class  VME64xMappedWindow
 Representation of a mapped Address space window for a VME module. More...
class  VMEAddressTable
 The Address Table for VME Devices. More...
class  VMEAddressTableASCIIReader
 A class to read in an ASCII file with an VME AddressTable description. More...
class  VMEAddressTableDOMReader
 A class to read DOM representation of a VMEAddressTable. More...
class  VMEAddressTableDynamicReader
 A reader which can be used to create VMEAddressTables dynamically. More...
class  VMEAddressTableXMLFileReader
 A class to read a file with an XML representation of a VMEAddressTable. More...
class  VMEBusAdapterInterface
 Interface to the VME-bus hardware. More...
class  VMEConfigurationSpaceAddressReader
 A reader which generated the VME64x configuration space. More...
class  VMEConfigurationSpaceDevice
 A VME Device with customized hardware read- and write-methods in order to access the VME64x configuration space. More...
class  VMEConfigurationSpaceHandler
 Browses the contents of a crate and delivers the VME-Modules contained in the crate. More...
class  VMEDevice
 Implementation of a VME Hardware device. More...
class  VMEHardwareAddress
 Specifies address and access mode for VME items. More...
class  VMESlot
 Concept: Everything which is related to the VME64x configuration space (NOT the user defined one) is handled by the slot. More...
class  WriteCommand
 SequencerCommand to perform a write operation into a hardware device. More...
class  WriteFactory
 The class constructs Write Commands. More...
class  XMLParserErrorHandler
class  XMLProcessingException
 Indicates a problem during processing of a XML Document. More...

Enumerations

enum  AddressSpace {
  MEMORY, CONFIGURATION,
  IO
}
enum  HalVerifyOption { HAL_NO_VERIFY, HAL_DO_VERIFY }
 A type in order to determine the operation mode of hardware write accesses. More...
enum  HalAddressIncrement { HAL_DO_INCREMENT, HAL_NO_INCREMENT }
 Needed if a block of data is transfered to or from Fifos. More...
enum  HalPollMethod { HAL_POLL_UNTIL_EQUAL, HAL_POLL_UNTIL_DIFFERENT }
 Controles the operation of the pollItem method. More...
enum  SlotContents {
  EMPTY, VME,
  VME64x
}

Enumeration Type Documentation

Enumerator:
MEMORY 
CONFIGURATION 
IO 

Definition at line 7 of file AddressSpace.hh.

Needed if a block of data is transfered to or from Fifos.

If a block of data should be transfered from or to a Fifo, the address of the Fifo should stay constant. This type is used to specify this behaviour for the transfer of blocks of data (writeBlock and readBlock). Note that this variable is NOT relevant for VME if the BusAdapter lets the driver use Block Transfer, because it is the hardware of the slave which decides what to do with the addresses if a block transfer is issued. On the other hand if the BusAdapter implements the blockRead and blockWrite with single accesses the software will respect the settings of the relevant flags.

Confused? read the documentation of the readBlock and writeBlock functions. Still confused? You must unfortunately know more details about VME specification.

See also:
HardwareDeviceInterface
Author:
Christoph Schwick
Revision:
1.3
Date:
2009/04/29 10:23:07
Enumerator:
HAL_DO_INCREMENT 
HAL_NO_INCREMENT 

Definition at line 75 of file HardwareDeviceInterface.hh.

Controles the operation of the pollItem method.

While polling an item with the pollItem method you can decide if you want to poll until the item is equal to a referenceValue which you give to the routine, or if you want to poll until an item is different from the referenceValue. This enum is used to choose one of the two methods in the pollItem method.

See also:
Author:
Christoph Schwick
Revision:
1.3
Date:
2009/04/29 10:23:07
Enumerator:
HAL_POLL_UNTIL_EQUAL 
HAL_POLL_UNTIL_DIFFERENT 

Definition at line 96 of file HardwareDeviceInterface.hh.

A type in order to determine the operation mode of hardware write accesses.

In the hardware access lilbrary there is the possibility to read back any written value and check the read value against the one written. This feature is useful during debugging of hardware.

The type defined in this enum is used in order to specify for each write access whether or not this feature should be in use. The user has to pay attention to use this feature only for items which are also readable.

See also:
HardwareDeviceInterface
Author:
Christoph Schwick
Revision:
1.3
Date:
2009/04/29 10:23:07
Enumerator:
HAL_NO_VERIFY 
HAL_DO_VERIFY 

Definition at line 44 of file HardwareDeviceInterface.hh.

Enumerator:
EMPTY 
VME 
VME64x 

Definition at line 19 of file VMESlot.hh.