sf::ElementInformation Class Reference

Holds the information on the transducer. More...

#include <ElementInformation.h>

Public Member Functions
	ElementInformation ()
	Default constructor which initializes the data members.
	ElementInformation (double focus_length, double spot_size)
	Initializing constructor which initializes the data members.
	ElementInformation (const ElementInformation &info)
	Copy constructor.
void	clear ()
	Clears the data members to their default values.
ElementInformation &	assign (double focus_length, double spot_size)
	Assign both member values.
ElementInformation &	assign (const ElementInformation &info)
	Assigns the values from the passed instance.
ElementInformation &	operator= (const ElementInformation &info)
	Assignment operator.
bool	operator== (const ElementInformation &info) const
	Compare equal operator.
bool	operator!= (const ElementInformation &info) const
	Compare non-equal operator.
bool	read (const IniProfile &ini, const std::string &section={})
	Reads the class data from an ini-profile.
void	write (IniProfile &ini, const std::string &section={})
	Writes the class data to an ini-profile.
double	getFocusLength () const
	Gets the focus length of the element.
void	setFocusLength (double value)
	Sets the focus length of the element.
double	getSpotSize () const
	Gets the spot size of the element.
void	setSpotSize (double value)
	Sets the spot size of the element.

Detailed Description

Holds the information on the transducer.

Constructor & Destructor Documentation

ElementInformation() [1/3]

sf::ElementInformation::ElementInformation

(

)

Default constructor which initializes the data members.

ElementInformation() [2/3]

sf::ElementInformation::ElementInformation	(	double	focus_length,
		double	spot_size
	)

Initializing constructor which initializes the data members.

Parameters

focus_length	Length of the focus point.
spot_size	Spot size at the focus point.

ElementInformation() [3/3]

sf::ElementInformation::ElementInformation

(

const ElementInformation &

info

)

Copy constructor.

Member Function Documentation

assign() [1/2]

ElementInformation & sf::ElementInformation::assign

(

const ElementInformation &

info

)

Assigns the values from the passed instance.

Returns

This instance.

assign() [2/2]

ElementInformation & sf::ElementInformation::assign	(	double	focus_length,
		double	spot_size
	)

Assign both member values.

Parameters

focus_length
spot_size

Returns

This instance.

clear()

void sf::ElementInformation::clear

(

)

Clears the data members to their default values.

getFocusLength()

double sf::ElementInformation::getFocusLength

(

)

const

Gets the focus length of the element.

getSpotSize()

double sf::ElementInformation::getSpotSize

(

)

const

Gets the spot size of the element.

operator!=()

bool sf::ElementInformation::operator!=

(

const ElementInformation &

info

)

const

Compare non-equal operator.

operator=()

ElementInformation & sf::ElementInformation::operator=

(

const ElementInformation &

info

)

Assignment operator.

operator==()

bool sf::ElementInformation::operator==

(

const ElementInformation &

info

)

const

Compare equal operator.

read()

bool sf::ElementInformation::read	(	const IniProfile &	ini,
		const std::string &	section = {}
	)

Reads the class data from an ini-profile.

Parameters

ini	Reference to the ini-profile instance.
section	Section to read the info from where an empty string defaults to the default section name.

Returns

True when reading is successful.

setFocusLength()

void sf::ElementInformation::setFocusLength

(

double

value

)

Sets the focus length of the element.

setSpotSize()

void sf::ElementInformation::setSpotSize

(

double

value

)

Sets the spot size of the element.

write()

void sf::ElementInformation::write	(	IniProfile &	ini,
		const std::string &	section = {}
	)

Writes the class data to an ini-profile.

Parameters

ini	Reference to the ini-profile instance.
section	Section to read the info from where an empty string defaults to the default section name.

---

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

• ElementInformation.h