Device Class Reference

Abstract device class. More...

#include <device.hh>

List of all members.

Public Member Functions
virtual	~Device ()
	Virtual destructor.
virtual const string &	nomen () const =0
	Get nomenclature of device.
virtual const string &	eqMod () const =0
	Get equipment model of device.
virtual const string &	eqModVersion () const =0
	Get equipment model version of device.
virtual AccDevRetStatus	read (const Property &property, SLong vrtAcc, const AccData &para, AccData &data, AccStamp &stamp, AccEFICD &eficd)=0
	Synchronous read.
virtual AccDevRetStatus	write (const Property &property, SLong vrtAcc, const AccData &para, const AccData &data)=0
	Synchronous write.
virtual AccDevRetStatus	call (const Property &property, SLong vrtAcc, const AccData &para)=0
	Synchronous call.
virtual AsynchId	requestRead (const Property &property, SLong vrtAcc, const AccData &para, Callback *cb)=0
	Asynchronous read request One asynchronous answer via callback.
virtual AsynchId	requestWrite (const Property &property, SLong vrtAcc, const AccData &para, const AccData &data, Callback *cb)=0
	Asynchronous write request One asynchronous answer via callback.
virtual AsynchId	requestCall (const Property &property, SLong vrtAcc, const AccData &para, Callback *cb)=0
	Asynchronous call request One asynchronous answer via callback.
virtual void	cancelRequest (const AsynchId &asyncId)=0
	Cancel request.
virtual AsynchId	connectRead (const Property &property, SLong vrtAcc, const AccData &para, const Connection &con, Callback *cb)=0
	Asynchronous read connection One or more asynchronous answers via callback.
virtual AsynchId	connectWrite (const Property &property, SLong vrtAcc, const AccData &para, const AccData &data, const Connection &con, Callback *cb)=0
	Asynchronous write connection One or more asynchronous answers via callback.
virtual AsynchId	connectCall (const Property &property, SLong vrtAcc, const AccData &para, const Connection &con, Callback *cb)=0
	Asynchronous call connection One or more asynchronous answers via callback.
virtual void	disconnect (const AsynchId &asyncId)=0
	Disconnect a connection.

---

Detailed Description

Abstract device class.

This class defines the application program interface to the accelerator devices.

Author:

L. Hechler

K.Hoeppner

Version:

2.0

Date:

2. Dec. 2005

---

Constructor & Destructor Documentation

virtual ~Device

(

)

[inline, virtual]

Virtual destructor.

---

Member Function Documentation

virtual AccDevRetStatus call	(	const Property &	property,
		SLong	vrtAcc,
		const AccData &	para
	)			[pure virtual]

Synchronous call.

Parameters:

	property	Property
	vrtAcc	Virtual accelerator
	para	Parameter

Returns:

Success or informational messages

Exceptions:

AccDevException

All warnings, errors or fatal errors

virtual void cancelRequest

(

const AsynchId &

asyncId

)

[pure virtual]

Cancel request.

Cancel a request that was setup using one of the methods requestRead(), requestWrite() or requestCall().

On successful return of cancelRequest(), it is guaranteed that no user callback method (response(), readResponse()) is active any more.

Parameters:

asyncId

ID of requested command to be cancelled.

Exceptions:

AccDevException

All warnings, errors or fatal errors. If primStat() of exception is ODA-W-DISCONNUNSAFE, user's callback may still be active.

virtual AsynchId connectCall	(	const Property &	property,
		SLong	vrtAcc,
		const AccData &	para,
		const Connection &	con,
		Callback *	cb
	)			[pure virtual]

Asynchronous call connection One or more asynchronous answers via callback.

Parameters:

	property	Property
	vrtAcc	Virtual accelerator
	para	Parameter
	con	Connection specification
	cb	Callback, method response() will be called

Returns:

Success or informational messages

Exceptions:

AccDevException

All warnings, errors or fatal errors

virtual AsynchId connectRead	(	const Property &	property,
		SLong	vrtAcc,
		const AccData &	para,
		const Connection &	con,
		Callback *	cb
	)			[pure virtual]

Asynchronous read connection One or more asynchronous answers via callback.

Parameters:

	property	Property
	vrtAcc	Virtual accelerator
	para	Parameter
	con	Connection specification
	cb	Callback, method readResponse() will be called

Returns:

Success or informational messages

Exceptions:

AccDevException

All warnings, errors or fatal errors

virtual AsynchId connectWrite	(	const Property &	property,
		SLong	vrtAcc,
		const AccData &	para,
		const AccData &	data,
		const Connection &	con,
		Callback *	cb
	)			[pure virtual]

Asynchronous write connection One or more asynchronous answers via callback.

Parameters:

	property	Property
	vrtAcc	Virtual accelerator
	para	Parameter
	data	Data
	con	Connection specification
	cb	Callback, method response() will be called

Returns:

Success or informational messages

Exceptions:

AccDevException

All warnings, errors or fatal errors

virtual void disconnect

(

const AsynchId &

asyncId

)

[pure virtual]

Disconnect a connection.

Disconnect a connecion that was setup using one of the methods connectRead(), connectWrite() or connectCall().

On successful return of disconnect(), it is guaranteed that no user callback method (response(), readResponse()) is active any more. Keep in mind that this is true only if no other connection uses this callback object too.

Parameters:

asyncId

ID of requested command to be cancelled.

Exceptions:

AccDevException

All warnings, errors or fatal errors. If primStat() of exception is ODA-W-DISCONNUNSAFE, user's callback may still be active.

virtual const string& eqMod

(

)

const [pure virtual]

Get equipment model of device.

Returns:

Equipment model of device

virtual const string& eqModVersion

(

)

const [pure virtual]

Get equipment model version of device.

Returns:

Equipment model version of device

virtual const string& nomen

(

)

const [pure virtual]

Get nomenclature of device.

Returns:

Nomenclature of device

virtual AccDevRetStatus read	(	const Property &	property,
		SLong	vrtAcc,
		const AccData &	para,
		AccData &	data,
		AccStamp &	stamp,
		AccEFICD &	eficd
	)			[pure virtual]

Synchronous read.

Parameters:

	property	Property
	vrtAcc	Virtual accelerator
	para	Parameter
	data	Data
	stamp	Time and event stamp
	eficd	EFICD information

Returns:

Success or informational messages

Exceptions:

AccDevException

All warnings, errors or fatal errors

virtual AsynchId requestCall	(	const Property &	property,
		SLong	vrtAcc,
		const AccData &	para,
		Callback *	cb
	)			[pure virtual]

Asynchronous call request One asynchronous answer via callback.

Parameters:

	property	Property
	vrtAcc	Virtual accelerator
	para	Parameter
	cb	Callback, method response() will be called

Returns:

Success or informational messages

Exceptions:

AccDevException

All warnings, errors or fatal errors

virtual AsynchId requestRead	(	const Property &	property,
		SLong	vrtAcc,
		const AccData &	para,
		Callback *	cb
	)			[pure virtual]

Asynchronous read request One asynchronous answer via callback.

Parameters:

	property	Property
	vrtAcc	Virtual accelerator
	para	Parameter
	cb	Callback, method readResponse() will be called

Returns:

Success or informational messages

Exceptions:

AccDevException

All warnings, errors or fatal errors

virtual AsynchId requestWrite	(	const Property &	property,
		SLong	vrtAcc,
		const AccData &	para,
		const AccData &	data,
		Callback *	cb
	)			[pure virtual]

Asynchronous write request One asynchronous answer via callback.

Parameters:

	property	Property
	vrtAcc	Virtual accelerator
	para	Parameter
	data	Data
	cb	Callback, method response() will be called

Returns:

Success or informational messages

Exceptions:

AccDevException

All warnings, errors or fatal errors

virtual AccDevRetStatus write	(	const Property &	property,
		SLong	vrtAcc,
		const AccData &	para,
		const AccData &	data
	)			[pure virtual]

Synchronous write.

Parameters:

	property	Property
	vrtAcc	Virtual accelerator
	para	Parameter
	data	Data

Returns:

Success or informational messages

Exceptions:

AccDevException

All warnings, errors or fatal errors

---

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

• device.hh

---