Basda::UniModCard Class Reference

#include <Card.h>

Inheritance diagram for Basda::UniModCard:

Collaboration diagram for Basda::UniModCard:

Classes
struct	UniModCardEvent
	This is the implementation of the handler for the incoming events and function errors. More...

Public Member Functions
	UniModCard (std::string _name, Nice::JointPtr _config, MPIACoreProtocolPtr &_protocol)
virtual	~UniModCard ()
void	lockCard ()
	This method lock the card for an exclusive access for one client. More...
void	unlockCard ()
	This method unlock the card. More...
std::string	getModules ()
	UniModCard (std::string _name, Nice::JointPtr _config, MPIACoreProtocolPtr &_protocol)
virtual	~UniModCard ()
void	lockCard ()
	This method lock the card for an exclusive access for one client. More...
void	unlockCard ()
	This method unlock the card. More...
std::string	getModules ()
Public Member Functions inherited from Basda::MPIACoreCard
	MPIACoreCard (std::string _name, Nice::JointPtr _config, Basda::MPIACoreProtocolPtr _protocol)
	Constructor. More...
	~MPIACoreCard ()
	Destructor. More...
std::string	version ()
	The methods returns the current version string of the MPIA in-house electronic. More...
std::vector< unsigned int >	getRegistration ()
	The methods returns all registered module and card that are registered at the MPIA in-house electronic. More...
void	reset ()
	Resets the MPIA in-house electronic software and hardware. More...
void	setXonXoff (const ValueSwitch::Constant _enable)
	Enables/disables the XOnXOff protocol. More...
bool	getXonXoff ()
	Returns the status of the XOnXOff protocol. More...
void	setSerialRate (const ValueSerialRate::Constant _baudRate)
	Sets the baud rate of the serial interface. More...
unsigned int	getSerialRate ()
	Returns the current baud rate. More...
void	setCANRate (const ValueCanRate::Constant _canRate)
	Sets the CAN rate of the CAN bus. More...
unsigned int	getCANRate ()
	Returns the current CAN rate. More...
void	setEventFlag (const ValueSwitch::Constant _eventMode)
	Sets the event message flag. More...
bool	getEventFlag ()
	Returns the current event message flags. More...
void	setInfoFlag (const ValueSwitch::Constant _infoMode)
	Sets the event message flag. More...
bool	getInfoFlag ()
	Returns the current event message flags. More...
void	setIPAddress (const std::string _ip)
	Sets the IP address of the MPIA in-house electronic. More...
std::string	getIPAddress ()
	Returns the current IP address. More...
void	setGateAddress (const std::string _gate)
	Sets the gate address of the MPIA in-house electronic. More...
std::string	getGateAddress ()
	Returns the current gate address. More...
void	setMaskAddress (const std::string _mask)
	Sets the mask address of the MPIA in-house electronic. More...
std::string	getMaskAddress ()
	Returns the current mask address. More...
void	setLinkTimeout (const unsigned int _timeout)
	Sets the Ethernet connection timeout. More...
int	getLinkTimeout ()
	Returns the Ethernet connection timeout. More...
void	waitForEvent ()
	Waits until an event is received in a certain time (timeout). More...
std::string	getFatalError ()
	Returns the fatal error message. More...
void	resetFatalError ()
	Resets the fatal error. More...
	MPIACoreCard (std::string _name, Nice::JointPtr _config, Basda::MPIACoreProtocolPtr _protocol)
	Constructor. More...
	~MPIACoreCard ()
	Destructor. More...
std::string	version ()
	The methods returns the current version string of the MPIA in-house electronic. More...
std::vector< unsigned int >	getRegistration ()
	The methods returns all registered module and card that are registered at the MPIA in-house electronic. More...
void	reset ()
	Resets the MPIA in-house electronic software and hardware. More...
void	setXonXoff (const ValueSwitch::Constant _enable)
	Enables/disables the XOnXOff protocol. More...
bool	getXonXoff ()
	Returns the status of the XOnXOff protocol. More...
void	setSerialRate (const ValueSerialRate::Constant _baudRate)
	Sets the baud rate of the serial interface. More...
unsigned int	getSerialRate ()
	Returns the current baud rate. More...
void	setCANRate (const ValueCanRate::Constant _canRate)
	Sets the CAN rate of the CAN bus. More...
unsigned int	getCANRate ()
	Returns the current CAN rate. More...
void	setEventFlag (const ValueSwitch::Constant _eventMode)
	Sets the event message flag. More...
bool	getEventFlag ()
	Returns the current event message flags. More...
void	setInfoFlag (const ValueSwitch::Constant _infoMode)
	Sets the event message flag. More...
bool	getInfoFlag ()
	Returns the current event message flags. More...
void	setIPAddress (const std::string _ip)
	Sets the IP address of the MPIA in-house electronic. More...
std::string	getIPAddress ()
	Returns the current IP address. More...
void	setGateAddress (const std::string _gate)
	Sets the gate address of the MPIA in-house electronic. More...
std::string	getGateAddress ()
	Returns the current gate address. More...
void	setMaskAddress (const std::string _mask)
	Sets the mask address of the MPIA in-house electronic. More...
std::string	getMaskAddress ()
	Returns the current mask address. More...
void	setLinkTimeout (const unsigned int _timeout)
	Sets the Ethernet connection timeout. More...
int	getLinkTimeout ()
	Returns the Ethernet connection timeout. More...
void	waitForEvent ()
	Waits until an event is received in a certain time (timeout). More...
std::string	getFatalError ()
	Returns the fatal error message. More...
void	resetFatalError ()
	Resets the fatal error. More...

Private Types
typedef IceUtil::Handle< UniModCardEvent >	UniModCardEventPtr
typedef IceUtil::Handle< UniModCardEvent >	UniModCardEventPtr

Private Member Functions
void	addInternalProperties ()
	This method add some internal properties like command properties or status properties. More...
void	addInternalProperties ()
	This method add some internal properties like command properties or status properties. More...

Additional Inherited Members
Protected Member Functions inherited from Basda::MPIACore
	MPIACore (std::string _name, Nice::JointPtr _config, const MPIACoreProtocolPtr _protocol)
	~MPIACore ()
template<typename Type >
Type	checkAttribute (const std::string &_node, const std::string &_attributeName, const Type &_default)
template<typename RT >
std::vector< RT >	getVector (const std::string &_str)
	This is a generic method to convert a data string to a vector. More...
std::string	name ()
	MPIACore (std::string _name, Nice::JointPtr _config, const MPIACoreProtocolPtr _protocol)
	~MPIACore ()
template<typename Type >
Type	checkAttribute (const std::string &_node, const std::string &_attributeName, const Type &_default)
template<typename RT >
std::vector< RT >	getVector (const std::string &_str)
	This is a generic method to convert a data string to a vector. More...
std::string	name ()
Static Protected Member Functions inherited from Basda::MPIACore
template<typename RT >
static RT	getValue (const std::string &_str)
	This is a generic method to convert a data string to a number. More...
template<typename RT >
static RT	getValue (const std::string &_str)
	This is a generic method to convert a data string to a number. More...
Protected Attributes inherited from Basda::MPIACore
std::string	m_name
std::string	m_address
	member of the connection address More...
unsigned int	m_cardNo
	member of the card number More...
unsigned int	m_moduleNo
	member of the module number More...
HandlerPtr	m_handler
MPIACoreProtocolPtr	m_protocol
	member of the protocol to communicate with the MPIA in-house electronic. More...
Nice::JointPtr	m_config
	member of the root of the configuration tree More...
bool	m_warning

Member Typedef Documentation

UniModCardEventPtr [1/2]

typedef IceUtil::Handle<UniModCardEvent> Basda::UniModCard::UniModCardEventPtr

private

UniModCardEventPtr [2/2]

typedef IceUtil::Handle<UniModCardEvent> Basda::UniModCard::UniModCardEventPtr

private

Constructor & Destructor Documentation

UniModCard() [1/2]

Basda::UniModCard::UniModCard	(	std::string	_name,
		Nice::JointPtr	_config,
		MPIACoreProtocolPtr &	_protocol
	)

~UniModCard() [1/2]

virtual Basda::UniModCard::~UniModCard ( )

inlinevirtual

UniModCard() [2/2]

Basda::UniModCard::UniModCard	(	std::string	_name,
		Nice::JointPtr	_config,
		MPIACoreProtocolPtr &	_protocol
	)

~UniModCard() [2/2]

virtual Basda::UniModCard::~UniModCard ( )

inlinevirtual

Member Function Documentation

addInternalProperties() [1/2]

void Basda::UniModCard::addInternalProperties ( )

private

This method add some internal properties like command properties or status properties.

addInternalProperties() [2/2]

void Basda::UniModCard::addInternalProperties ( )

private

This method add some internal properties like command properties or status properties.

getModules() [1/2]

std::string Basda::UniModCard::getModules

(

)

getModules() [2/2]

std::string Basda::UniModCard::getModules

(

)

lockCard() [1/2]

void Basda::UniModCard::lockCard

(

)

This method lock the card for an exclusive access for one client.

All methods will be lock till the client with the exclusive access unlock this object.

Exceptions

Basda::MPIA::ModuleIsInUseException

lockCard() [2/2]

void Basda::UniModCard::lockCard

(

)

This method lock the card for an exclusive access for one client.

All methods will be lock till the client with the exclusive access unlock this object.

Exceptions

Basda::MPIA::ModuleIsInUseException

unlockCard() [1/2]

void Basda::UniModCard::unlockCard

(

)

This method unlock the card.

All methods will be unlocked. This can be done only by that client which has exclusive access.

Exceptions

Basda::MPIA::ModuleIsInUseException

unlockCard() [2/2]

void Basda::UniModCard::unlockCard

(

)

This method unlock the card.

All methods will be unlocked. This can be done only by that client which has exclusive access.

Exceptions

Basda::MPIA::ModuleIsInUseException

---

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

• TwiceAsNice/basda-mocca/doc/include/unimod/Card.h
• TwiceAsNice/basda-mocca/doc/include/unimod/Card.cc