sf::ToolInformation Class Reference

Holds all the necessary information on a tool to make calculations. More...

#include <ToolInformation.h>

Public Member Functions
	ToolInformation ()
	Default constructor.
	ToolInformation (const ToolInformation &info)
	Copy constructor.
void	clear ()
	Clears all data members.
void	assign (double x, double y, double z, double xa, double ya, double za, double len)
	Assign all member at once.
ToolInformation &	assign (const ToolInformation &info)
	Assigns the values from the passed instance.
ToolInformation &	operator= (const ToolInformation &info)
	Assignment operator.
bool	operator== (const ToolInformation &info) const
	Compare equal operator.
bool	operator!= (const ToolInformation &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.
void	setDisplacement (double angle_x, double angle_y, double beam_len)
	Sets the displacement using angles and length.
void	setDisplacement (Vector3D v)
	Sets the displacement using a vector.
double	setDisplacementAngleX () const
	Gets the displacement angle around then X-axis when this tool is mounted.
double	setDisplacementAngleY () const
	Gets the displacement angle around then Y-axis when this tool is mounted.
double	setDisplacementLength () const
	Gets the displacement angle around then Z-axis when this tool is mounted.
const Vector3D &	getDisplacement () const
	Gets the displacement 3D vector.
void	setBeam (double angle_x, double angle_y, double angle_z, double beam_len)
	Sets the angles of rotation around the X- and Y-axis when it leaves the tool.
double	getBeamAngleX () const
	Gets the rotation angle around the Y-axis of the beam when it leaves the tool.
double	getBeamAngleY () const
	Gets the rotation angle around the Y-axis of the beam when it leaves the tool.
double	getBeamAngleZ () const
	Gets the rotation angle around the Z-axis of the beam when it leaves the tool.
double	getBeamLength () const
	Gets the length of beam inside the tool.
const Matrix44 &	getBeamMatrix () const
	Gets the matrix for rotating a beam.

Detailed Description

Holds all the necessary information on a tool to make calculations.

Constructor & Destructor Documentation

ToolInformation() [1/2]

sf::ToolInformation::ToolInformation

(

)

Default constructor.

ToolInformation() [2/2]

sf::ToolInformation::ToolInformation

(

const ToolInformation &

info

)

Copy constructor.

Member Function Documentation

assign() [1/2]

ToolInformation & sf::ToolInformation::assign

(

const ToolInformation &

info

)

Assigns the values from the passed instance.

Returns

This instance.

assign() [2/2]

void sf::ToolInformation::assign	(	double	x,
		double	y,
		double	z,
		double	xa,
		double	ya,
		double	za,
		double	len
	)

Assign all member at once.

clear()

void sf::ToolInformation::clear

(

)

Clears all data members.

getBeamAngleX()

double sf::ToolInformation::getBeamAngleX

(

)

const

Gets the rotation angle around the Y-axis of the beam when it leaves the tool.

getBeamAngleY()

double sf::ToolInformation::getBeamAngleY

(

)

const

Gets the rotation angle around the Y-axis of the beam when it leaves the tool.

getBeamAngleZ()

double sf::ToolInformation::getBeamAngleZ

(

)

const

Gets the rotation angle around the Z-axis of the beam when it leaves the tool.

getBeamLength()

double sf::ToolInformation::getBeamLength

(

)

const

Gets the length of beam inside the tool.

getBeamMatrix()

const Matrix44 & sf::ToolInformation::getBeamMatrix

(

)

const

Gets the matrix for rotating a beam.

getDisplacement()

const Vector3D & sf::ToolInformation::getDisplacement

(

)

const

Gets the displacement 3D vector.

operator!=()

bool sf::ToolInformation::operator!=

(

const ToolInformation &

info

)

const

Compare non-equal operator.

operator=()

ToolInformation & sf::ToolInformation::operator=

(

const ToolInformation &

info

)

Assignment operator.

operator==()

bool sf::ToolInformation::operator==

(

const ToolInformation &

info

)

const

Compare equal operator.

read()

bool sf::ToolInformation::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.

setBeam()

void sf::ToolInformation::setBeam	(	double	angle_x,
		double	angle_y,
		double	angle_z,
		double	beam_len
	)

Sets the angles of rotation around the X- and Y-axis when it leaves the tool.

Parameters

angle_x
angle_y
angle_z
beam_len

setDisplacement() [1/2]

void sf::ToolInformation::setDisplacement	(	double	angle_x,
		double	angle_y,
		double	beam_len
	)

Sets the displacement using angles and length.

Parameters

angle_x
angle_y
beam_len

setDisplacement() [2/2]

void sf::ToolInformation::setDisplacement

(

Vector3D

v

)

Sets the displacement using a vector.

Parameters

v	3D vector.

setDisplacementAngleX()

double sf::ToolInformation::setDisplacementAngleX

(

)

const

Gets the displacement angle around then X-axis when this tool is mounted.

setDisplacementAngleY()

double sf::ToolInformation::setDisplacementAngleY

(

)

const

Gets the displacement angle around then Y-axis when this tool is mounted.

setDisplacementLength()

double sf::ToolInformation::setDisplacementLength

(

)

const

Gets the displacement angle around then Z-axis when this tool is mounted.

write()

void sf::ToolInformation::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:

• ToolInformation.h