#include <outdatainfo.h>

Collaboration diagram for OutDataInfo:

Public Member Functions
	OutDataInfo (void)

	OutDataInfo (const OutDataInfo &signal)

	OutDataInfo (const OutData &signal)

int	device (void) const

void	setDevice (int device)

int	channel (void) const

void	setChannel (int channel)

void	setChannel (int channel, int device)

int	trace (void) const

void	setTrace (int index)

string	traceName (void) const

void	setTraceName (const string &name)

double	delay (void) const

void	setDelay (double delay)

double	sampleRate (void) const

void	setSampleRate (double rate)

double	length (void) const

void	setLength (double length)

double	intensity (void) const

void	setIntensity (double intensity)

void	setNoIntensity (void)

bool	noIntensity (void) const

void	mute (void)

double	carrierFreq (void) const

void	setCarrierFreq (double carrierfreq)

double	level (void) const

void	setLevel (double level)

void	setNoLevel (void)

bool	noLevel (void) const

string	ident (void) const

void	setIdent (const string &ident)

const Options &	description (void) const

Options &	description (void)

void	setDescription (const Options &descr)

Protected Attributes
int	Device

int	Channel

int	Trace

string	TraceName

double	Delay

double	SampleRate

double	Length

double	Intensity

double	Level

double	CarrierFreq

string	Ident

Options	Description

Detailed Description

Stores some properties of an OutData.

Author: Jan Benda

Constructor & Destructor Documentation

OutDataInfo ( void )

Constructor. Sets all properties to their default values.

References Options::clear(), and OutDataInfo::Description.

OutDataInfo ( const OutDataInfo & signal )

Copy constructor.

OutDataInfo ( const OutData & signal )

Constructor. Sets all properties to the values from signal.

Member Function Documentation

int device ( void ) const

The index of the output device.

See Also: setDevice(), channel(), trace(), traceName()

References OutDataInfo::Device.

Referenced by OutDataInfo::setChannel(), and OutDataInfo::setDevice().

void setDevice ( int device )

Set the device index to device.

See Also: device(), setChannel(), setTrace(), setTraceName()

References OutDataInfo::device().

int channel ( void ) const

The number of the channel on the specified device that is used for output.

See Also: setChannel(), device(), trace(), traceName()

References OutDataInfo::Channel.

Referenced by OutDataInfo::setChannel().

void setChannel ( int channel )

Set the number of the channel on the specified device that should be used for output to channel.

See Also: channel(), setDevice(), setTrace(), setTraceName()

References OutDataInfo::channel(), and OutDataInfo::Channel.

void setChannel	(	int	channel,
		int	device
	)

Set the number of the channel to channel and the device to device.

See Also: channel(), device(), setDevice(), setTrace(), setTraceName()

References OutDataInfo::channel(), OutDataInfo::Channel, and OutDataInfo::device().

int trace ( void ) const

The index of the output trace.

See Also: setTrace(), channel(), device(), traceName()

References OutDataInfo::Trace.

void setTrace ( int index )

Set the index of the output trace to index.

See Also: trace(), setChannel(), setDevice(), setTraceName()

References OutDataInfo::Trace.

string traceName ( void ) const

The name of the output trace.

See Also: setTraceName(), channel(), device(), trace()

References OutDataInfo::TraceName.

void setTraceName ( const string & name )

Set the name of the output trace to name.

See Also: traceName(), setChannel(), setDevice(), setTrace()

References name, and OutDataInfo::TraceName.

double delay ( void ) const

Delay in seconds from start trigger to start of aquisition.

References OutDataInfo::Delay.

void setDelay ( double delay )

Set delay to delay (in seconds).

References OutDataInfo::Delay.

double sampleRate ( void ) const

The sampling rate of the signal in Hertz

References OutDataInfo::SampleRate.

void setSampleRate ( double rate )

Set the sampling rate of the signal to rate Hertz

References OutDataInfo::SampleRate.

double length ( void ) const

Length of signal in seconds.

References OutDataInfo::Length.

Referenced by OutDataInfo::setLength().

void setLength ( double length )

Set length of signal to length (in seconds).

References OutDataInfo::length(), and OutDataInfo::Length.

double intensity ( void ) const

Peak intensity of the signal. If MuteIntensity is returned, the attenuator is muted. If NoIntensity is returned, no attenuator is connected to the output channel.

See Also: setIntensity(), setNoIntensity(), noIntensity(), level()

References OutDataInfo::Intensity.

Referenced by OutDataInfo::setIntensity().

void setIntensity ( double intensity )

Set output peak intensity to intensity. The intensity is used in conjunction with the carrier frequency to set an attenuator or amplifier. Passing MuteIntensity requests to mute the attenuator connected to the output channel. Setting the intensity overrides a possible set level(). If no such hardware is used, then the intensity as well the carrier frequency settings have no effect.

See Also: setCarrierFreq(), intensity(), setNoIntensity(), noIntensity(), setLevel()

References OutDataInfo::intensity(), and OutDataInfo::Intensity.

void setNoIntensity ( void )

Set the intensity to its default value, indicating that the intensity is not used for computing the output signal. This will cause an error, if the requested output channel is connected to an attenuator.

See Also: setIntensity(), setNoLevel()

References OutDataInfo::Intensity, and OutData::NoIntensity.

bool noIntensity ( void ) const

Returns true if no intensity is set.

See Also: intensity(), noLevel()

References OutDataInfo::Intensity, and OutData::NoIntensity.

void mute ( void )

Request to mute the attenuator connected to the output channel. Same as setIntensity( MuteIntensity ).

See Also: intensity(), setIntensity(), setNoIntensity()

References OutDataInfo::Intensity, and OutData::MuteIntensity.

double carrierFreq ( void ) const

Carrier frequency of the signal in Hertz.

References OutDataInfo::CarrierFreq.

void setCarrierFreq ( double carrierfreq )

Set carrier frequency of the signal to carrierfreq Hertz. The carrier frequency is used in conjunction with the intensity to set an attenuator or amplifier. If no such hardware is used, then the intensity as well the carrier frequency settings have no effect.

See Also: setIntensity()

References OutDataInfo::CarrierFreq.

double level ( void ) const

The level that was set for the attenuator.

See Also: setLevel(), intensity()

References OutDataInfo::Level.

Referenced by OutDataInfo::setLevel().

void setLevel ( double level )

Set attenuator level directly to level. The specified level is only used if no intensity() was specified. If no atenuator is connected, then setting the level has no effect.

See Also: level(), setIntensity()

References OutDataInfo::level(), and OutDataInfo::Level.

void setNoLevel ( void )

Set the attenuation level to its default value, indicating that the level is not used for computing the output signal. This will cause an error, if the requested output channel is connected to an attenuator and also no intensity() was specified.