objectclasses::SubSystem Class Reference

Inheritance diagram for objectclasses::SubSystem:

Detailed Description

Class for properties and methods for individual subsystems such as Muon and TFC. Valid subsystems are given in CdbVisCore module in the allvalidsystems global variable.

Definition at line 413 of file objectclasses.py.


Public Member Functions
def	__init__
def	GetLinkTypeTable
def	GetDeviceTable
def	GetName
def	GetDescription
def	GetXPos
def	GetYPos
def	GetWidth
def	GetHeight
def	GetColour
def	GetRotate
def	GetErrorMessage
def	SetName
def	SetColour
def	SetErrorMessage
def	GetObjectInfo
def	IsCreated
def	GetAllDevices
def	GetDeviceTypes
def	GetLinkTypes
def	Modify
def	Create
Private Attributes
	__name
	__cfg
	__deviceTypes
	__devices
	__linkTypes
	__linkTypeTable
	__deviceTable
	__created
	__description
	__xPos
	__yPos
	__width
	__height
	__colour
	__rotate
	__errormessage

Member Function Documentation

def objectclasses::SubSystem::__init__	(	self,
		configFile,
		subsystemname = `""`
	)

Constructor.

Parameters: - instance of the configurations file that we have loaded - name of the subsystem this instance will contain information about and act on

Definition at line 422 of file objectclasses.py.

def objectclasses::SubSystem::GetLinkTypeTable ( self )

Definition at line 449 of file objectclasses.py.

def objectclasses::SubSystem::GetDeviceTable ( self )

Definition at line 451 of file objectclasses.py.

def objectclasses::SubSystem::GetName ( self )

Definition at line 454 of file objectclasses.py.

def objectclasses::SubSystem::GetDescription ( self )

Definition at line 456 of file objectclasses.py.

def objectclasses::SubSystem::GetXPos ( self )

Definition at line 458 of file objectclasses.py.

def objectclasses::SubSystem::GetYPos ( self )

Definition at line 460 of file objectclasses.py.

def objectclasses::SubSystem::GetWidth ( self )

Definition at line 462 of file objectclasses.py.

def objectclasses::SubSystem::GetHeight ( self )

Definition at line 464 of file objectclasses.py.

def objectclasses::SubSystem::GetColour ( self )

Definition at line 466 of file objectclasses.py.

def objectclasses::SubSystem::GetRotate ( self )

Definition at line 468 of file objectclasses.py.

def objectclasses::SubSystem::GetErrorMessage ( self )

Get the error message that was set most recently.

!return - the error message string

Reimplemented from objectclasses::DBInfo.

Definition at line 471 of file objectclasses.py.

def objectclasses::SubSystem::SetName	(	self,
		name
	)

Definition at line 475 of file objectclasses.py.

def objectclasses::SubSystem::SetColour	(	self,
		colour
	)

Definition at line 477 of file objectclasses.py.

def objectclasses::SubSystem::SetErrorMessage	(	self,
		msg
	)

Set the error message so that it can be looked up. - the message string

Reimplemented from objectclasses::DBInfo.

Definition at line 479 of file objectclasses.py.

def objectclasses::SubSystem::GetObjectInfo ( self )

Get all information needed about a subsystem. The information is stored in the configuration file.

Reimplemented from objectclasses::DBInfo.

Definition at line 485 of file objectclasses.py.

def objectclasses::SubSystem::IsCreated ( self )

We can disable a subsystem (not visible to the user) by setting created=False in the configuration file. This function checks whether this variable is set to True or False.

!return - True if the subsystem is created and available, False otherwise.

Definition at line 494 of file objectclasses.py.

def objectclasses::SubSystem::GetAllDevices ( self )

Get all devices in the given subsystem.

!return - a list of devices available in a subsystem if successful, an empty list if none found, and False if an error occurs.

Definition at line 512 of file objectclasses.py.

def objectclasses::SubSystem::GetDeviceTypes	(	self,
		onlyfromdb = `False`,
		onlyfromdl = `False`
	)

Return list of device types found in the given subsystem.

Parameters: - If true we only look for device types in the ConfDB - If true we only look for device types in the Dirty Objects List

Only one of the parameters can be true, both can be false.

!return - list of device types (string names) if successful, an empty list if none found and False if an error occurs,

Definition at line 558 of file objectclasses.py.

def objectclasses::SubSystem::GetLinkTypes	(	self,
		onlyfromdb = `False`,
		onlyfromdl = `False`
	)

Return list of link types found in the given subsystem. (Obsolete: actually we look for link types in the LHCb system because there are not that many different link types).

Parameters: - If true we only look for link types in the ConfDB - If true we only look for link types in the Dirty Objects List

Only one of the parameters can be true, both can be false.

!return - list of link types (string names) if successful, an empty list if none found and False if an error occurs,

Definition at line 643 of file objectclasses.py.

def objectclasses::SubSystem::Modify ( self )

Modify an already created sub system

Reimplemented from objectclasses::DBInfo.

Definition at line 721 of file objectclasses.py.

def objectclasses::SubSystem::Create ( self )

Kind of obsolete.

Sets some settings in the configuration database for a newly created subsystem in CdbVis. But this feature is no longer accessible for the user. Should only be done manually through editing the configuration file in a text editor

Reimplemented from objectclasses::DBInfo.

Definition at line 732 of file objectclasses.py.