namespace diag class testenvironment

Object for implementing a test environment

Inheritance:

Public Classes

class

environment Type representing an environment channel int num array index of Env[] bool active active flag string channel channel name string waveform string describing waveform std::vector <float> points points of arbitrary waveform double wait settling time environment () Default constructor environment (const environment& env) Copy constructor

Public Fields

typedef std::vector <environment>

environmentlist type representing a list of environment channels

Public Methods

	testenvironment () Default constructor.
virtual	~testenvironment () Default constructor.
virtual void	setEnvironmentExcitationManager ( excitationManager* excmgr) Set excitation manager.
virtual bool	readEnvironment () Read environment.
virtual bool	subscribeEnvironment (std::ostringstream& errmsg) Subscribe environment channels.
virtual double	waitEnvironment () const Wait time to settle environment.
virtual bool	startEnvrionment (tainsec_t starttime = 0, tainsec_t timeout = -1) Switch environment signals on.
virtual bool	stopEnvrionment (tainsec_t timeout = -1) Switch environment signals off.
virtual bool	clearEnvrionment (tainsec_t timeout = -1) Clean up environment.

Protected Fields

mutable recursivemutex	envmux mutex to protect environment
excitationManager*	envexc excitation manager
environmentlist	envlist list of environment channels

class environment

Environment settings This object implements one evironment channel setting.

int num

array index of Env[]

bool active

active flag

string channel

channel name

string waveform

string describing waveform

std::vector <float> points

points of arbitrary waveform

double wait

settling time

environment()

Default constructor

environment(const environment& env)

Copy constructor

typedef std::vector <environment> environmentlist

type representing a list of environment channels

testenvironment()

Constructs a testenvironment object.

virtual ~testenvironment()

Destructss a testenvironment object. Calls stopEnvironment to make sure environment channels are off.

virtual void setEnvironmentExcitationManager( excitationManager* excmgr)

Sets the excitation manager for the environment.

Returns:

true if successful

virtual bool readEnvironment()

A function which reads the enviroment from the storage object into the environment list.

Returns:

true if successful

virtual bool subscribeEnvironment(std::ostringstream& errmsg)

A function which subscribes enviroment channels to the excitation manager.

Returns:

true if successful

Parameters:

errmsg - error message stream

virtual double waitEnvironment() const

A function which returns the dwell time of all enviroment channels.

Returns:

dwell time

virtual bool startEnvrionment(tainsec_t starttime = 0, tainsec_t timeout = -1)

Switches excitation signals of the environment on. A zero start time will use the current time, a negative one will be ignored.

Returns:

true if successful

Parameters:

start - time start time of excitation signals
timeout - time to wait for completion

virtual bool stopEnvrionment(tainsec_t timeout = -1)

Switches excitation signals of the environment off.

Returns:

true if successful

Parameters:

timeout - time to wait for completion

virtual bool clearEnvrionment(tainsec_t timeout = -1)

Switches excitation signals of the environment off and clears the list of environment channels.

Returns:

true if successful

Parameters:

timeout - time to wait for completion

mutable recursivemutex envmux

mutex to protect environment

excitationManager* envexc

excitation manager

environmentlist envlist

list of environment channels

Direct child classes:

diagtest
basic_supervisory

Author:

Written April 1999 by Daniel Sigg

Version:

0.1

alphabetic index hierarchy of classes

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

generated by doc++