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.
void	clear ()
	Clears the data members to their default values.
void	assign (double focus_length, double spot_size)
	Assign both member values.
void	read (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
double	getSpotSize () const

Detailed Description

Holds the information on the transducer.

Constructor & Destructor Documentation

ElementInformation() [1/2]

sf::ElementInformation::ElementInformation

(

)

Default constructor which initializes the data members.

ElementInformation() [2/2]

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.

Member Function Documentation

assign()

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

Assign both member values.

Parameters

focus_length
spot_size

clear()

void sf::ElementInformation::clear

(

)

Clears the data members to their default values.

getFocusLength()

double sf::ElementInformation::getFocusLength

(

)

const

getSpotSize()

double sf::ElementInformation::getSpotSize

(

)

const

read()

void sf::ElementInformation::read	(	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.

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