AisExperiment Class Reference

this class is used to create custom experiments. A custom experiment contains one or more elements. Once you create elements and set their parameters, you can add them to the container. More...

#include <AisExperiment.h>

#include <AisExperiment.h>

Public Member Functions
	AisExperiment ()
	this is the default constructor for the custom experiment.
	AisExperiment (const AisExperiment &exp)
	this is the copy constructor for the custom experiment.
void	operator= (const AisExperiment &exp)
	the assignment operator for the custom experiment.
QString	getExperimentName () const
	get the name of the custom experiment.
QString	getDescription () const
	get a brief description of the custom experiment.
QStringList	getCategory () const
	get the category for the custom experiment.
void	setExperimentName (QString name)
	set a name for the custom experiment.
void	setDescription (QString description)
	set a description for the experiment.
bool	appendElement (AisAbstractElement &element, unsigned int repeat=1)
	Append an element to this experiment.
bool	appendSubExperiment (const AisExperiment &subExp, unsigned int repeat=1)
	Append a sub experiment to this experiment.

Friends
class	AisInstrumentHandler

Constructor & Destructor Documentation

AisExperiment()

AisExperiment::AisExperiment ( const AisExperiment & exp )

explicit

Parameters

exp	the custom experiment to copy from.

Member Function Documentation

appendElement()

bool AisExperiment::appendElement	(	AisAbstractElement &	element,
		unsigned int	repeat = 1 )

Parameters

element	The experiment element to be appended to this experiment.
repeat	The number of times this element will be repeated. This is an optional parameter with a default value of 1. The minimum value is 1. If smaller the function will not append the node to the experiment. The maximum value is 65535. The function will clamp any value greater than this to 65535, and it will append the node to the experiment.

Returns

true if the element was appended to the experiment and false otherwise.

Note

Although an element is an experiment, in the context of custom experiments, it is referred to as an element to make a distinction between the two. In other contexts where such distinction is not needed, an element may still be referred to as an experiment.

appendSubExperiment()

bool AisExperiment::appendSubExperiment	(	const AisExperiment &	subExp,
		unsigned int	repeat = 1 )

Parameters

subExp	A sub experiment to be appended to this experiment.
repeat	The number of times this sub experiment will be repeated. This is an optional parameter with a default value of 1. The minimum value is 1. If smaller, the function will not append the sub experiment to the experiment The maximum value is 65535. The function will clamp any value greater than this to 65535, and it will append the sub experiment to the experiment.

Returns

true if the sub experiment was appended to the experiment and false otherwise.

getCategory()

QStringList AisExperiment::getCategory

(

)

const

Returns

the category set for the custom experiment. If no category has been set, the default category returned is ("Custom").

getDescription()

QString AisExperiment::getDescription

(

)

const

Returns

the description set for the custom experiment. If no description has been set, the default description returned is "Not Defined".

getExperimentName()

QString AisExperiment::getExperimentName

(

)

const

Returns

the name set for the custom experiment. If no name has been set, the default name returned is "Custom Experiment"

operator=()

void AisExperiment::operator=

(

const AisExperiment &

exp

)

Parameters

exp	the custom experiment to copy from.

setDescription()

void AisExperiment::setDescription

(

QString

description

)

Parameters

description

the description to be set for the custom experiment.

setExperimentName()

void AisExperiment::setExperimentName

(

QString

name

)

Parameters

name	the name to be set for the custom experiment.

---

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

• AisExperiment.h