Element Class Reference

#include <inc/Element.h>

Inheritance diagram for Element:

Public Member Functions
	Element ()
	Standard constructor. More...
virtual	~Element ()
	Destructor. More...
virtual void	help ()=0
virtual StatusCode	init ()=0
virtual void	reset ()=0
void	recursiveInitElement ()
void	recursiveInitCommunications ()
virtual void	update ()=0
StatusCode	setConnection (Hierarchy *)
Hierarchy *	connection ()
Public Member Functions inherited from Hierarchy
	Hierarchy ()
	Standard constructor. More...
virtual	~Hierarchy ()
	Destructor. More...
void	clear ()
void	setParent (Hierarchy *parent)
Hierarchy *	parent ()
Hierarchy *	parent (std::string)
Hierarchy *	origin ()
virtual void	addChild (Hierarchy *element)
std::vector< Hierarchy * >	children ()
Hierarchy *	child (std::string)
Hierarchy *	childTyped (std::string)
unsigned long	numberOfChildren ()
bool	hasChildren ()
void	delChild (Hierarchy *)
void	delChild (std::string)
std::string	path (std::string=std::string(""))
std::string	pathTyped (std::string=std::string(""))
void	tree (std::string indent=std::string(""))
void	tree ()
Public Member Functions inherited from Object
	Object ()
	Standard constructor. More...
virtual	~Object ()
	Destructor. More...
std::string	name () const
std::string	type ()
unsigned char	id ()
std::string	title ()
void	msgSvc (int level, std::string msg, std::string name)
void	msg (std::string mymsg)
void	verbose (std::string mymsg)
void	debug (std::string mymsg)
void	info (std::string mymsg)
void	warning (std::string mymsg)
void	error (std::string mymsg)
void	fatal (std::string mymsg)
void	msg (std::string mymsg, std::string name)
void	verbose (std::string mymsg, std::string name)
void	debug (std::string mymsg, std::string name)
void	info (std::string mymsg, std::string name)
void	warning (std::string mymsg, std::string name)
void	error (std::string mymsg, std::string name)
void	fatal (std::string mymsg, std::string name)
void	setName (std::string name)
void	setType (std::string type)
void	setId (unsigned char id)
void	setTitle (std::string title)
void	setDllName (std::string dllName)
std::string	dllName ()
Public Member Functions inherited from Attrib
	Attrib ()
	Standard constructor. More...
virtual	~Attrib ()
	Destructor. More...
bool	is (int attribut)
void	add (int attribut)
void	remove (int attribut)
std::string	attributs ()

Protected Attributes
Hierarchy *	m_connection
Protected Attributes inherited from Attrib
std::string	m_attribString [10]

Additional Inherited Members
Public Types inherited from Attrib
enum	Attribut {   UNDEFINED, PASSIVE, ACTIVE, INTERFACE,   IO, IODATA, ELEMENT, HARDWARE,   PROCESSUS, SOFTWARE }

Detailed Description

Author

Date

2006-10-23

Definition at line 14 of file Element.h.

Constructor & Destructor Documentation

Element()

Element::Element

(

)

Standard constructor.

Definition at line 19 of file Element.cpp.

References m_connection.

{
  m_connection=0;
}

~Element()

Element::~Element ( )

virtual

Destructor.

Definition at line 26 of file Element.cpp.

                  {
}

Member Function Documentation

connection()

Hierarchy * Element::connection

(

)

Get IO interface

Definition at line 84 of file Element.cpp.

References m_connection, Object::name(), and Object::warning().

Referenced by UsbSpiBus::clockDivider(), export_obj(), UsbI2cBus::read(), IOobject::read(), UsbSpiBus::read(), UsbSpiBus::setClockDivider(), setConnection(), UsbI2cBus::write(), IOobject::write(), and UsbSpiBus::write().

                              {
  if (0==m_connection){
    warning("no connection defined for "+name()+".","Element::connection");
    return (Hierarchy*)0;
  }
  return m_connection;
}

help()

virtual void Element::help ( )

pure virtual

printout help for the element

Implemented in A3PE, LSDelayChipV1, ICECALv3, ICPhaser, MSOxxxx, Phaser, UsbFTInterface, UsbFTMLInterface, SpecsInterface, SpecsMaster, SpecsParallelBus, Computer, NI6008, FePGA, SeqPGA, DCU, SpecsMezzanine, Proto40MHz_v1, FEB_v1, IOobject, UsbSpiBus, CU_v1, UsbI2cBus, UsbMLI2cBus, UsbMLSpiBus, Interface, RAM, SpecsGlue, Croc, ElementWrap, and InterfaceWrap.

Referenced by export_obj().

init()

virtual StatusCode Element::init ( )

pure virtual

init the component

Returns

void

Implemented in A3PE, LSDelayChipV1, ICECALv3, ICPhaser, MSOxxxx, Phaser, UsbFTInterface, UsbFTMLInterface, SpecsInterface, SpecsMaster, IOobject, SpecsSlave, SpecsParallelBus, Computer, NI6008, FePGA, SeqPGA, DCU, Proto40MHz_v1, FEB_v1, UsbSpiBus, UsbI2cBus, CU_v1, UsbMLI2cBus, UsbMLSpiBus, Interface, Croc, ElementWrap, and InterfaceWrap.

Referenced by export_obj(), and recursiveInitElement().

recursiveInitCommunications()

void Element::recursiveInitCommunications

(

)

Triggers a recursive call to initCommunications() for the full hierarchy

Returns

void

Definition at line 44 of file Element.cpp.

References Hierarchy::children().

Referenced by export_obj().

                                         {
  std::vector<Hierarchy*> list = children();
  std::vector<Hierarchy*>::const_iterator iter;
  for (iter=list.begin();iter!=list.end();iter++){
    dynamic_cast<Element*>((*iter))->recursiveInitCommunications();
  }
}

recursiveInitElement()

void Element::recursiveInitElement

(

)

Triggers a recursive call to init() for the full hierarchy

Returns

void

Definition at line 32 of file Element.cpp.

References Hierarchy::children(), and init().

Referenced by export_obj().

                                  {
  init();
  std::vector<Hierarchy*> list = children();
  std::vector<Hierarchy*>::iterator iter;
  for (iter=list.begin() ; iter!=list.end() ; ++iter){
    dynamic_cast<Element*>((*iter))->recursiveInitElement();
  }
}

reset()

virtual void Element::reset ( )

pure virtual

Resets the Element so that is is in a standard and safe situation. Different from Element::init which configure the Element. Element::reset() is more an Emergency pull. It is often/usually called by the recursiveInitElement method at the start of the program.

Implemented in A3PE, LSDelayChipV1, ICECALv3, ICPhaser, MSOxxxx, Phaser, UsbFTInterface, UsbFTMLInterface, NI6008, SpecsInterface, SpecsMaster, SpecsSlave, SpecsParallelBus, Computer, FePGA, SeqPGA, Proto40MHz_v1, FEB_v1, CU_v1, UsbSpiBus, UsbMLI2cBus, UsbMLSpiBus, UsbI2cBus, Croc, Interface, IOobject, DCU, ElementWrap, and InterfaceWrap.

Referenced by export_obj().

setConnection()

StatusCode Element::setConnection

(

Hierarchy *

connection

)

Define IO interface

Definition at line 55 of file Element.cpp.

References connection(), Object::debug(), StatusCode::FAILURE, Object::fatal(), Attrib::INTERFACE, Attrib::is(), m_connection, Object::name(), Hierarchy::parent(), StatusCode::SUCCESS, and Object::type().

Referenced by export_obj(), UsbMLSpiBus::init(), UsbMLI2cBus::init(), UsbI2cBus::init(), UsbSpiBus::init(), and IOobject::init().

                                                      {
  if (0==connection){
    fatal("Try to define a connection with a null pointer.",
        "Element::setConnection");
    return StatusCode::FAILURE;
  }
  if (connection->is(Attrib::INTERFACE)){
    m_connection=dynamic_cast<Hierarchy*>(connection);
    return StatusCode::SUCCESS;
  }
  else {
    debug(connection->name()+
        " is not a Attrib::INTERFACE hardware. Connection refused.",
        "Element::setConnection");
    if (0!=connection->parent()){
      return setConnection(connection->parent());
    }
    else{
      fatal("Could not find a connection for element "+
          name()+"["+type()+"].","element::setConnection");
      return StatusCode::FAILURE;
    }
  }
}

update()

virtual void Element::update ( )

pure virtual

Update the Element configuration from the actual hardware

Implemented in A3PE, LSDelayChipV1, ICECALv3, ICPhaser, MSOxxxx, UsbFTInterface, UsbFTMLInterface, Phaser, FePGA, NI6008, SpecsInterface, SeqPGA, SpecsMaster, SpecsParallelBus, FEB_v1, Computer, Proto40MHz_v1, CU_v1, UsbMLI2cBus, UsbMLSpiBus, UsbSpiBus, UsbI2cBus, Croc, IOobject, Interface, DCU, ElementWrap, and InterfaceWrap.

Referenced by AppFrame.AppFrame::deleteHardware(), export_obj(), ConfFrame.ConfFrame::onChange(), GraphFrame.GraphFrame::onChange(), CfgFrame.CfgFrame::onChange(), ConfFrame.ConfFrame::onEdit(), AppFrame.AppFrame::onLoad(), ConfFrame.ConfFrame::onReLoad(), GraphFrame.GraphFrame::onReLoad(), CfgFrame.CfgFrame::onReLoad(), and AppFrame.AppFrame::onReLoad().

Member Data Documentation

m_connection

Hierarchy* Element::m_connection

protected

Definition at line 70 of file Element.h.

Referenced by UsbSpiBus::clockDivider(), connection(), Element(), UsbMLI2cBus::init(), UsbMLSpiBus::init(), UsbI2cBus::init(), UsbSpiBus::init(), IOobject::init(), UsbI2cBus::read(), UsbSpiBus::read(), UsbSpiBus::setClockDivider(), setConnection(), UsbI2cBus::write(), and UsbSpiBus::write().

---

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

• /home/eleclhcb/LHCb/lbcat-cmake/CatKernel/inc/Element.h
• /home/eleclhcb/LHCb/lbcat-cmake/CatKernel/src/Element.cpp