Interface Class Reference

#include <inc/Interface.h>

Inheritance diagram for Interface:

Public Member Functions
	Interface ()
	Standard constructor. More...
virtual	~Interface ()
	Destructor. More...
virtual void	help ()=0
virtual StatusCode	init ()=0
virtual void	reset ()=0
virtual void	update ()=0
virtual StatusCode	read (IOdata *)=0
virtual StatusCode	write (IOdata *)=0
Public Member Functions inherited from Element
	Element ()
	Standard constructor. More...
virtual	~Element ()
	Destructor. More...
void	recursiveInitElement ()
void	recursiveInitCommunications ()
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 ()

Additional Inherited Members
Public Types inherited from Attrib
enum	Attribut {   UNDEFINED, PASSIVE, ACTIVE, INTERFACE,   IO, IODATA, ELEMENT, HARDWARE,   PROCESSUS, SOFTWARE }
Protected Attributes inherited from Element
Hierarchy *	m_connection
Protected Attributes inherited from Attrib
std::string	m_attribString [10]

Detailed Description

Author

Date

2006-10-23

Definition at line 16 of file Interface.h.

Constructor & Destructor Documentation

Interface()

Interface::Interface

(

)

Standard constructor.

Definition at line 18 of file Interface.cpp.

References Attrib::add(), Attrib::ELEMENT, Attrib::INTERFACE, Object::setName(), and Object::setType().

                       {
  setName("Interface");
  setType("Interface");
  add(Attrib::ELEMENT); add(Attrib::INTERFACE);
}

~Interface()

Interface::~Interface ( )

virtual

Destructor.

Definition at line 26 of file Interface.cpp.

{}

Member Function Documentation

help()

virtual void Interface::help ( )

pure virtual

printout help for the element

Implements Element.

Implemented in UsbFTInterface, UsbFTMLInterface, SpecsInterface, SpecsParallelBus, SpecsMezzanine, UsbSpiBus, UsbI2cBus, SpecsGlue, and InterfaceWrap.

Referenced by BOOST_PYTHON_MODULE().

init()

virtual StatusCode Interface::init ( )

pure virtual

init the component

Returns

void

Implements Element.

Implemented in UsbFTInterface, UsbFTMLInterface, SpecsInterface, SpecsSlave, SpecsParallelBus, UsbSpiBus, UsbI2cBus, and InterfaceWrap.

Referenced by BOOST_PYTHON_MODULE().

read()

virtual StatusCode Interface::read ( IOdata *  )

pure virtual

Implemented in SpecsInterface, UsbFTInterface, UsbFTMLInterface, UsbSpiBus, UsbI2cBus, and InterfaceWrap.

Referenced by BOOST_PYTHON_MODULE(), UsbSpiBus::clockDivider(), UsbI2cBus::read(), and UsbSpiBus::read().

reset()

virtual void Interface::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.

Implements Element.

Implemented in UsbFTInterface, UsbFTMLInterface, SpecsInterface, SpecsSlave, SpecsParallelBus, UsbSpiBus, UsbI2cBus, and InterfaceWrap.

Referenced by BOOST_PYTHON_MODULE().

update()

virtual void Interface::update ( )

pure virtual

Update the Element configuration from the actual hardware

Implements Element.

Implemented in UsbFTInterface, UsbFTMLInterface, SpecsInterface, SpecsParallelBus, UsbSpiBus, UsbI2cBus, and InterfaceWrap.

Referenced by BOOST_PYTHON_MODULE(), AppFrame.AppFrame::deleteHardware(), 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().

write()

virtual StatusCode Interface::write ( IOdata *  )

pure virtual

Implemented in SpecsInterface, UsbFTInterface, UsbFTMLInterface, UsbSpiBus, UsbI2cBus, and InterfaceWrap.

Referenced by BOOST_PYTHON_MODULE(), UsbI2cBus::read(), UsbSpiBus::read(), UsbSpiBus::setClockDivider(), UsbI2cBus::write(), and UsbSpiBus::write().

---

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

• /home/eleclhcb/LHCb/lbcat-cmake/CatCore/inc/Interface.h
• /home/eleclhcb/LHCb/lbcat-cmake/CatCore/src/Interface.cpp