UsbI2cBus Class Reference

#include <inc/UsbI2cBus.h>

Inheritance diagram for UsbI2cBus:

Public Types
typedef unsigned long	U32
typedef unsigned short	U16
typedef unsigned char	U8
Public Types inherited from Attrib
enum	Attribut {   UNDEFINED, PASSIVE, ACTIVE, INTERFACE,   IO, IODATA, ELEMENT, HARDWARE,   PROCESSUS, SOFTWARE }

Public Member Functions
	UsbI2cBus ()
	Standard constructor. More...
virtual	~UsbI2cBus ()
	Destructor. More...
void	help ()
virtual StatusCode	init ()
void	reset ()
void	update ()
Register *	regAddress ()
Register *	regData ()
virtual StatusCode	read (IOdata *)
virtual StatusCode	write (IOdata *)
Public Member Functions inherited from Interface
	Interface ()
	Standard constructor. More...
virtual	~Interface ()
	Destructor. More...
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 ()

Private Attributes
Register *	m_regAddress
Register *	m_regData

Additional Inherited Members
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 UsbI2cBus.h.

Member Typedef Documentation

U16

typedef unsigned short UsbI2cBus::U16

Definition at line 19 of file UsbI2cBus.h.

U32

typedef unsigned long UsbI2cBus::U32

Definition at line 18 of file UsbI2cBus.h.

U8

typedef unsigned char UsbI2cBus::U8

Definition at line 20 of file UsbI2cBus.h.

Constructor & Destructor Documentation

UsbI2cBus()

UsbI2cBus::UsbI2cBus

(

)

Standard constructor.

Definition at line 17 of file UsbI2cBus.cpp.

References Hierarchy::addChild(), IOdata::Byte, IOdata::defDataU8(), IOobject::io(), m_regAddress, m_regData, IOdata::setAddress(), Object::setName(), Object::setType(), and IOdata::setWordSize().

                       {
  setName("UsbI2cBus");
  setType("UsbI2cBus");

  m_regAddress=new Register();
  m_regData=new Register();

  m_regAddress->setName("AddReg");
  m_regData   ->setName("DataReg");

  m_regAddress->io()->defDataU8(4);
  m_regAddress->io()->setAddress(0);

  m_regData->io()->setAddress(0);

  m_regAddress->io()->setWordSize(IOdata::Byte);
  m_regData   ->io()->setWordSize(IOdata::Byte);

  addChild(m_regAddress);
  addChild(m_regData);
}

~UsbI2cBus()

UsbI2cBus::~UsbI2cBus ( )

virtual

Destructor.

Definition at line 41 of file UsbI2cBus.cpp.

                      {
//  delete m_regData;
//  delete m_regAddress;
}

Member Function Documentation

help()

void UsbI2cBus::help ( )

inlinevirtual

printout help for the element

Implements Interface.

Definition at line 29 of file UsbI2cBus.h.

References Object::info(), init(), and Object::name().

Referenced by BOOST_PYTHON_MODULE().

{ info("UsbI2cBus "+name()+". No help.","UsbI2cBus::help"); };

init()

StatusCode UsbI2cBus::init ( )

virtual

init the component

Returns

void

Implements Interface.

Definition at line 49 of file UsbI2cBus.cpp.

References StatusCode::FAILURE, Object::fatal(), Element::m_connection, Hierarchy::parent(), Element::setConnection(), StatusCode::SUCCESS, and Object::type().

Referenced by BOOST_PYTHON_MODULE(), and help().

                           {
  if (0==m_connection){
    if (0==this->parent()){
      fatal("Cannot define connection for "+type()+". No parent found.",
          "UsbI2cBus::init");
        return StatusCode::FAILURE;
    }
    return setConnection(this->parent());
  }
  else return StatusCode::SUCCESS;
}

read()

StatusCode UsbI2cBus::read ( IOdata *  io )

virtual

Implements Interface.

Definition at line 64 of file UsbI2cBus.cpp.

References IOdata::address(), Element::connection(), IOdata::dataU8(), StatusCode::FAILURE, IOobject::io(), IOdata::length(), Element::m_connection, m_regAddress, m_regData, Interface::read(), IOdata::setDataU8(), StatusCode::SUCCESS, Object::warning(), and Interface::write().

Referenced by regData().

                                    {
  U8* buffer=m_regAddress->io()->dataU8();
  buffer[0]=(U8)(io->address());
  buffer[1]=(U8)(0);
  buffer[2]=(U8)(0);
  buffer[3]=(U8)(0);
  m_regData->io()->setDataU8(io->dataU8(),io->length());
  Interface* connection = dynamic_cast<Interface*> (m_connection);
  if (connection->write(m_regAddress->io()).isFailure()){
    warning("Cannot write Address register on UsbI2cBus",
      "UsbI2cBus::read");
    return StatusCode::FAILURE;
  }
  if (connection->read(m_regData->io()).isFailure()){
    warning("Cannot read Data register on UsbI2cBus",
        "UsbI2cBus::read");  ;
    return StatusCode::FAILURE;
  }
  return StatusCode::SUCCESS;
}

regAddress()

Register* UsbI2cBus::regAddress ( )

inline

Definition at line 54 of file UsbI2cBus.h.

References m_regAddress.

Referenced by BOOST_PYTHON_MODULE(), and Proto40MHz_v1::Proto40MHz_v1().

                         {
    return m_regAddress;
  };

regData()

Register* UsbI2cBus::regData ( )

inline

Definition at line 58 of file UsbI2cBus.h.

References m_regData, read(), and write().

Referenced by BOOST_PYTHON_MODULE(), and Proto40MHz_v1::Proto40MHz_v1().

                      {
    return m_regData;
  };

reset()

void UsbI2cBus::reset ( )

inlinevirtual

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 Interface.

Definition at line 45 of file UsbI2cBus.h.

References Object::info(), and Object::name().

Referenced by BOOST_PYTHON_MODULE().

{ info("UsbI2cBus "+name()+" reset.","UsbI2cBus::reset");};

update()

void UsbI2cBus::update ( )

inlinevirtual

Update the Element configuration from the actual hardware

Implements Interface.

Definition at line 50 of file UsbI2cBus.h.

References Object::info(), and Object::name().

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().

                 {
    info("UsbI2cBus "+name()+". Nothing to do.","UsbI2cBus::update");
  };

write()

StatusCode UsbI2cBus::write ( IOdata *  io )

virtual

Implements Interface.

Definition at line 88 of file UsbI2cBus.cpp.

References IOdata::address(), Element::connection(), IOdata::dataU8(), StatusCode::FAILURE, IOobject::io(), IOdata::length(), Element::m_connection, m_regAddress, m_regData, IOdata::setDataU8(), StatusCode::SUCCESS, Object::warning(), and Interface::write().

Referenced by regData().

                                     {
  U8* buffer=m_regAddress->io()->dataU8();
  buffer[0]=(U8)(io->address());
  buffer[1]=(U8)(0);
  buffer[2]=(U8)(0);
  buffer[3]=(U8)(0);
  m_regData->io()->setDataU8(io->dataU8(),io->length());
  Interface* connection = dynamic_cast<Interface*> (m_connection);
  if (connection->write(m_regAddress->io()).isFailure()){
    warning("Cannot write Address register on UsbI2cBus",
        "UsbI2cBus::write");
    return StatusCode::FAILURE;
  }
  if (connection->write(m_regData->io()).isFailure()){
    warning("Cannot write Data register on UsbI2cBus","UsbI2cBus::write");
    return StatusCode::FAILURE;
  }
  return StatusCode::SUCCESS;
}

Member Data Documentation

m_regAddress

Register* UsbI2cBus::m_regAddress

private

Definition at line 69 of file UsbI2cBus.h.

Referenced by read(), regAddress(), UsbI2cBus(), and write().

m_regData

Register* UsbI2cBus::m_regData

private

Definition at line 70 of file UsbI2cBus.h.

Referenced by read(), regData(), UsbI2cBus(), and write().

---

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

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