In file excitation.h:

class excitationManager : public channelHandler

Class to manage a list of excitation channels.

Inheritance:

Public Fields

typedef std::vector <excitation> excitationlist
type representing a list of excitation channels
excitationlist excitations
list of excitation channels

Public Methods

excitationManager ()
Default constructor.
virtual ~excitationManager ()
Destructor.
virtual bool init (testpointMgr& TPMgr, bool Silent)
Initialization function.
virtual bool start (tainsec_t start = 0, tainsec_t timeout = -1)
Start function.
virtual bool stop (tainsec_t timeout = -1, tainsec_t ramptime = 0)
Stop function.
virtual bool freeze ()
Freeze excitation signals.
virtual bool add (const string& channel)
Add excitation function.
virtual bool add (const string& channel, const string& waveform, double settlingtime = 0)
Add excitation function.
virtual bool add (const string& channel, const std::vector<AWG_Component>& awglist)
Add excitation function.
virtual bool del (const string& channel)
Clear function.
virtual bool del (tainsec_t timeout = -1)
Clear function.
virtual double dwellTime () const
dwell time function.

Protected Fields

mutable recursivemutex mux
mutex to protect excitation manager
testpointMgr* tpMgr
Pointer to test point management object
bool silent
if true excitations are not applied

Inherited from channelHandler:

Public Fields

char siteDefault
char siteForce
char ifoDefault
char ifoForce

Public Methods

bool setSiteIfo(char SiteDefault, char SiteForce, char IfoDefault, char IfoForce)
bool channelInfo(const string& name, gdsChnInfo_t& info) const
string channelName(const string& name) const

Documentation

Excitation object to manage a list of excitation channels. This object is multi-thread safe.

Usage: In general, it is responsibility of a diagnostics test or a diagnostics test iterator to control the excitation signals. The supervisory control should just ensure at the end of the test that all excitations are off.

typedef std::vector <excitation> excitationlist
type representing a list of excitation channels

excitationlist excitations
list of excitation channels

excitationManager()
Constructs an excitation manager object.

virtual ~excitationManager()
Destructs an excitation manager object.

virtual bool init(testpointMgr& TPMgr, bool Silent)
Initializes an excitation object.
Returns:
true if successful
Parameters:
Silent - if true prohibits applying excitations

virtual bool start(tainsec_t start = 0, tainsec_t timeout = -1)
Starts the excitation signals. An optional start time can be specified; if zero the current time will be used; if negative the start time argument is ignored. The timeout specifies how long to wait.
Returns:
true if successful
Parameters:
start - start time (0 now)
timeout - time out (<0 wait forever)

virtual bool stop(tainsec_t timeout = -1, tainsec_t ramptime = 0)
Stops the excitation signals.The timeout specifies how long to wait.
Returns:
true if successful
Parameters:
timeout - time out (<0 wait forever)
ramptime - time to ramp down the signal

virtual bool freeze()
Freezes the excitation signal.
Returns:
true if successful

virtual bool add(const string& channel)
Adds an excitation object. Returns false, if the channel is invalid, or the waveform description can not be recognized.
Returns:
true if successful
Parameters:
channel - channel name

virtual bool add(const string& channel, const string& waveform, double settlingtime = 0)
Adds an excitation object. Returns false, if the channel is invalid, or the waveform description can not be recognized.
Returns:
true if successful
Parameters:
channel - channel name
waveform - description of waveform
settlingtime - settling time

virtual bool add(const string& channel, const std::vector<AWG_Component>& awglist)
Adds excitation waveforms. Returns false, if the channel is invalid, or the waveform description can not be recognized.
Returns:
true if successful
Parameters:
channel - channel name
awglist - list of awg waveforms

virtual bool del(const string& channel)
Removes an excitations from the excitation manager.
Returns:
true if successful
Parameters:
channel - channel name

virtual bool del(tainsec_t timeout = -1)
Removes all excitations from the excitation manager.
Returns:
true if successful
Parameters:
timeout - timeout

virtual double dwellTime() const
Returns the longest dwell time of all excitations.
Returns:
dwell time

mutable recursivemutex mux
mutex to protect excitation manager

testpointMgr* tpMgr
Pointer to test point management object

bool silent
if true excitations are not applied

This class has no child classes.
Author:
DS, November 98
See Also:
Excitation management API

alphabetic index hierarchy of classes

Please send questions and comments to sigg_d@ligo-wa.caltech.edu

generated by doc++