Attenuator Class Reference

#include <attenuator.h>

Inheritance diagram for Attenuator:

Collaboration diagram for Attenuator:

Public Member Functions
	Attenuator (void)
	Attenuator (const string &deviceclass)
virtual	~Attenuator (void)
virtual int	lines (void) const =0
virtual double	minLevel (void) const =0
virtual double	maxLevel (void) const =0
virtual void	levels (vector< double > &l) const =0
virtual int	attenuate (int di, double &decibel)=0
virtual int	testAttenuate (int di, double &decibel)=0
virtual int	mute (int di)
virtual int	testMute (int di)
Public Member Functions inherited from Device
	Device (int type=MiscellaneousType)
	Device (const string &deviceclass, int type=MiscellaneousType)
virtual	~Device (void)
virtual int	open (const string &device)
virtual int	open (Device &device)
virtual bool	isOpen (void) const =0
virtual void	close (void)=0
virtual int	reset (void)
virtual const Options &	info (void) const
virtual const Options &	settings (void) const
int	deviceType (void) const
string	deviceTypeStr (void) const
string	deviceClass (void) const
string	deviceFile (void) const
string	deviceName (void) const
string	deviceVendor (void) const
string	deviceIdent (void) const
virtual void	setDeviceIdent (const string &ident)
virtual void	clearError (void)
virtual string	errorStr (void) const
void	setErrorStr (const string &strg)
void	addErrorStr (const string &strg)
void	setErrorStr (int errnum)
void	addErrorStr (int errnum)
virtual bool	success (void) const
virtual bool	failed (void) const
Public Member Functions inherited from Options
	Options (void)
	Options (const Options &o)
	Options (const Options &o, int flags)
	Options (const string &name, const string &type, int flags, int style)
	Options (const Str &opttxt, const string &assignment=":=", const string &separator=",;")
	Options (const StrQueue &sq, const string &assignment=":=")
	Options (istream &str, const string &assignment=":=", const string &comment="#", const string &stop="", string *line=0)
virtual	~Options (void)
Options &	operator= (const Options &o)
Options &	assign (const Options &o)
Options &	append (const Options &o)
Options &	add (const Options &o)
Options &	insert (const Options &o, const string &atname="")
Options &	assign (const Options &o, int flags)
Options &	copy (Options &o, int flags)
Options &	append (const Options &o, int flags)
Options &	add (const Options &o, int flags)
Options &	insert (const Options &o, int flags, const string &atname="")
Parameter *	assign (const string &name, const string &value)
Options *	parentSection (void)
const Options *	parentSection (void) const
void	setParentSection (Options *parentsection)
void	resetParents (void)
Options *	rootSection (void)
const Options *	rootSection (void) const
string	name (void) const
virtual void	setName (const string &name)
virtual void	setName (const string &name, const string &type)
string	type (void) const
void	setType (const string &type)
string	include (void) const
void	setInclude (const string &include)
void	setInclude (const string &url, const string &name)
int	flag (void) const
bool	flag (int selectflag) const
Options &	setFlag (int flag)
Options &	addFlag (int flag)
Options &	delFlag (int flag)
Options &	clearFlag (void)
int	style (void) const
Options &	setStyle (int style)
Options &	addStyle (int style)
Options &	delStyle (int style)
Options &	clearStyle (void)
bool	checkType (int mask) const
Str	warning (void) const
iterator	begin (void)
iterator	end (void)
const_iterator	begin (void) const
const_iterator	end (void) const
section_iterator	sectionsBegin (void)
section_iterator	sectionsEnd (void)
const_section_iterator	sectionsBegin (void) const
const_section_iterator	sectionsEnd (void) const
const_iterator	find (const string &pattern, int level=-1) const
iterator	find (const string &pattern, int level=-1)
const_iterator	rfind (const string &pattern, int level=-1) const
iterator	rfind (const string &pattern, int level=-1)
const_section_iterator	findSection (const string &pattern, int level=-1) const
section_iterator	findSection (const string &pattern, int level=-1)
const_section_iterator	rfindSection (const string &pattern, int level=-1) const
section_iterator	rfindSection (const string &pattern, int level=-1)
const Parameter &	operator[] (int i) const
Parameter &	operator[] (int i)
const Parameter &	operator[] (const string &name) const
Parameter &	operator[] (const string &name)
const Options &	section (int i) const
Options &	section (int i)
const Options &	section (const string &name) const
Options &	section (const string &name)
Str	request (const string &name) const
Parameter &	setRequest (const string &name, const string &request)
Parameter::ValueType	valueType (const string &name) const
Parameter &	setValueType (const string &name, Parameter::ValueType type)
int	flags (const string &name) const
bool	flags (const string &name, int flag) const
Parameter &	setFlags (const string &name, int flags)
Parameter &	addFlags (const string &name, int flags)
Parameter &	delFlags (const string &name, int flags)
Parameter &	clearFlags (const string &name)
bool	changed (const string &name)
int	style (const string &name) const
Parameter &	setStyle (const string &name, int style)
Parameter &	addStyle (const string &name, int style)
Parameter &	delStyle (const string &name, int style)
Str	format (const string &name) const
Parameter &	setFormat (const string &name, int width=0, int prec=-1, char fmt='g')
Parameter &	setFormat (const string &name, const string &format)
int	formatWidth (const string &name) const
int	size (const string &name) const
Parameter &	add (const Parameter &np)
Parameter &	insert (const Parameter &np, const string &atname="")
Parameter &	addText (const string &name, const string &request, const string &dflt, int flags=0, int style=0)
Parameter &	addText (const string &name, const string &dflt="", int flags=0, int style=0)
Parameter &	insertText (const string &name, const string &atname, const string &request, const string &dflt, int flags=0, int style=0)
Parameter &	insertText (const string &name, const string &atname="", const string &dflt="", int flags=0, int style=0)
Str	text (const string &name, int index, const string &dflt="", const string &format="", const string &unit="") const
Str	text (const string &name, const string &dflt="", const string &format="", const string &unit="") const
void	texts (const string &name, vector< string > &s, const string &format="", const string &unit="") const
Str	allText (const string &name, const string &dflt="", const string &format="", const string &unit="", const string &separator=", ") const
Parameter &	setText (const string &name, const string &strg)
Parameter &	setText (const string &name, const Parameter &p)
Parameter &	pushText (const string &name, const string &strg)
Str	defaultText (const string &name, const string &format="", const string &unit="") const
Parameter &	setDefaultText (const string &name, const string &dflt)
Parameter &	addSelection (const string &name, const string &request, const string &selection, int flags=0, int style=0)
Parameter &	addSelection (const string &name, const string &selection="", int flags=0, int style=0)
Parameter &	insertSelection (const string &name, const string &atname, const string &request, const string &selection, int flags=0, int style=0)
Parameter &	insertSelection (const string &name, const string &atname="", const string &selection="", int flags=0, int style=0)
Parameter &	selectText (const string &name, const string &strg, int add=0)
Parameter &	selectText (const string &name, int index)
int	index (const string &name) const
int	index (const string &name, const string &strg) const
Parameter &	addNumber (const string &name, const string &request, double dflt, double minimum, double maximum=MAXDOUBLE, double step=1.0, const string &unit="", const string &outputunit="", const string &format="", int flags=0, int style=0)
Parameter &	addNumber (const string &name, const string &request, double dflt, const string &unit="", const string &format="", int flags=0, int style=0)
Parameter &	addNumber (const string &name, double dflt, const string &unit="", const string &format="", int flags=0, int style=0)
Parameter &	addNumber (const string &name, double dflt, const string &unit, int flags, int style=0)
Parameter &	addNumber (const string &name, double dflt, double error, const string &unit="", const string &format="", int flags=0, int style=0)
Parameter &	addNumber (const string &name, const string &unit="", const string &format="", int flags=0, int style=0)
Parameter &	insertNumber (const string &name, const string &atname, const string &request, double dflt, double minimum, double maximum=MAXDOUBLE, double step=1.0, const string &unit="", const string &outputunit="", const string &format="", int flags=0, int style=0)
Parameter &	insertNumber (const string &name, const string &atname, const string &request, double dflt, const string &unit="", const string &format="", int flags=0, int style=0)
Parameter &	insertNumber (const string &name, const string &atname, double dflt, const string &unit="", const string &format="", int flags=0, int style=0)
Parameter &	insertNumber (const string &name, const string &atname, const string &unit="", const string &format="", int flags=0, int style=0)
double	number (const string &name, double dflt=0.0, const string &unit="", int index=0) const
double	number (const string &name, const string &unit, double dflt=0.0, int index=0) const
double	number (const string &name, int index, double dflt=0.0, const string &unit="") const
double	number (const string &name, int index, const string &unit, double dflt=0.0) const
void	numbers (const string &name, vector< double > &n, const string &unit="") const
double	error (const string &name, const string &unit="", int index=0) const
double	error (const string &name, int index, const string &unit="") const
void	errors (const string &name, vector< double > &n, const string &unit="") const
Parameter &	setNumber (const string &name, double number, double error, const string &unit="")
Parameter &	setNumber (const string &name, double number, const string &unit="")
Parameter &	pushNumber (const string &name, double number, double error=-1.0, const string &unit="")
Parameter &	pushNumber (const string &name, double number, const string &unit)
Parameter &	setNumber (const string &name, const Parameter &p)
double	defaultNumber (const string &name, const string &unit="") const
Parameter &	setDefaultNumber (const string &name, double dflt, const string &unit="")
double	minimum (const string &name, const string &unit="") const
double	maximum (const string &name, const string &unit="") const
double	step (const string &name, const string &unit="") const
Parameter &	setStep (const string &name, double step, const string &unit="")
Parameter &	setMinMax (const string &name, double minimum=-MAXDOUBLE, double maximum=MAXDOUBLE, double step=1.0, const string &unit="")
Str	unit (const string &name) const
Str	outUnit (const string &name) const
Parameter &	setUnit (const string &name, const string &internunit, const string &outunit="")
Parameter &	setOutUnit (const string &name, const string &outputunit)
Parameter &	changeUnit (const string &name, const string &internunit)
Parameter &	addInteger (const string &name, const string &request, long dflt, long minimum=LONG_MIN, long maximum=LONG_MAX, long step=1, const string &unit="", const string &outputunit="", int width=0, int flags=0, int style=0)
Parameter &	addInteger (const string &name, long dflt, const string &unit="", int width=0, int flags=0, int style=0)
Parameter &	addInteger (const string &name, const string &unit="")
Parameter &	insertInteger (const string &name, const string &atname, const string &request, long dflt, long minimum=LONG_MIN, long maximum=LONG_MAX, long step=1, const string &unit="", const string &outputunit="", int width=0, int flags=0, int style=0)
Parameter &	insertInteger (const string &name, const string &atname, long dflt, const string &unit="", int width=0, int flags=0, int style=0)
Parameter &	insertInteger (const string &name, const string &atname, const string &unit="", int width=0, int flags=0, int style=0)
long	integer (const string &name, const string &unit="", long dflt=0, int index=0) const
long	integer (const string &name, int index, long dflt=0, const string &unit="") const
long	integer (const string &name, int index, const string &unit, long dflt=0) const
void	integers (const string &name, vector< long > &n, const string &unit="") const
void	integers (const string &name, vector< int > &n, const string &unit="") const
Parameter &	setInteger (const string &name, long number, long error, const string &unit="")
Parameter &	setInteger (const string &name, long number, const string &unit="")
Parameter &	pushInteger (const string &name, long number, long error, const string &unit="")
Parameter &	pushInteger (const string &name, long number, const string &unit="")
Parameter &	setInteger (const string &name, const Parameter &p)
long	defaultInteger (const string &name, const string &unit="") const
Parameter &	setDefaultInteger (const string &name, long dflt, const string &unit="")
Parameter &	setMinMax (const string &name, long minimum=LONG_MIN, long maximum=LONG_MAX, long step=1, const string &unit="")
Parameter &	setMinMax (const string &name, int minimum, int maximum, int step=1, const string &unit="")
Parameter &	addBoolean (const string &name, const string &request, bool dflt, int flags=0, int style=0)
Parameter &	addBoolean (const char *name, const char *request, bool dflt, int flags=0, int style=0)
Parameter &	addBoolean (const string &name, bool dflt, int flags=0, int style=0)
Parameter &	addBoolean (const char *name, bool dflt, int flags=0, int style=0)
Parameter &	insertBoolean (const string &name, const string &atname="", const string &request="", bool dflt=false, int flags=0, int style=0)
Parameter &	insertBoolean (const string &name, const string &atname, int flags=0, int style=0)
bool	boolean (const string &name, bool dflt=false, int index=0) const
bool	boolean (const string &name, int index, bool dflt=false) const
void	booleans (const string &name, vector< bool > &n) const
Parameter &	setBoolean (const string &name, bool b)
Parameter &	setBoolean (const string &name, const Parameter &p)
bool	defaultBoolean (const string &name) const
Parameter &	setDefaultBoolean (const string &name, bool dflt)
Parameter &	addDate (const string &name, const string &request, int year=0, int month=0, int day=0, int flags=0, int style=0)
Parameter &	addDate (const string &name, int year, int month, int day, int flags=0, int style=0)
Parameter &	addDate (const string &name, int flags=0, int style=0)
Parameter &	insertDate (const string &name, const string &atname="", const string &request="", int year=0, int month=0, int day=0, int flags=0, int style=0)
Parameter &	insertDate (const string &name, const string &atname, int year=0, int month=0, int day=0, int flags=0, int style=0)
Parameter &	insertDate (const string &name, const string &atname, int flags=0, int style=0)
const Parameter &	date (const string &name, int index, int &year, int &month, int &day) const
Parameter &	setDate (const string &name, int year, int month, int day)
Parameter &	setDate (const string &name, const string &date)
Parameter &	setDate (const string &name, const struct tm &date)
Parameter &	setDate (const string &name, const time_t &time)
Parameter &	setCurrentDate (const string &name)
Parameter &	setDate (const string &name, const Parameter &p)
const Parameter &	defaultDate (const string &name, int index, int &year, int &month, int &day) const
Parameter &	setDefaultDate (const string &name, int year, int month, int day)
Parameter &	addTime (const string &name, const string &request, int hour=0, int minutes=0, int seconds=0, int milliseconds=0, int flags=0, int style=0)
Parameter &	addTime (const string &name, int hour, int minutes, int seconds, int milliseconds=0, int flags=0, int style=0)
Parameter &	addTime (const string &name, int flags=0, int style=0)
Parameter &	insertTime (const string &name, const string &atname="", const string &request="", int hour=0, int minutes=0, int seconds=0, int milliseconds=0, int flags=0, int style=0)
Parameter &	insertTime (const string &name, const string &atname, int hour=0, int minutes=0, int seconds=0, int milliseconds=0, int flags=0, int style=0)
Parameter &	insertTime (const string &name, const string &atname, int flags=0, int style=0)
const Parameter &	time (const string &name, int index, int &hour, int &minutes, int &seconds, int &milliseconds) const
Parameter &	setTime (const string &name, int hour, int minutes, int seconds, int milliseconds=0)
Parameter &	setTime (const string &name, const string &time)
Parameter &	setTime (const string &name, const struct tm &time)
Parameter &	setTime (const string &name, const time_t &time)
Parameter &	setCurrentTime (const string &name)
Parameter &	setTime (const string &name, const Parameter &p)
const Parameter &	defaultTime (const string &name, int index, int &hour, int &minutes, int &seconds, int &milliseconds) const
Parameter &	setDefaultTime (const string &name, int hour, int minutes, int seconds, int milliseconds=0)
Options &	newSection (int level, const string &name, const string &type="", int flag=0, int style=0)
Options &	newSection (int level, const string &name, int flag, int style=0)
Options &	newSection (const string &name, const string &type="", int flag=0, int style=0)
Options &	newSection (const string &name, int flag, int style=0)
Options &	newSubSection (const string &name, const string &type="", int flag=0, int style=0)
Options &	newSubSection (const string &name, int flag, int style=0)
Options &	newSubSubSection (const string &name, const string &type="", int flag=0, int style=0)
Options &	newSubSubSection (const string &name, int flag, int style=0)
Options &	addSection (const string &name, const string &type="", int flag=0, int style=0)
Options &	addSection (const string &name, int flag, int style=0)
Options &	insertSection (const string &name, const string &atpattern, const string &type="", int flag=0, int style=0)
Options &	insertSection (const string &name, const string &atpattern, int flag, int style=0)
Options &	newSection (int level, const Options &opt, int selectmask, const string &name="", const string &type="", int flag=0, int style=0)
Options &	newSection (int level, const Options &opt, const string &name="", const string &type="", int flag=0, int style=0)
Options &	newSection (int level, const Options &opt, const string &name, int flag, int style=0)
Options &	newSection (const Options &opt, int selectmask, const string &name="", const string &type="", int flag=0, int style=0)
Options &	newSection (const Options &opt, const string &name="", const string &type="", int flag=0, int style=0)
Options &	newSection (const Options &opt, const string &name, int flag, int style=0)
Options &	newSubSection (const Options &opt, int selectmask, const string &name="", const string &type="", int flag=0, int style=0)
Options &	newSubSection (const Options &opt, const string &name="", const string &type="", int flag=0, int style=0)
Options &	newSubSection (const Options &opt, const string &name, int flag, int style=0)
Options &	newSubSubSection (const Options &opt, int selectmask, const string &name="", const string &type="", int flag=0, int style=0)
Options &	newSubSubSection (const Options &opt, const string &name="", const string &type="", int flag=0, int style=0)
Options &	newSubSubSection (const Options &opt, const string &name, int flag, int style=0)
Options &	addSection (const Options &opt, int selectmask, const string &name="", const string &type="", int flag=0, int style=0)
Options &	addSection (const Options &opt, const string &name="", const string &type="", int flag=0, int style=0)
Options &	addSection (const Options &opt, const string &name, int flag, int style=0)
Options &	insertSection (const Options &opt, int selectmask, const string &name, const string &atpattern, const string &type="", int flag=0, int style=0)
Options &	insertSection (const Options &opt, const string &name, const string &atpattern, const string &type="", int flag=0, int style=0)
Options &	insertSection (const Options &opt, const string &name, const string &atpattern, int flag, int style=0)
Options &	newSection (Options *opt, bool newparent=false)
Options &	addSection (Options *opt, bool newparent=false)
Options &	insertSection (Options *opt, const string &atpattern, bool newparent=false)
Options &	newSections (Options *opt, bool newparent=false)
void	endSection (void)
void	clearSections (void)
void	setSection (Options &opt)
void	lastSection (void)
int	up (void)
int	down (void)
Parameter &	setDefault (const string &name)
Options &	setDefaults (int flags=0)
Parameter &	setToDefault (const string &name)
Options &	setToDefaults (int flags=0)
Options &	erase (iterator p)
Options &	erase (section_iterator p)
Options &	erase (Options *s)
Options &	erase (const string &pattern)
Options &	erase (int selectflag)
Options &	pop (void)
Options &	popSection (void)
Options &	flatten (Options *root=0)
Options &	clear (bool revert=true)
int	size (void) const
int	size (int selectflag) const
bool	empty (void) const
int	parameterSize (void) const
int	parameterSize (int flags) const
int	sectionsSize (void) const
int	sectionsSize (int flags) const
bool	exist (const string &pattern) const
bool	existSection (const string &pattern) const
Options &	setFlags (int flags, int selectflag=0)
Options &	addFlags (int flags, int selectflag=0)
Options &	delFlags (int flags, int selectflag=0)
Options &	setValueTypeFlags (int flags, int typemask)
Options &	addValueTypeFlags (int flags, int typemask)
Options &	delValueTypeFlags (int flags, int typemask)
Options &	setStyles (int style, int selectflag=0)
Options &	addStyles (int style, int selectflag=0)
Options &	delStyles (int style, int selectflag=0)
int	styleSize (int style) const
Options &	setValueTypeStyles (int style, int typemask)
Options &	addValueTypeStyles (int style, int typemask)
Options &	delValueTypeStyles (int style, int typemask)
int	nameWidth (int selectmask=0, bool detailed=false, bool escape=false) const
string	save (int selectmask=0, int flags=0) const
ostream &	save (ostream &str, const string &start="", int selectmask=0, int flags=0, int width=-1) const
ostream &	save (ostream &str, const string &textformat, const string &numberformat, const string &boolformat="%i=%b", const string &dateformat="%i=%04Y-%02m-%02d", const string &timeformat="%i=%02H:%02M:%02S", const string &sectionformat="%i", int selectmask=0, const string &start="") const
ostream &	saveXML (ostream &str, int selectmask=0, int flags=0, int level=0, int indent=4) const
Options &	read (const string &opttxt, int flag, const string &assignment=":=", const string &separator=",;", int *indent=0)
Options &	read (const string &opttxt, const string &assignment=":=", const string &separator=",;")
istream &	read (istream &str, int flag, const string &assignment=":=", const string &comment="#", const string &stop="", Str *line=0)
istream &	read (istream &str, const string &assignment=":=", const string &comment="#", const string &stop="", Str *line=0)
Options &	read (const StrQueue &sq, int flag=0, const string &assignment=":=")
bool	read (const Parameter &p, int flag=0)
Options &	read (const Options &o, int flags=0, int flag=0)
bool	readAppend (const Parameter &p)
Options &	readAppend (const Options &o, int flags=0)
Options &	load (const Str &opttxt, const string &assignment=":=", const string &separator=",;", int *indent=0, int *indentspacing=0, int *level=0)
istream &	load (istream &str, const string &assignment=":=", const string &comment="#", const string &stop="", string *line=0)
Options &	load (const StrQueue &sq, const string &assignment=":=")
virtual void	notify (void)
void	callNotifies (void)
bool	setNotify (bool notify=true)
bool	unsetNotify (void)
bool	notifying (void) const

Static Public Attributes
static const double	MuteAttenuationLevel = -1.0e37
static const int	Underflow = -5
static const int	Overflow = -6
Static Public Attributes inherited from Device
static const int	NotOpen = -1
static const int	InvalidDevice = -2
static const int	ReadError = -3
static const int	WriteError = -4
static const int	InvalidParam = -5
Static Public Attributes inherited from Options
static const int	NonDefault = Parameter::NonDefault
static const long	TabSection = 0x04000000

Protected Member Functions
void	setInfo (void)
Protected Member Functions inherited from Device
void	setDeviceType (int type)
void	setDeviceClass (const string &deviceclass)
void	setDeviceFile (const string &devicefile)
void	setDeviceName (const string &devicename)
void	setDeviceVendor (const string &devicevendor)
void	addInfo (void)
void	lock (void) const
void	unlock (void) const
QMutex *	mutex (void) const
virtual void	initOptions (void)

Additional Inherited Members
Public Types inherited from Device
enum	DeviceTypes {   MiscellaneousType = 0, AnalogInputType = 1, AnalogOutputType = 2, DigitalIOType = 3,   TriggerType = 4, AttenuatorType = 5, AttenuateType = 6, ManipulatorType = 7,   TemperatureType = 8, CameraType = 9 }
Public Types inherited from Options
enum	SaveFlags {   NoName = 1, NoType = 2, NoInclude = 4, SwitchNameType = 8,   Embrace = 16, PrintRequest = 32, FirstOnly = 64, PrintType = 128,   PrintStyle = 256, DontCloseSection = 512, AlwaysQuote = 1024, EscapeQuotes = 2048 }
typedef deque< Parameter > ::iterator	iterator
typedef deque< Parameter > ::const_iterator	const_iterator
typedef deque< Options * > ::iterator	section_iterator
typedef deque< Options * > ::const_iterator	const_section_iterator
Static Public Member Functions inherited from Device
static int	deviceTypes (void)
static string	deviceTypeStr (int type)
static string	getErrorStr (int ern)
Static Public Member Functions inherited from Options
static double	floorLog10 (double v)
static double	floor10 (double v, double scale=1.0)
static double	ceil10 (double v, double scale=1.0)
Protected Attributes inherited from Device
Options	Info
Options	Settings

Detailed Description

Interface for programming an attenuator.

Author

Jan Benda

Version

1.1 The Attenuator class defines an interface for accessing attenuator devices which are used to attenuate output signals. You have to reimplement open(), isOpen(), close(), lines(), minLevel(), maxLevel(), levels(), attenuate(), testAttenuate() for a specific attenuator. The open(), isOpen(), and close() functions are defined in the Device class.

Via a constructor or the open()-function a specific attenuator device is assigned to the Attenuator-class and opened. The isOpen()-function checks whether the device driver for the attenuator is valid and opened. With close() the device driver for the attenuator is closed.

The number of output lines that can be attenuated by the attenuator is returned by lines(). The minimum and maximum possible attenuation level is returned by minLevel() and maxLevel(), respectively. levels() returns all possible attenuation levels.

The attenuation level of an output line can be set by the attenuate()-function. Attenuators usually can be set to discrete attenuation levels only. If you request a specific attenuation level by attenuate(), than it is very likely that the actually set attenuation level differs slightly from the requested one. To make this attenuation level known to the user, attenuate() sets the decibel variable to the actually set attenuation level.

To check whether a requested attenuation level is possible and what level would be set without actually setting it, you can use the testAttenuate()-function.

The mute()-function can be used to mute an output line and testMute() checks whether the output line can be muted. Alternatively, you can call attenuate() with decibel set to MuteAttenuationLevel.

Possible return values of attenuate(), test() and mute() are:

• 0: success
• NotOpen: The device driver for the attenuator is not open.
• InvalidDevice: An invalid device index is requested, i.e. the requested output line is not supported by the attenuator device.
• ReadError: Failed in reading the attenuation level.
• WriteError: Failed in setting the attenuation level.
• Underflow: The requested attenuation level is too high, i.e. the requested signal amplitude is too small.
• Overflow: The requested attenuation level is too low, i.e. the requested signal amplitude is too large.

In case you want to use a attenuator device within RELACS, your Attenuator implementation needs to provide a void default constructor (i.e. with no parameters) that does not open the device. Also, include the header file <relacs/relacsplugin.h> and make the Attenuator device known to RELACS with the addAttenuator( ClassNameOfYourAttenuatorImplementation, PluginSetName ) macro.

Constructor & Destructor Documentation

Attenuator

(

void

)

Constructs an Attenuator.

Attenuator

(

const string &

deviceclass

)

Constructs an Attenuator with device class deviceclass.

See Also

setDeviceClass()

~Attenuator ( void  )

virtual

Destructor. Closes the attenuator device driver.

Member Function Documentation

virtual int lines ( void  ) const

pure virtual

Returns the number of output lines the attenuator device supports. Reimplement this function for a specific attenuator. The default implementation returns 1.

See Also

minLevel(), maxLevel(), levels()

Implemented in AttSim.

Referenced by Attenuate::isOpen(), and Attenuator::setInfo().

virtual double minLevel ( void  ) const

pure virtual

Returns the minimum possible attenuation level in decibel. This number can be negative, indicating amplification.

See Also

maxLevel(), levels(), lines()

Implemented in AttSim.

Referenced by Attenuate::maxIntensity(), Attenuate::minIntensity(), and Attenuator::setInfo().

virtual double maxLevel ( void  ) const

pure virtual

Returns the maximum possible attenuation level in decibel.

See Also

minLevel(), levels(), lines()

Implemented in AttSim.

Referenced by Attenuate::maxIntensity(), Attenuate::minIntensity(), and Attenuator::setInfo().

virtual void levels ( vector< double > &  l ) const

pure virtual

Returns in l all possible attenuation levels sorted by increasing attenuation levels (highest last).

See Also

minLevel(), maxLevel(), lines()

Implemented in AttSim.

Referenced by Attenuate::intensities().

virtual int attenuate ( int  di, double &  decibel  )

pure virtual

Set the attenuation level of the output line specified by its index di to decibel decibel. decibel can also be set to MuteAttenuationLevel for requesting to mute the attenuator. Returns the actually set level in decibel. In case the attenuator was muted, MuteAttenuationLevel is returned in decibel. If the requested attenuation level is too high or too low (Underflow or Overflow), then the maximum or minimum possible attenuation level is set and returned in decibel. You have to reimplement this function for a specific attenuator.

Returns

• 0 on success
• NotOpen: The device driver for the attenuator is not open.
• InvalidDevice: An invalid device index is requested, i.e. the requested output line is not supported by the attenuator device.
• WriteError: Failed in setting the attenuation level.
• Underflow: The requested attenuation level is too high, i.e. the requested signal amplitude is too small.
• Overflow: The requested attenuation level is too low, i.e. the requested signal amplitude is too large.

See Also

testAtenuate(), mute()

Implemented in AttSim.

Referenced by Attenuate::attenuate(), Attenuator::mute(), and Attenuate::write().

virtual int testAttenuate ( int  di, double &  decibel  )

pure virtual

Tests setting the attenuation level of the output line specified by its index di to decibel decibel. decibel can also be set to MuteAttenuationLevel for requesting to mute the attenuator. Returns the level that would be set in decibel. In case the attenuator would be muted, MuteAttenuationLevel is returned in decibel. If the requested attenuation level is too high or too low (Underflow or Overflow), then the maximum or minimum possible attenuation level is returned in decibel. You have to reimplement this function for a specific attenuator.

Returns

• 0 on success
• NotOpen: The device driver for the attenuator is not open.
• InvalidDevice: An invalid device index is requested, i.e. the requested output line is not supported by the attenuator device.
• Underflow: The requested attenuation level is too high, i.e. the requested signal amplitude is too small.
• Overflow: The requested attenuation level is too low, i.e. the requested signal amplitude is too large.

See Also

attenuate(), testMute()

Implemented in AttSim.

Referenced by Attenuate::testAttenuate(), Attenuator::testMute(), and Attenuate::testWrite().

int mute ( int  di )

virtual

Mutes the output line specified by its index di. The default implementation simply calls attenuate( di, MuteAttenuationLevel ).

Returns

• 0 on success
• NotOpen: The device driver for the attenuator is not open.
• InvalidDevice: An invalid device index is requested, i.e. the requested output line is not supported by the attenuator device.
• WriteError: Failed in setting the attenuation level.

See Also

attenuate(), testMute()

References Attenuator::attenuate(), and Attenuator::MuteAttenuationLevel.

Referenced by Attenuate::mute().

int testMute ( int  di )

virtual

Tests muting the output line specified by its index di. The default implementation simply calls testAttenuate( di, MuteAttenuationLevel ).

Returns

• 0 on success
• NotOpen: The device driver for the attenuator is not open.
• InvalidDevice: An invalid device index is requested, i.e. the requested output line is not supported by the attenuator device.
• WriteError: Failed in setting the attenuation level.

See Also

attenuate(), test(), mute()

References Attenuator::MuteAttenuationLevel, and Attenuator::testAttenuate().

Referenced by Attenuate::testMute().

void setInfo ( void  )

protected

Set the device info(). Call this function from open().

See Also

info()

References Device::addInfo(), Options::addInteger(), Options::addNumber(), Options::clear(), Device::Info, Attenuator::lines(), Attenuator::maxLevel(), and Attenuator::minLevel().

Referenced by AttSim::open().

Member Data Documentation

const double MuteAttenuationLevel = -1.0e37

static

The attenuation level for which the outputline is muted.

Referenced by AttSim::attenuate(), Attenuator::mute(), AttSim::settings(), AttSim::testAttenuate(), and Attenuator::testMute().

const int Underflow = -5

static

Return code indicating a too high requested attenuation level, i.e. the requested signal amplitude is too small.

Referenced by AttSim::attenuate(), and AttSim::testAttenuate().

const int Overflow = -6

static

Return code indicating a too low requested attenuation level, i.e. the requested signal amplitude is too large.

Referenced by AttSim::attenuate(), and AttSim::testAttenuate().

---

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

• attenuator.h
• attenuator.cc