sofa::component::topology::utility::TopologyChecker Class Reference

#include <TopologyChecker.h>

Inheritance diagram for sofa::component::topology::utility::TopologyChecker:

Detailed Description

The class TopologyChecker represents a SOFA component which can be added in a scene graph to test a given Topology. The topology component to be tested need to be linked using

See also

l_topology. If the Data

d_eachStep is set to true, the topology will be tested at each step using the generic method

checkTopology

Otherwise each method can be called manually: @CheckTopology will call the appropriate Check{TopologyType}Topology then call the lower level of CheckTopology.

• i.e for a Tetrahedron Topology, CheckTopology with call

  See also

  checkTetrahedronTopology then

  checkTriangleTopology and finally

  checkEdgeTopology

• At each level the topology is checked through the main element container and also the cross topology containers
• Each method return a bool and will display msg_error if problems are detected.

Public Attributes
Data< bool >	d_eachStep
	bool to check topology at each step. More...
SingleLink< TopologyChecker, sofa::core::topology::BaseMeshTopology, BaseLink::FLAG_STOREPATH|BaseLink::FLAG_STRONGLINK >	l_topology
	Link to be set to the topology container in the component graph. More...
Public Attributes inherited from sofa::core::objectmodel::BaseObject
Data< bool >	f_listening
	if true, handle the events, otherwise ignore the events More...
Public Attributes inherited from sofa::core::objectmodel::Base
std::vector< lifecycle::DeprecatedData * >	m_oldAttributes
Data< int >	d_messageLogCount
Data< std::string >	name
	Name of the object. More...
Data< bool >	f_printLog
	if true, emits extra messages at runtime. More...
Data< sofa::core::objectmodel::TagSet >	f_tags
	list of the subsets the objet belongs to More...
Data< sofa::type::BoundingBox >	f_bbox
	this object bounding box More...
Data< sofa::core::objectmodel::ComponentState >	d_componentState
	the object state More...
std::string	m_definitionSourceFileName {""}
int	m_definitionSourceFilePos {-1}
std::string	m_instanciationSourceFileName {""}
int	m_instanciationSourceFilePos {-1}

Protected Attributes
core::topology::BaseMeshTopology::SPtr	m_topology
Protected Attributes inherited from sofa::core::objectmodel::BaseObject
SingleLink< BaseObject, BaseContext, BaseLink::FLAG_DOUBLELINK >	l_context
LinkSlaves	l_slaves
SingleLink< BaseObject, BaseObject, BaseLink::FLAG_DOUBLELINK >	l_master
Protected Attributes inherited from sofa::core::objectmodel::Base
std::map< std::string, sofa::core::DataTrackerCallback >	m_internalEngine
VecData	m_vecData
	List of fields (Data instances) More...
MapData	m_aliasData
	name -> Data multi-map (includes names and aliases) More...
VecLink	m_vecLink
	List of links. More...
MapLink	m_aliasLink
	name -> Link multi-map (includes names and aliases) More...

Public Member Functions
	SOFA_CLASS (TopologyChecker, core::objectmodel::BaseObject)
void	init () override
	Initialization method called at graph creation and modification, during top-down traversal. More...
void	reinit () override
	Update method called when variables used in precomputation are modified. More...
void	handleEvent (sofa::core::objectmodel::Event *event) override
	Handle an event. More...
void	draw (const core::visual::VisualParams *vparams) override
	Render internal data of this object, for debugging purposes. More...
bool	checkTopology ()
bool	checkEdgeTopology ()
bool	checkEdgeContainer ()
	Method to test Edge container concistency. More...
bool	checkEdgeToVertexCrossContainer ()
	Method to test Edge to vertex cross container concistency. More...
bool	checkTriangleTopology ()
	} More...
bool	checkTriangleContainer ()
	Method to test Triangle container concistency. More...
bool	checkTriangleToEdgeCrossContainer ()
	Method to test triangles to edges cross container concistency. More...
bool	checkTriangleToVertexCrossContainer ()
	Method to test triangles to vertices cross container concistency. More...
bool	checkQuadTopology ()
	} More...
bool	checkQuadContainer ()
	Method to test quad container concistency. More...
bool	checkQuadToEdgeCrossContainer ()
	Method to test quads to edges cross container concistency. More...
bool	checkQuadToVertexCrossContainer ()
	Method to test quads to vertices cross container concistency. More...
bool	checkTetrahedronTopology ()
	} More...
bool	checkTetrahedronContainer ()
	Method to test Tetrahedron container concistency. More...
bool	checkTetrahedronToTriangleCrossContainer ()
	Method to test Tetrahedron to triangles cross container concistency. More...
bool	checkTetrahedronToEdgeCrossContainer ()
	Method to test Tetrahedron to edges cross container concistency. More...
bool	checkTetrahedronToVertexCrossContainer ()
	Method to test Tetrahedron to vertices cross container concistency. More...
bool	checkHexahedronTopology ()
	} More...
bool	checkHexahedronContainer ()
	Method to test Hexahedron container concistency. More...
bool	checkHexahedronToQuadCrossContainer ()
	Method to test Hexahedron to quads cross container concistency. More...
bool	checkHexahedronToEdgeCrossContainer ()
	Method to test Hexahedron to edges cross container concistency. More...
bool	checkHexahedronToVertexCrossContainer ()
	Method to test Hexahedron to vertices cross container concistency. More...
Public Member Functions inherited from sofa::core::objectmodel::BaseObject
	SOFA_CLASS (BaseObject, Base)
virtual void	computeBBox (const core::ExecParams *, bool=false)
void	setSrc (const std::string &v, std::vector< std::string > *attributeList=nullptr)
	Sets a source Object and parses it to collect dependent Data. More...
void	setSrc (const std::string &v, const BaseObject *loader, std::vector< std::string > *attributeList=nullptr)
Base *	findLinkDestClass (const BaseClass *destType, const std::string &path, const BaseLink *link) override
virtual std::string	getPathName () const override
	Return the full path name of this object. More...
virtual bool	insertInNode (BaseNode *)
virtual bool	removeInNode (BaseNode *)
SReal	getTime () const
	Current time. More...
const BaseContext *	getContext () const
BaseContext *	getContext ()
const BaseObject *	getMaster () const
BaseObject *	getMaster ()
const VecSlaves &	getSlaves () const
BaseObject *	getSlave (const std::string &name) const
virtual void	addSlave (BaseObject::SPtr s)
virtual void	removeSlave (BaseObject::SPtr s)
virtual void	handleTopologyChange ()
virtual void	handleTopologyChange (core::topology::Topology *t)
void	parse (BaseObjectDescription *arg) override
	Parse the given description to assign values to this object's fields and potentially other parameters. More...
virtual void	bwdInit ()
	Initialization method called at graph creation and modification, during bottom-up traversal. More...
void	updateInternal ()
	Update method called when variables (used to compute other internal variables) are modified. More...
virtual void	storeResetState ()
	Save the initial state for later uses in reset() More...
virtual void	reset ()
	Reset to initial state. More...
virtual void	cleanup ()
Public Member Functions inherited from sofa::core::objectmodel::Base
virtual const BaseClass *	getClass () const
void	addDeprecatedAttribute (lifecycle::DeprecatedData *attribute)
void	addUpdateCallback (const std::string &name, std::initializer_list< BaseData * > inputs, std::function< sofa::core::objectmodel::ComponentState(const DataTracker &)> function, std::initializer_list< BaseData * > outputs)
void	addOutputsToCallback (const std::string &name, std::initializer_list< BaseData * > outputs)
const std::string &	getName () const
	Accessor to the object name. More...
void	setName (const std::string &n)
	Set the name of this object. More...
void	setName (const std::string &n, int counter)
	Set the name of this object, adding an integer counter. More...
std::string	getTypeName () const
	Get the type name of this object (i.e. class and template types) More...
virtual std::string	getClassName () const
	Get the class name of this object. More...
virtual std::string	getTemplateName () const final
	Get the template type names (if any) used to instantiate this object. More...
std::string	getNameSpaceName () const
	Get the template type names (if any) used to instantiate this object. More...
void	setDefinitionSourceFileName (const std::string &sourceFileName)
	Set the source filename (where the component is implemented) More...
const std::string &	getDefinitionSourceFileName () const
	Get the source filename (where the component is implemented) More...
void	setDefinitionSourceFilePos (const int)
	Set the source location (where the component is implemented) More...
int	getDefinitionSourceFilePos () const
	Get the source location (where the component is implemented) More...
void	setInstanciationSourceFileName (const std::string &sourceFileName)
const std::string &	getInstanciationSourceFileName () const
void	setInstanciationSourceFilePos (const int)
int	getInstanciationSourceFilePos () const
void	addMessage (const sofa::helper::logging::Message &m) const
size_t	countLoggedMessages (sofa::helper::logging::Message::TypeSet t=sofa::helper::logging::Message::AnyTypes) const
const std::deque< sofa::helper::logging::Message > &	getLoggedMessages () const
const std::string	getLoggedMessagesAsString (sofa::helper::logging::Message::TypeSet t=sofa::helper::logging::Message::AnyTypes) const
void	clearLoggedMessages () const
bool	notMuted () const
const sofa::core::objectmodel::TagSet &	getTags () const
	Represents the subsets the object belongs to. More...
bool	hasTag (Tag t) const
	Return true if the object belong to the given subset. More...
void	addTag (Tag t)
	Add a subset qualification to the object. More...
void	removeTag (Tag t)
	Remove a subset qualification to the object. More...
ComponentState	getComponentState () const
bool	isComponentStateValid () const
virtual bool	parseField (const std::string &attribute, const std::string &value)
	Assign one field value (Data or Link) More...
virtual bool	hasField (const std::string &attribute) const
	Check if a given Data field or Link exists. More...
void	parseFields (const std::list< std::string > &str)
	Assign the field values stored in the given list of name + value pairs of strings. More...
virtual void	parseFields (const std::map< std::string, std::string * > &str)
	Assign the field values stored in the given map of name -> value pairs. More...
void	writeDatas (std::map< std::string, std::string * > &str)
	Write the current field values to the given map of name -> value pairs. More...
void	writeDatas (std::ostream &out, const std::string &separator=" ")
BaseData *	findData (const std::string &name) const
std::vector< BaseData * >	findGlobalField (const std::string &name) const
	Find data fields given a name: several can be found as we look into the alias map. More...
BaseLink *	findLink (const std::string &name) const
std::vector< BaseLink * >	findLinks (const std::string &name) const
	Find link fields given a name: several can be found as we look into the alias map. More...
virtual void	updateLinks (bool logErrors=true)
	Update pointers in case the pointed-to objects have appeared. More...
template<class T >
BaseData::BaseInitData	initData (::sofa::core::objectmodel::Data< T > *field, const char *name, const char *help, ::sofa::core::objectmodel::BaseData::DataFlags dataflags)
	Helper method used to initialize a data field containing a value of type T. More...
template<class T >
BaseData::BaseInitData	initData (Data< T > *field, const char *name, const char *help, bool isDisplayed=true, bool isReadOnly=false)
	Helper method used to initialize a data field containing a value of type T. More...
template<class T >
Data< T >::InitData	initData (Data< T > *field, const T &value, const char *name, const char *help, bool isDisplayed=true, bool isReadOnly=false)
	Helper method used to initialize a data field containing a value of type T. More...
void	addData (BaseData *f, const std::string &name)
void	addData (BaseData *f)
void	removeData (BaseData *f)
	Remove a data field. More...
void	addAlias (BaseData *field, const char *alias)
	Add an alias to a Data. More...
void	addLink (BaseLink *l)
	Add a link. More...
void	addAlias (BaseLink *link, const char *alias)
	Add an alias to a Link. More...
const VecData &	getDataFields () const
	Accessor to the vector containing all the fields of this object. More...
const MapData &	getDataAliases () const
	Accessor to the map containing all the aliases of this object. More...
const VecLink &	getLinks () const
	Accessor to the vector containing all the fields of this object. More...
const MapLink &	getLinkAliases () const
	Accessor to the map containing all the aliases of this object. More...
virtual bool	findDataLinkDest (BaseData *&ptr, const std::string &path, const BaseLink *link)
template<class T >
bool	findLinkDest (T *&ptr, const std::string &path, const BaseLink *link)

Protected Member Functions
	TopologyChecker ()
	} More...
	~TopologyChecker () override
Protected Member Functions inherited from sofa::core::objectmodel::BaseObject
	BaseObject ()
	~BaseObject () override
virtual void	doUpdateInternal ()
	Implementation of the internal update. More...
void	changeContextLink (BaseContext *before, BaseContext *&after)
void	changeSlavesLink (BaseObject::SPtr ptr, std::size_t, bool add)
	This method insures that slaves objects have master and context links set correctly. More...
void	trackInternalData (const BaseData &data)
	Method called to add the Data to the DataTracker (listing the Data to track) More...
void	cleanTracker ()
bool	hasDataChanged (const BaseData &data)
	Method called to know if a tracked Data has changed. More...
Protected Member Functions inherited from sofa::core::objectmodel::Base
	Base ()
virtual	~Base ()
void	initData0 (BaseData *field, BaseData::BaseInitData &res, const char *name, const char *help, bool isDisplayed=true, bool isReadOnly=false)
	Helper method used by initData() More...
void	initData0 (BaseData *field, BaseData::BaseInitData &res, const char *name, const char *help, BaseData::DataFlags dataFlags)
	Helper method used by initData() More...
template<class T >
void	initData0 (Data< T > *field, typename Data< T >::InitData &res, const T &value, const char *name, const char *help, bool isDisplayed=true, bool isReadOnly=false)
	Helper method used by initData() More...

Additional Inherited Members
Static Public Member Functions inherited from sofa::core::objectmodel::BaseObject
template<class T >
static bool	canCreate (T *, BaseContext *, BaseObjectDescription *)
	Pre-construction check method called by ObjectFactory. More...
template<class T >
static T::SPtr	create (T *, BaseContext *context, BaseObjectDescription *arg)
	Construction method called by ObjectFactory. More...
Static Public Member Functions inherited from sofa::core::objectmodel::Base
static const BaseClass *	GetClass ()
template<class T >
static std::string	shortName (const T *ptr=nullptr, BaseObjectDescription *=nullptr)

Attribute details

d_eachStep

Data<bool> sofa::component::topology::utility::TopologyChecker::d_eachStep

bool to check topology at each step.

l_topology

SingleLink<TopologyChecker, sofa::core::topology::BaseMeshTopology, BaseLink::FLAG_STOREPATH | BaseLink::FLAG_STRONGLINK> sofa::component::topology::utility::TopologyChecker::l_topology

Link to be set to the topology container in the component graph.

m_topology

core::topology::BaseMeshTopology::SPtr sofa::component::topology::utility::TopologyChecker::m_topology

protected

Constructor details

TopologyChecker()

sofa::component::topology::utility::TopologyChecker::TopologyChecker ( )

protected

}

~TopologyChecker()

sofa::component::topology::utility::TopologyChecker::~TopologyChecker ( )

overrideprotected

Function details

checkEdgeContainer()

bool sofa::component::topology::utility::TopologyChecker::checkEdgeContainer

(

)

Method to test Edge container concistency.

checkEdgeTopology()

bool sofa::component::topology::utility::TopologyChecker::checkEdgeTopology

(

)

Edge methods { Full method to check Edge Topology. Will call

See also

checkEdgeContainer and

checkEdgeToVertexCrossContainer

checkEdgeToVertexCrossContainer()

bool sofa::component::topology::utility::TopologyChecker::checkEdgeToVertexCrossContainer

(

)

Method to test Edge to vertex cross container concistency.

checkHexahedronContainer()

bool sofa::component::topology::utility::TopologyChecker::checkHexahedronContainer

(

)

Method to test Hexahedron container concistency.

checkHexahedronToEdgeCrossContainer()

bool sofa::component::topology::utility::TopologyChecker::checkHexahedronToEdgeCrossContainer

(

)

Method to test Hexahedron to edges cross container concistency.

checkHexahedronTopology()

bool sofa::component::topology::utility::TopologyChecker::checkHexahedronTopology

(

)

}

Hexahedron methods { Full method to check Hexahedron Topology. Will call

See also

checkHexahedronContainer,

checkHexahedronToQuadCrossContainer

checkHexahedronToEdgeCrossContainer and

checkHexahedronToVertexCrossContainer

checkHexahedronToQuadCrossContainer()

bool sofa::component::topology::utility::TopologyChecker::checkHexahedronToQuadCrossContainer

(

)

Method to test Hexahedron to quads cross container concistency.

checkHexahedronToVertexCrossContainer()

bool sofa::component::topology::utility::TopologyChecker::checkHexahedronToVertexCrossContainer

(

)

Method to test Hexahedron to vertices cross container concistency.

checkQuadContainer()

bool sofa::component::topology::utility::TopologyChecker::checkQuadContainer

(

)

Method to test quad container concistency.

checkQuadToEdgeCrossContainer()

bool sofa::component::topology::utility::TopologyChecker::checkQuadToEdgeCrossContainer

(

)

Method to test quads to edges cross container concistency.

checkQuadTopology()

bool sofa::component::topology::utility::TopologyChecker::checkQuadTopology

(

)

}

Quad methods { Full method to check Quad Topology. Will call

See also

checkQuadContainer,

checkQuadToEdgeCrossContainer and

checkQuadToVertexCrossContainer

checkQuadToVertexCrossContainer()

bool sofa::component::topology::utility::TopologyChecker::checkQuadToVertexCrossContainer

(

)

Method to test quads to vertices cross container concistency.

checkTetrahedronContainer()

bool sofa::component::topology::utility::TopologyChecker::checkTetrahedronContainer

(

)

Method to test Tetrahedron container concistency.

checkTetrahedronToEdgeCrossContainer()

bool sofa::component::topology::utility::TopologyChecker::checkTetrahedronToEdgeCrossContainer

(

)

Method to test Tetrahedron to edges cross container concistency.

checkTetrahedronTopology()

bool sofa::component::topology::utility::TopologyChecker::checkTetrahedronTopology

(

)

}

Tetrahedron methods { Full method to check Tetrahedron Topology. Will call

See also

checkTetrahedronContainer,

checkTetrahedronToTriangleCrossContainer

checkTetrahedronToEdgeCrossContainer and

checkTetrahedronToVertexCrossContainer

checkTetrahedronToTriangleCrossContainer()

bool sofa::component::topology::utility::TopologyChecker::checkTetrahedronToTriangleCrossContainer

(

)

Method to test Tetrahedron to triangles cross container concistency.

checkTetrahedronToVertexCrossContainer()

bool sofa::component::topology::utility::TopologyChecker::checkTetrahedronToVertexCrossContainer

(

)

Method to test Tetrahedron to vertices cross container concistency.

checkTopology()

bool sofa::component::topology::utility::TopologyChecker::checkTopology

(

)

checkTriangleContainer()

bool sofa::component::topology::utility::TopologyChecker::checkTriangleContainer

(

)

Method to test Triangle container concistency.

checkTriangleToEdgeCrossContainer()

bool sofa::component::topology::utility::TopologyChecker::checkTriangleToEdgeCrossContainer

(

)

Method to test triangles to edges cross container concistency.

checkTriangleTopology()

bool sofa::component::topology::utility::TopologyChecker::checkTriangleTopology

(

)

}

Triangle methods { Full method to check Triangle Topology. Will call

See also

checkTriangleContainer,

checkTriangleToEdgeCrossContainer and

checkTriangleToVertexCrossContainer

checkTriangleToVertexCrossContainer()

bool sofa::component::topology::utility::TopologyChecker::checkTriangleToVertexCrossContainer

(

)

Method to test triangles to vertices cross container concistency.

draw()

void sofa::component::topology::utility::TopologyChecker::draw ( const core::visual::VisualParams *  )

overridevirtual

Render internal data of this object, for debugging purposes.

Reimplemented from sofa::core::objectmodel::BaseObject.

handleEvent()

void sofa::component::topology::utility::TopologyChecker::handleEvent ( sofa::core::objectmodel::Event *  )

overridevirtual

Handle an event.

Reimplemented from sofa::core::objectmodel::BaseObject.

init()

void sofa::component::topology::utility::TopologyChecker::init ( void  )

overridevirtual

Initialization method called at graph creation and modification, during top-down traversal.

Reimplemented from sofa::core::objectmodel::BaseObject.

reinit()

void sofa::component::topology::utility::TopologyChecker::reinit ( )

overridevirtual

Update method called when variables used in precomputation are modified.

Reimplemented from sofa::core::objectmodel::BaseObject.

SOFA_CLASS()

sofa::component::topology::utility::TopologyChecker::SOFA_CLASS	(	TopologyChecker	,
		core::objectmodel::BaseObject
	)