Main Page   Modules   Namespace List   Class Hierarchy   Data Structures   File List   Namespace Members   Data Fields   Related Pages  

SctConfiguration::Configuration Class Reference

Interface to XML configuration file. More...

#include <configuration.h>

Inheritance diagram for SctConfiguration::Configuration:


Public Member Functions

virtual ~Configuration ()
 Free resources.

virtual std::list< unsigned
int > 
listPartitions ()=0
 List partition ids Lookup the partitions defined in the configuration and return a list of integer ID's.

virtual std::list< unsigned
int > 
listCratesInPartition (unsigned int partition)=0
 List crate ids with reference to the given partition Lookup the crates defined in the specified partition and return a list of integer ID's.

virtual std::list< unsigned
int > 
listRodsInCrate (unsigned int partition, unsigned int crate)=0
 List the rods present in a crate Lookup the RODs defined in the specified crate and return a list of integer ID's.

virtual std::list< unsigned
int > 
listMURSInRod (unsigned int partition, unsigned int crate, unsigned int rod)=0
 List the MURs associated with a ROD Return integer id's of the MURs in the specified rod.

virtual std::list< std::string > listModulesInMUR (unsigned int partition, unsigned int MUR)=0
 List the modules in the given MUR Return a list of serial numbers associated with the specified MUR.

virtual std::list< std::string > listRModulesInMUR (unsigned int partition, unsigned int MUR)=0
 List the modules in the given MUR Return a list of serial numbers associated with the redundancy links of the specified MUR.

virtual std::list< std::string > listAllModules ()=0
 Return a list of serial numbers of all modules that have configuration.

virtual std::list< std::string > listUnusedModules ()=0
 Return a list of serial numbers of modules that have configuration but are not attached to an MUR.

virtual ABCDModule getModuleConfig (const std::string module)=0
 Return the configuration for the module.

virtual RodConfig getRodConfig (unsigned int partition, unsigned int crate, unsigned int rod)=0
 Return the Rod configuration Find the configuration associated with the specified ROD.

virtual BOCChannelConfig getBOCConfig (unsigned int partition, unsigned int crate, unsigned int rod, unsigned int channel)=0
 Get the BOC configuration of one of 48 channels.

virtual char * getFibreMappings (unsigned int partition, unsigned int crate, unsigned int rod)=0
 Get the BOC fibre mappings.

virtual TimConfig getTimConfig (unsigned int partition, unsigned int crate)=0
 Return the TIM configuration Find the configuration associated with the specified TIM.

virtual void setFibreMapping (unsigned int partition, unsigned int crate, unsigned int rod, unsigned int channel, unsigned int tx, unsigned int rx0, unsigned int rx1)=0
 Set fibre mappings for one channel.

virtual void printModuleConfig (const ABCDModule &conf)=0
 Print module configuration to cout.

virtual MURType getMURType (unsigned int MUR)=0
virtual void translateToROD (unsigned int MUR, unsigned int module, unsigned int &partition, unsigned int &crate, unsigned int &rod, unsigned int &channel)=0
 Translate from MUR / module(1-6) number to p/k/r/c.

virtual void translateToRROD (unsigned int MUR, unsigned int module, unsigned int &partition, unsigned int &crate, unsigned int &rod, unsigned int &channel)=0
 Translate from MUR / redundant module(1-6) number to p/k/r/c.

virtual void translateToSN (unsigned int MUR, unsigned int module, std::string &sn)=0
 Translate from MUR / module(1-6) number to serial number.

virtual void translateToBarrel (unsigned int MUR, unsigned int module, unsigned int &barrel, unsigned int &row, int &number)=0
 Translate from MUR / module(1-6) number to geographical barrel system.

virtual void translateToEndcap (unsigned int MUR, unsigned int module, unsigned int &disk, unsigned int &ring, unsigned int &number)=0
 Translate from MUR / module(1-6) number to geographical endcap system.

virtual void translateToPowerSupply (unsigned int MUR, unsigned int module, unsigned int &partition, unsigned int &crate, unsigned int &channel)=0
 Translate from MUR / module(1-6) number to power supply channel address.

virtual void translateFromROD (unsigned int partition, unsigned int crate, unsigned int rod, unsigned int channel, unsigned int &MUR, unsigned int &module)=0
 Translate to MUR / module(1-6) number from p/k/r/c.

virtual void translateFromRROD (unsigned int partition, unsigned int crate, unsigned int rod, unsigned int channel, unsigned int &MUR, unsigned int &module)=0
 Translate to MUR / module(1-6) number from address of redundant module.

virtual void translateFromSN (const std::string sn, unsigned int &MUR, unsigned int &module)=0
 Translate to MUR / module(1-6) number from serial number.

virtual void translateFromBarrel (unsigned int barrel, unsigned int row, int number, unsigned int &MUR, unsigned int &module)=0
 Translate to MUR / module(1-6) number from geographical barrel system.

virtual void translateFromEndcap (unsigned int disk, unsigned int ring, unsigned int number, unsigned int &MUR, unsigned int &module)=0
 Translate to MUR / module(1-6) number from geographical endcap system.

virtual void translateFromPowerSupply (unsigned int partition, unsigned int crate, unsigned int channel, unsigned int &MUR, unsigned int &module)=0
 Translate from power supply channel address to MUR / module(1-6) number.

virtual void configureModuleFromStructure (const std::string module, const ABCDModule conf)=0
 Update or add the configuration of a module stored in memory Replace the configuration for the given module with the data stored in the given configuration.

virtual void configureModuleFromFile (const std::string filename)=0
 Update or add the configuration of a module stored in memory Replace the configuration for the given module with the data stored in the given file (the serial number is read from the file).

virtual void configureROD (unsigned int partition, unsigned int crate, unsigned int rod, RodConfig conf)=0
 Configure a ROD.

virtual void configureTIM (unsigned int partition, unsigned int crate, TimConfig conf)=0
 Configure a TIM.

virtual void clearAll ()=0
 Remove all configuration.

virtual void namePartition (int partition, const std::string name)=0
 Name a partition (for information, any use?).

virtual void configureBOCChannel (int MUR, int position, const BOCChannelConfig &conf)=0
 Set a BOC configuration.

virtual void mapModuleMUR (int MUR, int order, int RMUR, int rorder, std::string number)=0
 Map a module (by serial number) onto a position in an MUR.

virtual void mapRODMUR (int partition, int crate, int rod, int order, int number)=0
 Map an MUR.

virtual void mapBarrelMUR (int MUR, int barrel, int row, int position)=0
 Map Barrel MUR.

virtual void swapMURNames (int MUR1, int MUR2)=0
 Swap two MUR names around.

virtual void mapEndcapMUR (int MUR, int disk, int quadrant, int position)=0
 Map Endcap MUR.

virtual void mapPowerChannel (int MUR, int number, unsigned int partition, unsigned int crate, unsigned int channel)=0
 Map Power channel.

virtual void modifyPowerParam (int MUR, int number, std::string name, float value)=0
 Set power supply parameter.

virtual void modifyDefaultPowerParam (std::string name, float value)=0
 Set default power supply parameter.

virtual float getPowerParam (int MUR, int number, std::string name)=0
 Get power supply parameter.

virtual void loadConfiguration (const std::string &filename)=0
 Load configuration from named file.

virtual void saveConfiguration (const std::string filename="")=0
 Save the current configuration.

virtual void saveModuleConfiguration (const std::string modsn, const std::string filename)=0
 Save the current configuration for a module.

virtual std::string getModuleConfigurationString (const std::string modsn, const ABCDModule config)=0
 Construct the XML for a module configuration and return as a string.

virtual void writePowerSupplyConfiguration (std::string filename)=0
 Dump power supply configuration to a file.


Detailed Description

Interface to XML configuration file.

This will be replaced by an interface to the DAQ confDB system.

The primary function of this class is the readout of configuration data from the database.

Translation functions:

Barrel barrel, row, number 3 to 6 0 to 55 -1 to -6 and 1 to 6

Internals: position on row given as -1 for -ve numbers and 1 for +ve numbers

Endcap disc quadrant number 0 to 17 0 to 3 0 to 32

Internals: position of MUR in quadrant number is left to right top to bottom 0000001222222 4444455555 1111133333

Definition at line 130 of file configuration.h.


Constructor & Destructor Documentation

virtual SctConfiguration::Configuration::~Configuration   [inline, virtual]
 

Free resources.

Definition at line 135 of file configuration.h.


Member Function Documentation

virtual void SctConfiguration::Configuration::clearAll   [pure virtual]
 

Remove all configuration.

Very dangerous!!

virtual void SctConfiguration::Configuration::configureBOCChannel int    MUR,
int    position,
const BOCChannelConfig   conf
[pure virtual]
 

Set a BOC configuration.

virtual void SctConfiguration::Configuration::configureModuleFromFile const std::string    filename [pure virtual]
 

Update or add the configuration of a module stored in memory Replace the configuration for the given module with the data stored in the given file (the serial number is read from the file).

virtual void SctConfiguration::Configuration::configureModuleFromStructure const std::string    module,
const ABCDModule    conf
[pure virtual]
 

Update or add the configuration of a module stored in memory Replace the configuration for the given module with the data stored in the given configuration.

virtual void SctConfiguration::Configuration::configureROD unsigned int    partition,
unsigned int    crate,
unsigned int    rod,
RodConfig    conf
[pure virtual]
 

Configure a ROD.

Replace the in memory configuration for the given ROD with the configuration provided.

If no configuration then construct it

virtual void SctConfiguration::Configuration::configureTIM unsigned int    partition,
unsigned int    crate,
TimConfig    conf
[pure virtual]
 

Configure a TIM.

Replace the in memory configuration for the given TIM with the configuration provided.

If no configuration then construct it

virtual BOCChannelConfig SctConfiguration::Configuration::getBOCConfig unsigned int    partition,
unsigned int    crate,
unsigned int    rod,
unsigned int    channel
[pure virtual]
 

Get the BOC configuration of one of 48 channels.

Input channels are paired as one.

virtual char* SctConfiguration::Configuration::getFibreMappings unsigned int    partition,
unsigned int    crate,
unsigned int    rod
[pure virtual]
 

Get the BOC fibre mappings.

An array of 48*3 chars (out, in0, in1)

virtual ABCDModule SctConfiguration::Configuration::getModuleConfig const std::string    module [pure virtual]
 

Return the configuration for the module.

Deprecated: Should take MUR argument

virtual std::string SctConfiguration::Configuration::getModuleConfigurationString const std::string    modsn,
const ABCDModule    config
[pure virtual]
 

Construct the XML for a module configuration and return as a string.

virtual float SctConfiguration::Configuration::getPowerParam int    MUR,
int    number,
std::string    name
[pure virtual]
 

Get power supply parameter.

virtual RodConfig SctConfiguration::Configuration::getRodConfig unsigned int    partition,
unsigned int    crate,
unsigned int    rod
[pure virtual]
 

Return the Rod configuration Find the configuration associated with the specified ROD.

Return a RodConfig structure.

virtual TimConfig SctConfiguration::Configuration::getTimConfig unsigned int    partition,
unsigned int    crate
[pure virtual]
 

Return the TIM configuration Find the configuration associated with the specified TIM.

Return a TimConfig structure.

virtual std::list<std::string> SctConfiguration::Configuration::listAllModules   [pure virtual]
 

Return a list of serial numbers of all modules that have configuration.

This includes those that are not attached to a ROD or MUR

virtual std::list<unsigned int> SctConfiguration::Configuration::listCratesInPartition unsigned int    partition [pure virtual]
 

List crate ids with reference to the given partition Lookup the crates defined in the specified partition and return a list of integer ID's.

virtual std::list<std::string> SctConfiguration::Configuration::listModulesInMUR unsigned int    partition,
unsigned int    MUR
[pure virtual]
 

List the modules in the given MUR Return a list of serial numbers associated with the specified MUR.

FIXME: Should be in numbered order

virtual std::list<unsigned int> SctConfiguration::Configuration::listMURSInRod unsigned int    partition,
unsigned int    crate,
unsigned int    rod
[pure virtual]
 

List the MURs associated with a ROD Return integer id's of the MURs in the specified rod.

FIXME: Should be in numbered order

virtual std::list<unsigned int> SctConfiguration::Configuration::listPartitions   [pure virtual]
 

List partition ids Lookup the partitions defined in the configuration and return a list of integer ID's.

virtual std::list<std::string> SctConfiguration::Configuration::listRModulesInMUR unsigned int    partition,
unsigned int    MUR
[pure virtual]
 

List the modules in the given MUR Return a list of serial numbers associated with the redundancy links of the specified MUR.

FIXME: Should be in numbered order (array?)

virtual std::list<unsigned int> SctConfiguration::Configuration::listRodsInCrate unsigned int    partition,
unsigned int    crate
[pure virtual]
 

List the rods present in a crate Lookup the RODs defined in the specified crate and return a list of integer ID's.

virtual std::list<std::string> SctConfiguration::Configuration::listUnusedModules   [pure virtual]
 

Return a list of serial numbers of modules that have configuration but are not attached to an MUR.

virtual void SctConfiguration::Configuration::loadConfiguration const std::string &    filename [pure virtual]
 

Load configuration from named file.

virtual void SctConfiguration::Configuration::mapBarrelMUR int    MUR,
int    barrel,
int    row,
int    position
[pure virtual]
 

Map Barrel MUR.

virtual void SctConfiguration::Configuration::mapEndcapMUR int    MUR,
int    disk,
int    quadrant,
int    position
[pure virtual]
 

Map Endcap MUR.

virtual void SctConfiguration::Configuration::mapModuleMUR int    MUR,
int    order,
int    RMUR,
int    rorder,
std::string    number
[pure virtual]
 

Map a module (by serial number) onto a position in an MUR.

virtual void SctConfiguration::Configuration::mapPowerChannel int    MUR,
int    number,
unsigned int    partition,
unsigned int    crate,
unsigned int    channel
[pure virtual]
 

Map Power channel.

virtual void SctConfiguration::Configuration::mapRODMUR int    partition,
int    crate,
int    rod,
int    order,
int    number
[pure virtual]
 

Map an MUR.

virtual void SctConfiguration::Configuration::modifyDefaultPowerParam std::string    name,
float    value
[pure virtual]
 

Set default power supply parameter.

virtual void SctConfiguration::Configuration::modifyPowerParam int    MUR,
int    number,
std::string    name,
float    value
[pure virtual]
 

Set power supply parameter.

virtual void SctConfiguration::Configuration::namePartition int    partition,
const std::string    name
[pure virtual]
 

Name a partition (for information, any use?).

virtual void SctConfiguration::Configuration::printModuleConfig const ABCDModule &    conf [pure virtual]
 

Print module configuration to cout.

virtual void SctConfiguration::Configuration::saveConfiguration const std::string    filename = "" [pure virtual]
 

Save the current configuration.

Write configuration to disc. If no filename is provided a unique filename based on the date and time is created.

Filename eg Conf_dump_20021210142311.xml.gz (in current directory)

virtual void SctConfiguration::Configuration::saveModuleConfiguration const std::string    modsn,
const std::string    filename
[pure virtual]
 

Save the current configuration for a module.

Write the configuration for the module modsn to disc.

virtual void SctConfiguration::Configuration::setFibreMapping unsigned int    partition,
unsigned int    crate,
unsigned int    rod,
unsigned int    channel,
unsigned int    tx,
unsigned int    rx0,
unsigned int    rx1
[pure virtual]
 

Set fibre mappings for one channel.

Any value over 48/96 leaves current value unchanged

virtual void SctConfiguration::Configuration::swapMURNames int    MUR1,
int    MUR2
[pure virtual]
 

Swap two MUR names around.

This means in regards to everything about one MUR you can use the other name If either doesn't exist then just one MUR is renamed

virtual void SctConfiguration::Configuration::translateFromBarrel unsigned int    barrel,
unsigned int    row,
int    number,
unsigned int &    MUR,
unsigned int &    module
[pure virtual]
 

Translate to MUR / module(1-6) number from geographical barrel system.

virtual void SctConfiguration::Configuration::translateFromEndcap unsigned int    disk,
unsigned int    ring,
unsigned int    number,
unsigned int &    MUR,
unsigned int &    module
[pure virtual]
 

Translate to MUR / module(1-6) number from geographical endcap system.

virtual void SctConfiguration::Configuration::translateFromPowerSupply unsigned int    partition,
unsigned int    crate,
unsigned int    channel,
unsigned int &    MUR,
unsigned int &    module
[pure virtual]
 

Translate from power supply channel address to MUR / module(1-6) number.

virtual void SctConfiguration::Configuration::translateFromROD unsigned int    partition,
unsigned int    crate,
unsigned int    rod,
unsigned int    channel,
unsigned int &    MUR,
unsigned int &    module
[pure virtual]
 

Translate to MUR / module(1-6) number from p/k/r/c.

virtual void SctConfiguration::Configuration::translateFromRROD unsigned int    partition,
unsigned int    crate,
unsigned int    rod,
unsigned int    channel,
unsigned int &    MUR,
unsigned int &    module
[pure virtual]
 

Translate to MUR / module(1-6) number from address of redundant module.

This returns the MUR/module of the module connected using its redundant link to the p/k/r/c address

virtual void SctConfiguration::Configuration::translateFromSN const std::string    sn,
unsigned int &    MUR,
unsigned int &    module
[pure virtual]
 

Translate to MUR / module(1-6) number from serial number.

virtual void SctConfiguration::Configuration::translateToBarrel unsigned int    MUR,
unsigned int    module,
unsigned int &    barrel,
unsigned int &    row,
int &    number
[pure virtual]
 

Translate from MUR / module(1-6) number to geographical barrel system.

virtual void SctConfiguration::Configuration::translateToEndcap unsigned int    MUR,
unsigned int    module,
unsigned int &    disk,
unsigned int &    ring,
unsigned int &    number
[pure virtual]
 

Translate from MUR / module(1-6) number to geographical endcap system.

virtual void SctConfiguration::Configuration::translateToPowerSupply unsigned int    MUR,
unsigned int    module,
unsigned int &    partition,
unsigned int &    crate,
unsigned int &    channel
[pure virtual]
 

Translate from MUR / module(1-6) number to power supply channel address.

virtual void SctConfiguration::Configuration::translateToROD unsigned int    MUR,
unsigned int    module,
unsigned int &    partition,
unsigned int &    crate,
unsigned int &    rod,
unsigned int &    channel
[pure virtual]
 

Translate from MUR / module(1-6) number to p/k/r/c.

virtual void SctConfiguration::Configuration::translateToRROD unsigned int    MUR,
unsigned int    module,
unsigned int &    partition,
unsigned int &    crate,
unsigned int &    rod,
unsigned int &    channel
[pure virtual]
 

Translate from MUR / redundant module(1-6) number to p/k/r/c.

This returns the channel to which the module referred to by MUR/module is connected in its redundant configuration

virtual void SctConfiguration::Configuration::translateToSN unsigned int    MUR,
unsigned int    module,
std::string &    sn
[pure virtual]
 

Translate from MUR / module(1-6) number to serial number.

virtual void SctConfiguration::Configuration::writePowerSupplyConfiguration std::string    filename [pure virtual]
 

Dump power supply configuration to a file.


The documentation for this class was generated from the following file:
Generated on Mon Dec 8 18:04:24 2003 for SCT DAQ/DCS Software by doxygen1.3-rc3