MXSDevice Class Reference

Device class for equipment model pulsed magnets. More...

#include <mxs-device.hh>

List of all members.

Public Member Functions

 MXSDevice (const string &name)
 Constructor.
 ~MXSDevice ()
 Destructor.
virtual SLong checkSupStatus ()
 Check and set device support status.
DevConstDescdevConstP () throw ()
 Return pointer to constants in the device object.
virtual ULong getStatus (AccData &outData)
 Get devices status.
virtual ULong getVersionStrings (AccData &outData)
 Get versionstrings of device implementation.
boost::shared_ptr< Device > hallprobe ()
 Return device reference of real hallprobe.
virtual ULong initDevice ()
 Initialise device and data.
boost::shared_ptr< Device > magnet ()
 Return device reference of real magnet/power supply.
virtual ULong onlineTest ()
 Check configuration.
virtual ULong readStatusAlarmMask ()
 Send device specific alarm mask.
virtual ULong resetDevice ()
 Reset device and data.
void setDevConstants () throw ()
 Set device constants.
void setDevDataP ()
 MXS has no dualport RAM. Nothing to do.
virtual ULong updateDevConst ()
 Update device constants in object and in dualported RAM.
virtual ULong updateStatus ()
 Update device status.

Detailed Description

Device class for equipment model pulsed magnets.


Constructor & Destructor Documentation

MXSDevice ( const string &  name  )  [explicit]

Constructor.

Parameters:
name Nomenclature of device
~MXSDevice (  )  [inline]

Destructor.


Member Function Documentation

virtual SLong checkSupStatus (  )  [virtual]

Check and set device support status.

Will be called by the Device Manager Overloads method of NativeDevice.

DevConstDesc* devConstP (  )  throw () [inline]

Return pointer to constants in the device object.

virtual ULong getStatus ( AccData &  outData  )  [virtual]

Get devices status.

Parameters:
outData AccData reference to copy the status to
Returns:
XSR_OK if execution was successful or a message giving the cause of the error.
virtual ULong getVersionStrings ( AccData &  outData  )  [virtual]

Get versionstrings of device implementation.

Parameters:
outData AccData reference to copy the data to
Returns:
XSR_OK if execution was successful or a message giving the cause of the error.
boost::shared_ptr<Device> hallprobe (  )  [inline]

Return device reference of real hallprobe.

Returns:
Device reference
virtual ULong initDevice (  )  [virtual]

Initialise device and data.

Returns:
XSR_OK if execution was successful or a message giving the cause of the error.
boost::shared_ptr<Device> magnet (  )  [inline]

Return device reference of real magnet/power supply.

Returns:
Device reference
virtual ULong onlineTest (  )  [virtual]

Check configuration.

Returns:
XSR_OK if execution was successful or a message giving the cause of the error.
virtual ULong readStatusAlarmMask (  )  [inline, virtual]

Send device specific alarm mask.

virtual ULong resetDevice (  )  [virtual]

Reset device and data.

Returns:
XSR_OK if execution was successful or a message giving the cause of the error.
void setDevConstants (  )  throw ()

Set device constants.

Gets device constants from local DB and saves them in device object's attribute.

void setDevDataP (  )  [inline]

MXS has no dualport RAM. Nothing to do.

virtual ULong updateDevConst (  )  [virtual]

Update device constants in object and in dualported RAM.

Re-reads the local DB and updates the constants in the device object and in EC's dualported RAM.

virtual ULong updateStatus (  )  [virtual]

Update device status.


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

Generated on 15 Aug 2018 for MXS-USRs by  doxygen 1.6.1