RotationGeometry is the class that applies a rotation to a given geometry patch. More...

#include <RotationGeometry.hpp>

Inheritance diagram for mimmo::RotationGeometry:

Collaboration diagram for mimmo::RotationGeometry:

[legend]

Public Member Functions
	RotationGeometry (const bitpit::Config::Section &rootXML)

	RotationGeometry (const RotationGeometry &other)

	RotationGeometry (darray3E origin={ {0, 0, 0} }, darray3E direction={ {0, 0, 0} })

	~RotationGeometry ()

virtual void	absorbSectionXML (const bitpit::Config::Section &slotXML, std::string name="")

void	apply ()

void	buildPorts ()

void	execute ()

virtual void	flushSectionXML (bitpit::Config::Section &slotXML, std::string name="")

dmpvecarr3E *	getDisplacements ()

RotationGeometry &	operator= (RotationGeometry other)

void	setAxis (darray3E origin, darray3E direction)

void	setDirection (darray3E direction)

void	setFilter (dmpvector1D *filter)

void	setOrigin (darray3E origin)

void	setRotation (double alpha)

Public Member Functions inherited from mimmo::BaseManipulation
	BaseManipulation ()

	BaseManipulation (const BaseManipulation &other)

virtual	~BaseManipulation ()

void	activate ()

bool	arePortsBuilt ()

void	clear ()

void	disable ()

void	exec ()

BaseManipulation *	getChild (int i=0)

ConnectionType	getConnectionType ()

MimmoSharedPointer< MimmoObject >	getGeometry ()

MimmoSharedPointer< MimmoObject > &	getGeometryReference ()

int	getId ()

bitpit::Logger &	getLog ()

std::string	getName ()

int	getNChild ()

int	getNParent ()

int	getNPortsIn ()

int	getNPortsOut ()

BaseManipulation *	getParent (int i=0)

std::unordered_map< PortID, PortIn * >	getPortsIn ()

std::unordered_map< PortID, PortOut * >	getPortsOut ()

uint	getPriority ()

virtual std::vector< BaseManipulation * >	getSubBlocksEmbedded ()

bool	isActive ()

bool	isApply ()

bool	isChild (BaseManipulation *, int &)

bool	isParent (BaseManipulation *, int &)

bool	isPlotInExecution ()

BaseManipulation &	operator= (const BaseManipulation &other)

void	removePins ()

void	removePinsIn ()

void	removePinsOut ()

void	setApply (bool flag=true)

void	setGeometry (MimmoSharedPointer< MimmoObject > geometry)

void	setId (int)

void	setLog (bitpit::Logger &log)

void	setName (std::string name)

void	setOutputPlot (std::string path)

void	setPlotInExecution (bool)

void	setPriority (uint priority)

void	unsetGeometry ()

Protected Member Functions
void	checkFilter ()

void	swap (RotationGeometry &x) noexcept

Protected Member Functions inherited from mimmo::BaseManipulation
void	_apply (MimmoPiercedVector< darray3E > &displacements)

void	addChild (BaseManipulation *child)

void	addParent (BaseManipulation *parent)

void	addPinIn (BaseManipulation *objIn, PortID portR)

void	addPinOut (BaseManipulation *objOut, PortID portS, PortID portR)

void	cleanBufferIn (PortID port)

template<typename T , typename O >
bool	createPortIn (O obj, void(O::setVar_)(T), PortID portR, bool mandatory=false, int family=0)

template<typename T , typename O >
bool	createPortIn (T *var_, PortID portR, bool mandatory=false, int family=0)

template<typename T , typename O >
bool	createPortOut (O obj, T(O::getVar_)(), PortID portS)

template<typename T , typename O >
bool	createPortOut (T *var_, PortID portS)

void	deletePorts ()

PortID	findPinIn (PortIn &pin)

PortID	findPinOut (PortOut &pin)

void	initializeLogger (bool logexists)

virtual void	plotOptionalResults ()

void	readBufferIn (PortID port)

void	removePinIn (BaseManipulation *objIn, PortID portR)

void	removePinIn (PortID portR, int j)

void	removePinOut (BaseManipulation *objOut, PortID portS)

void	removePinOut (PortID portS, int j)

void	setBufferIn (PortID port, mimmo::IBinaryStream &input)

void	swap (BaseManipulation &x) noexcept

void	unsetChild (BaseManipulation *child)

void	unsetParent (BaseManipulation *parent)

void	write (MimmoSharedPointer< MimmoObject > geometry)

template<typename mpv_t >
void	write (MimmoSharedPointer< MimmoObject > geometry, MimmoPiercedVector< mpv_t > &data)

template<typename mpv_t , typename... Args>
void	write (MimmoSharedPointer< MimmoObject > geometry, MimmoPiercedVector< mpv_t > &data, Args ... args)

template<typename mpv_t >
void	write (MimmoSharedPointer< MimmoObject > geometry, std::vector< MimmoPiercedVector< mpv_t > * > &data)

template<typename mpv_t , typename... Args>
void	write (MimmoSharedPointer< MimmoObject > geometry, std::vector< MimmoPiercedVector< mpv_t > * > &data, Args ... args)

template<typename mpv_t >
void	write (MimmoSharedPointer< MimmoObject > geometry, std::vector< MimmoPiercedVector< mpv_t >> &data)

template<typename mpv_t , typename... Args>
void	write (MimmoSharedPointer< MimmoObject > geometry, std::vector< MimmoPiercedVector< mpv_t >> &data, Args ... args)

Additional Inherited Members
Public Types inherited from mimmo::BaseManipulation
typedef std::unordered_map< BaseManipulation *, int >	bmumap

typedef pin::ConnectionType	ConnectionType

typedef std::string	PortID

Protected Attributes inherited from mimmo::BaseManipulation
bool	m_active

bool	m_apply

bool	m_arePortsBuilt

bmumap	m_child

int	m_counter

bool	m_execPlot

MimmoSharedPointer< MimmoObject >	m_geometry

bitpit::Logger *	m_log

std::string	m_name

std::string	m_outputPlot

bmumap	m_parent

std::unordered_map< PortID, PortIn * >	m_portIn

std::unordered_map< PortID, PortOut * >	m_portOut

ConnectionType	m_portsType

uint	m_priority

Static Protected Attributes inherited from mimmo::BaseManipulation
static int	sm_baseManipulationCounter

Detailed Description

RotationGeometry is the class that applies a rotation to a given geometry patch.

The used parameters are the rotation value and the direction and the origin of the rotation axis.

Ports available in RotationGeometry Class :

Port Input
PortType	variable/function	DataType
M_POINT	setOrigin	(MC_ARRAY3, MD_FLOAT)
M_AXIS	setDirection	(MC_ARRAY3, MD_FLOAT)
M_VALUED	setRotation	(MC_SCALAR, MD_FLOAT)
M_FILTER	setFilter	(MC_SCALAR, MD_MPVECFLOAT_)
M_GEOM	setGeometry	(MC_SCALAR, MD_MIMMO_)

Port Output
PortType	variable/function	DataType
M_GDISPLS	getDisplacements	(MC_SCALAR, MD_MPVECARR3FLOAT_)
M_GEOM	getGeometry	(MC_SCALAR,MD_MIMMO_)

The xml available parameters, sections and subsections are the following :

Inherited from BaseManipulation:

ClassName: name of the class as mimmo.RotationGeometry;
Priority: uint marking priority in multi-chain execution;
Apply: boolean 0/1 activate apply deformation result on target geometry directly in execution;

Proper of the class:

Origin: rotation axis origin coords (space separated);
Direction: rotation axis direction coordinates (space separated);
Rotation: rotation angle in radians. Positive on counterclockwise rotations around reference axis.

Geometry has to be mandatorily passed through port.

Examples: iocgns_example_00001.cpp, and manipulators_example_00001.cpp.

Definition at line 79 of file RotationGeometry.hpp.

Constructor & Destructor Documentation

◆ RotationGeometry() [1/3]

mimmo::RotationGeometry::RotationGeometry	(	darray3E	origin = `{ {0, 0, 0} }`,
		darray3E	direction = `{ {0, 0, 0} }`
	)

Default constructor of RotationGeometry

Parameters

[in]	origin	origin of rotation axis
[in]	direction	direction of rotation axis

Definition at line 34 of file RotationGeometry.cpp.

◆ RotationGeometry() [2/3]

mimmo::RotationGeometry::RotationGeometry ( const bitpit::Config::Section & rootXML )

Custom constructor reading xml data

Parameters

[in] rootXML reference to your xml tree section

Definition at line 45 of file RotationGeometry.cpp.

◆ ~RotationGeometry()

mimmo::RotationGeometry::~RotationGeometry ( )

Default destructor of RotationGeometry

Definition at line 64 of file RotationGeometry.cpp.

◆ RotationGeometry() [3/3]

mimmo::RotationGeometry::RotationGeometry ( const RotationGeometry & other )

Copy constructor of RotationGeometry. No result geometry displacements are copied.

Definition at line 69 of file RotationGeometry.cpp.

Member Function Documentation

◆ absorbSectionXML()

void mimmo::RotationGeometry::absorbSectionXML	(	const bitpit::Config::Section &	slotXML,
		std::string	name = `""`
	)

virtual

It sets infos reading from a XML bitpit::Config::section.

Parameters

[in]	slotXML	bitpit::Config::Section of XML file
[in]	name	name associated to the slot

Reimplemented from mimmo::BaseManipulation.

Definition at line 255 of file RotationGeometry.cpp.

◆ apply()

void mimmo::RotationGeometry::apply ( )

virtual

Directly apply deformation field to target geometry.

Reimplemented from mimmo::BaseManipulation.

Definition at line 220 of file RotationGeometry.cpp.

◆ buildPorts()

void mimmo::RotationGeometry::buildPorts ( )

virtual

It builds the input/output ports of the object

Implements mimmo::BaseManipulation.

Definition at line 101 of file RotationGeometry.cpp.

◆ checkFilter()

void mimmo::RotationGeometry::checkFilter ( )

protected

Check if the filter is related to the target geometry. If not create a unitary filter field.

Definition at line 229 of file RotationGeometry.cpp.

◆ execute()

void mimmo::RotationGeometry::execute ( )

virtual

Execution command. It saves in "rot"-terms the modified axes and origin, by the rotation conditions. This terms can be recovered and passed by a pin to a child object by the related get-methods.

Implements mimmo::BaseManipulation.

Definition at line 174 of file RotationGeometry.cpp.

◆ flushSectionXML()

void mimmo::RotationGeometry::flushSectionXML	(	bitpit::Config::Section &	slotXML,
		std::string	name = `""`
	)

virtual

It sets infos from class members in a XML bitpit::Config::section.

Parameters

[in]	slotXML	bitpit::Config::Section of XML file
[in]	name	name associated to the slot

Reimplemented from mimmo::BaseManipulation.

Definition at line 302 of file RotationGeometry.cpp.

◆ getDisplacements()

dmpvecarr3E * mimmo::RotationGeometry::getDisplacements ( )

Return actual computed displacements field (if any) for the geometry linked.

Returns: deformation field

Definition at line 165 of file RotationGeometry.cpp.

◆ operator=()

RotationGeometry & mimmo::RotationGeometry::operator= ( RotationGeometry other )

Assignment operator. No result geometry displacements are copied.

Definition at line 79 of file RotationGeometry.cpp.

◆ setAxis()

void mimmo::RotationGeometry::setAxis	(	darray3E	origin,
		darray3E	direction
	)

It sets the origin and direction of the rotation axis.

Parameters

[in]	origin	origin of rotation axis
[in]	direction	direction of rotation axis

Definition at line 118 of file RotationGeometry.cpp.

◆ setDirection()

void mimmo::RotationGeometry::setDirection ( darray3E direction )

It sets the direction of the rotation axis.

Parameters

[in] direction direction of rotation axis

Examples: iocgns_example_00001.cpp, and manipulators_example_00001.cpp.

Definition at line 135 of file RotationGeometry.cpp.

◆ setFilter()

void mimmo::RotationGeometry::setFilter ( dmpvector1D * filter )

It sets the filter field to modulate the displacements of the vertices of the target geometry.

Parameters

[in] filter filter field defined on geometry vertices.

Definition at line 155 of file RotationGeometry.cpp.

◆ setOrigin()

void mimmo::RotationGeometry::setOrigin ( darray3E origin )

It sets the origin of the rotation axis.

Parameters

[in] origin origin of rotation axis

Definition at line 127 of file RotationGeometry.cpp.

◆ setRotation()

void mimmo::RotationGeometry::setRotation ( double alpha )

It sets the value of the rotation.

Parameters

[in] alpha value of rotation [rad]

Examples: iocgns_example_00001.cpp, and manipulators_example_00001.cpp.

Definition at line 146 of file RotationGeometry.cpp.

◆ swap()

void mimmo::RotationGeometry::swap ( RotationGeometry & x )

protectednoexcept

Swap function

Parameters

[in] x object to be swapped

Definition at line 88 of file RotationGeometry.cpp.

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

src/manipulators/RotationGeometry.hpp
src/manipulators/RotationGeometry.cpp

Our website uses cookies

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RotationGeometry() [1/3]

◆ RotationGeometry() [2/3]

◆ ~RotationGeometry()

◆ RotationGeometry() [3/3]

Member Function Documentation

◆ absorbSectionXML()

◆ apply()

◆ buildPorts()

◆ checkFilter()

◆ execute()

◆ flushSectionXML()

◆ getDisplacements()

◆ operator=()

◆ setAxis()

◆ setDirection()

◆ setFilter()

◆ setOrigin()

◆ setRotation()

◆ swap()