sofa::component::topology::EdgeData< T, Alloc > Class Template Reference

A class for storing Edge related data. More...

#include <EdgeData.h>

Inheritance diagram for sofa::component::topology::EdgeData< T, Alloc >:

Inheritance graph
[legend]
Collaboration diagram for sofa::component::topology::EdgeData< T, Alloc >:

Collaboration graph
[legend]

Public Types

typedef sofa::helper::vector
< T, Alloc >::size_type 		size_type
 size_type
typedef sofa::helper::vector
< T, Alloc >::reference 		reference
 reference to a value (read-write)
typedef sofa::helper::vector
< T, Alloc >::const_reference 		const_reference
 const reference to a value (read only)

Public Member Functions

 EdgeData (size_type n, const T &value)
 Constructor.
 EdgeData (int n, const T &value)
 Constructor.
 EdgeData (long n, const T &value)
 Constructor.
 EdgeData (size_type n)
 Constructor.
 EdgeData (const sofa::helper::vector< T, Alloc > &x)
 Constructor.
 EdgeData (typename EdgeData< T >::const_iterator first, typename EdgeData< T, Alloc >::const_iterator last)
 Constructor.
 EdgeData (void(*createFunc)(int, void *, T &, const Edge &, const sofa::helper::vector< unsigned int > &, const sofa::helper::vector< double > &)=ed_basicCreateFunc, void *createParam=(void *) NULL, void(*destroyFunc)(int, void *, T &)=ed_basicDestroyFunc, void *destroyParam=(void *) NULL)
 Optionnaly takes 2 parameters, a creation and a destruction function that will be called when adding/deleting elements.
void handleTopologyEvents (std::list< const core::componentmodel::topology::TopologyChange * >::const_iterator changeIt, std::list< const core::componentmodel::topology::TopologyChange * >::const_iterator &end)
 Handle EdgeSetTopology related events, ignore others.
void setCreateFunction (void(*createFunc)(int, void *, T &, const Edge &, const sofa::helper::vector< unsigned int > &, const sofa::helper::vector< double > &))
void setDestroyFunction (void(*destroyFunc)(int, void *, T &))
void setDestroyParameter (void *destroyParam)
void setCreateParameter (void *createParam)
void setCreateTriangleFunction (void(*createTriangleFunc)(const sofa::helper::vector< unsigned int > &, void *, helper::vector< T > &))
void setDestroyTriangleFunction (void(*destroyTriangleFunc)(const sofa::helper::vector< unsigned int > &, void *, helper::vector< T > &))
void setCreateQuadFunction (void(*createQuadFunc)(const sofa::helper::vector< unsigned int > &, void *, helper::vector< T > &))
void setDestroyQuadFunction (void(*destroyQuadFunc)(const sofa::helper::vector< unsigned int > &, void *, helper::vector< T > &))
void setCreateTetrahedronFunction (void(*createTetrahedronFunc)(const sofa::helper::vector< unsigned int > &, void *, helper::vector< T > &))
void setDestroyTetrahedronFunction (void(*destroyTetrahedronFunc)(const sofa::helper::vector< unsigned int > &, void *, helper::vector< T > &))

Private Member Functions

void swap (unsigned int i1, unsigned int i2)
 Swaps values at indices i1 and i2.
void add (unsigned int nbEdges, const sofa::helper::vector< Edge > &edge, const sofa::helper::vector< sofa::helper::vector< unsigned int > > &ancestors, const sofa::helper::vector< sofa::helper::vector< double > > &coefs)
 Add some values. Values are added at the end of the vector.
void remove (const sofa::helper::vector< unsigned int > &index)
 Remove the values corresponding to the Edges removed.

Private Attributes

void(* m_createFunc )(int, void *, T &, const Edge &, const sofa::helper::vector< unsigned int > &, const sofa::helper::vector< double > &)
 Creation function, called when adding elements.
void(* m_destroyFunc )(int, void *, T &)
 Destruction function, called when deleting elements.
void(* m_createTriangleFunc )(const sofa::helper::vector< unsigned int > &, void *, helper::vector< T > &)
 Creation function, called when adding triangles elements.
void(* m_destroyTriangleFunc )(const sofa::helper::vector< unsigned int > &, void *, helper::vector< T > &)
 Destruction function, called when removing triangles elements.
void(* m_createQuadFunc )(const sofa::helper::vector< unsigned int > &, void *, helper::vector< T > &)
 Creation function, called when adding quads elements.
void(* m_destroyQuadFunc )(const sofa::helper::vector< unsigned int > &, void *, helper::vector< T > &)
 Destruction function, called when removing quads elements.
void(* m_createTetrahedronFunc )(const sofa::helper::vector< unsigned int > &, void *, helper::vector< T > &)
 Creation function, called when adding tetrahedra elements.
void(* m_destroyTetrahedronFunc )(const sofa::helper::vector< unsigned int > &, void *, helper::vector< T > &)
 Destruction function, called when removing tetrahedra elements.
void * m_createParam
 Parameter to be passed to creation function.
void * m_destroyParam
 Parameter to be passed to destruction function.

Detailed Description

template<class T, class Alloc = std::allocator<T>>
class sofa::component::topology::EdgeData< T, Alloc >

A class for storing Edge related data.

Automatically manages topology changes.

This class is a wrapper of class helper::vector that is made to take care transparently of all topology changes that might happen (non exhaustive list: Edges added, removed, fused, renumbered).

Definition at line 71 of file EdgeData.h.

Member Typedef Documentation

template<class T , class Alloc = std::allocator<T>>
typedef sofa::helper::vector<T,Alloc>::const_reference sofa::component::topology::EdgeData< T, Alloc >::const_reference

const reference to a value (read only)

Reimplemented from sofa::helper::vector< T, Alloc >.

Definition at line 79 of file EdgeData.h.

template<class T , class Alloc = std::allocator<T>>
typedef sofa::helper::vector<T,Alloc>::reference sofa::component::topology::EdgeData< T, Alloc >::reference

reference to a value (read-write)

Reimplemented from sofa::helper::vector< T, Alloc >.

Definition at line 77 of file EdgeData.h.

template<class T , class Alloc = std::allocator<T>>
typedef sofa::helper::vector<T,Alloc>::size_type sofa::component::topology::EdgeData< T, Alloc >::size_type

size_type

Reimplemented from sofa::helper::vector< T, Alloc >.

Definition at line 75 of file EdgeData.h.

Constructor & Destructor Documentation

template<class T , class Alloc = std::allocator<T>>
sofa::component::topology::EdgeData< T, Alloc >::EdgeData ( size_type  n,
const T &  value 
) [inline]

Constructor.

Definition at line 83 of file EdgeData.h.

template<class T , class Alloc = std::allocator<T>>
sofa::component::topology::EdgeData< T, Alloc >::EdgeData ( int  n,
const T &  value 
) [inline]

Constructor.

Definition at line 85 of file EdgeData.h.

template<class T , class Alloc = std::allocator<T>>
sofa::component::topology::EdgeData< T, Alloc >::EdgeData ( long  n,
const T &  value 
) [inline]

Constructor.

Definition at line 87 of file EdgeData.h.

template<class T , class Alloc = std::allocator<T>>
sofa::component::topology::EdgeData< T, Alloc >::EdgeData ( size_type  n  )  [inline, explicit]

Constructor.

Definition at line 89 of file EdgeData.h.

template<class T , class Alloc = std::allocator<T>>
sofa::component::topology::EdgeData< T, Alloc >::EdgeData ( const sofa::helper::vector< T, Alloc > &  x  )  [inline]

Constructor.

Definition at line 91 of file EdgeData.h.

template<class T , class Alloc = std::allocator<T>>
sofa::component::topology::EdgeData< T, Alloc >::EdgeData ( typename EdgeData< T >::const_iterator  first,
typename EdgeData< T, Alloc >::const_iterator  last 
) [inline]

Constructor.

Definition at line 99 of file EdgeData.h.

template<class T , class Alloc = std::allocator<T>>
sofa::component::topology::EdgeData< T, Alloc >::EdgeData ( void(*)(int, void *, T &, const Edge &, const sofa::helper::vector< unsigned int > &, const sofa::helper::vector< double > &)  createFunc = ed_basicCreateFunc,
void *  createParam = (void*)NULL,
void(*)(int, void *, T &)  destroyFunc = ed_basicDestroyFunc,
void *  destroyParam = (void*)NULL 
) [inline]

Optionnaly takes 2 parameters, a creation and a destruction function that will be called when adding/deleting elements.

Definition at line 103 of file EdgeData.h.

Member Function Documentation

template<typename T , typename Alloc >
void sofa::component::topology::EdgeData< T, Alloc >::add ( unsigned int  nbEdges,
const sofa::helper::vector< Edge > &  edge,
const sofa::helper::vector< sofa::helper::vector< unsigned int > > &  ancestors,
const sofa::helper::vector< sofa::helper::vector< double > > &  coefs 
) [inline, private]

Add some values. Values are added at the end of the vector.

Definition at line 140 of file EdgeData.inl.

References sofa::component::topology::EdgeData< T, Alloc >::m_createFunc, and sofa::component::topology::EdgeData< T, Alloc >::m_createParam.

template<typename T , typename Alloc >
void sofa::component::topology::EdgeData< T, Alloc >::handleTopologyEvents ( std::list< const core::componentmodel::topology::TopologyChange * >::const_iterator  changeIt,
std::list< const core::componentmodel::topology::TopologyChange * >::const_iterator &  end 
) [inline]

Handle EdgeSetTopology related events, ignore others.

Definition at line 47 of file EdgeData.inl.

References sofa::component::topology::EdgesAdded::ancestorsList, sofa::component::topology::EdgesAdded::coefs, sofa::component::topology::EdgesAdded::edgeArray, sofa::core::componentmodel::topology::EDGESADDED, sofa::core::componentmodel::topology::EDGESREMOVED, sofa::component::topology::QuadsRemoved::getArray(), sofa::component::topology::TrianglesRemoved::getArray(), sofa::component::topology::TetrahedraRemoved::getArray(), sofa::component::topology::EdgesAdded::getNbAddedEdges(), sofa::component::topology::EdgeData< T, Alloc >::m_createParam, sofa::component::topology::EdgeData< T, Alloc >::m_createQuadFunc, sofa::component::topology::EdgeData< T, Alloc >::m_createTetrahedronFunc, sofa::component::topology::EdgeData< T, Alloc >::m_createTriangleFunc, sofa::component::topology::EdgeData< T, Alloc >::m_destroyQuadFunc, sofa::component::topology::EdgeData< T, Alloc >::m_destroyTetrahedronFunc, sofa::component::topology::EdgeData< T, Alloc >::m_destroyTriangleFunc, sofa::component::topology::QuadsAdded::quadIndexArray, sofa::core::componentmodel::topology::QUADSADDED, sofa::core::componentmodel::topology::QUADSREMOVED, sofa::core::componentmodel::topology::TETRAHEDRAADDED, sofa::core::componentmodel::topology::TETRAHEDRAREMOVED, sofa::component::topology::TetrahedraAdded::tetrahedronIndexArray, sofa::component::topology::TrianglesAdded::triangleIndexArray, sofa::core::componentmodel::topology::TRIANGLESADDED, and sofa::core::componentmodel::topology::TRIANGLESREMOVED.

Referenced by sofa::component::forcefield::TriangularQuadraticSpringsForceField< DataTypes >::handleTopologyChange(), and sofa::component::forcefield::TriangularBiquadraticSpringsForceField< DataTypes >::handleTopologyChange().

template<typename T , typename Alloc >
void sofa::component::topology::EdgeData< T, Alloc >::remove ( const sofa::helper::vector< unsigned int > &  index  )  [inline, private]

Remove the values corresponding to the Edges removed.

Definition at line 164 of file EdgeData.inl.

References sofa::component::topology::EdgeData< T, Alloc >::m_destroyFunc, sofa::component::topology::EdgeData< T, Alloc >::m_destroyParam, and sofa::component::topology::EdgeData< T, Alloc >::swap().

template<class T , class Alloc = std::allocator<T>>
void sofa::component::topology::EdgeData< T, Alloc >::setCreateFunction ( void(*)(int, void *, T &, const Edge &, const sofa::helper::vector< unsigned int > &, const sofa::helper::vector< double > &)  createFunc  )  [inline]

Definition at line 118 of file EdgeData.h.

Referenced by sofa::component::forcefield::TriangularQuadraticSpringsForceField< DataTypes >::init(), and sofa::component::forcefield::TriangularBiquadraticSpringsForceField< DataTypes >::init().

template<class T , class Alloc = std::allocator<T>>
void sofa::component::topology::EdgeData< T, Alloc >::setCreateParameter ( void *  createParam  )  [inline]

Definition at line 133 of file EdgeData.h.

Referenced by sofa::component::forcefield::TriangularQuadraticSpringsForceField< DataTypes >::init(), and sofa::component::forcefield::TriangularBiquadraticSpringsForceField< DataTypes >::init().

template<class T , class Alloc = std::allocator<T>>
void sofa::component::topology::EdgeData< T, Alloc >::setCreateQuadFunction ( void(*)(const sofa::helper::vector< unsigned int > &, void *, helper::vector< T > &)  createQuadFunc  )  [inline]

Definition at line 148 of file EdgeData.h.

template<class T , class Alloc = std::allocator<T>>
void sofa::component::topology::EdgeData< T, Alloc >::setCreateTetrahedronFunction ( void(*)(const sofa::helper::vector< unsigned int > &, void *, helper::vector< T > &)  createTetrahedronFunc  )  [inline]

Definition at line 158 of file EdgeData.h.

template<class T , class Alloc = std::allocator<T>>
void sofa::component::topology::EdgeData< T, Alloc >::setCreateTriangleFunction ( void(*)(const sofa::helper::vector< unsigned int > &, void *, helper::vector< T > &)  createTriangleFunc  )  [inline]

Definition at line 138 of file EdgeData.h.

template<class T , class Alloc = std::allocator<T>>
void sofa::component::topology::EdgeData< T, Alloc >::setDestroyFunction ( void(*)(int, void *, T &)  destroyFunc  )  [inline]

Definition at line 123 of file EdgeData.h.

template<class T , class Alloc = std::allocator<T>>
void sofa::component::topology::EdgeData< T, Alloc >::setDestroyParameter ( void *  destroyParam  )  [inline]

Definition at line 128 of file EdgeData.h.

Referenced by sofa::component::forcefield::TriangularQuadraticSpringsForceField< DataTypes >::init(), and sofa::component::forcefield::TriangularBiquadraticSpringsForceField< DataTypes >::init().

template<class T , class Alloc = std::allocator<T>>
void sofa::component::topology::EdgeData< T, Alloc >::setDestroyQuadFunction ( void(*)(const sofa::helper::vector< unsigned int > &, void *, helper::vector< T > &)  destroyQuadFunc  )  [inline]

Definition at line 153 of file EdgeData.h.

template<class T , class Alloc = std::allocator<T>>
void sofa::component::topology::EdgeData< T, Alloc >::setDestroyTetrahedronFunction ( void(*)(const sofa::helper::vector< unsigned int > &, void *, helper::vector< T > &)  destroyTetrahedronFunc  )  [inline]

Definition at line 163 of file EdgeData.h.

template<class T , class Alloc = std::allocator<T>>
void sofa::component::topology::EdgeData< T, Alloc >::setDestroyTriangleFunction ( void(*)(const sofa::helper::vector< unsigned int > &, void *, helper::vector< T > &)  destroyTriangleFunc  )  [inline]

Definition at line 143 of file EdgeData.h.

template<typename T , typename Alloc >
void sofa::component::topology::EdgeData< T, Alloc >::swap ( unsigned int  i1,
unsigned int  i2 
) [inline, private]

Swaps values at indices i1 and i2.

Definition at line 132 of file EdgeData.inl.

Referenced by sofa::component::topology::EdgeData< T, Alloc >::remove().

Field Documentation

template<class T , class Alloc = std::allocator<T>>
void(* sofa::component::topology::EdgeData< T, Alloc >::m_createFunc)(int, void *, T &, const Edge &, const sofa::helper::vector< unsigned int > &, const sofa::helper::vector< double > &) [private]

Creation function, called when adding elements.

Referenced by sofa::component::topology::EdgeData< T, Alloc >::add(), and sofa::component::topology::EdgeData< sofa::component::forcefield::TriangularFEMForceField::EdgeInformation >::setCreateFunction().

template<class T , class Alloc = std::allocator<T>>
void* sofa::component::topology::EdgeData< T, Alloc >::m_createParam [private]

Parameter to be passed to creation function.

Warning : construction and destruction of this object is not of the responsibility of EdgeData.

Definition at line 210 of file EdgeData.h.

Referenced by sofa::component::topology::EdgeData< T, Alloc >::add(), sofa::component::topology::EdgeData< T, Alloc >::handleTopologyEvents(), and sofa::component::topology::EdgeData< sofa::component::forcefield::TriangularFEMForceField::EdgeInformation >::setCreateParameter().

template<class T , class Alloc = std::allocator<T>>
void(* sofa::component::topology::EdgeData< T, Alloc >::m_createQuadFunc)(const sofa::helper::vector< unsigned int > &, void *, helper::vector< T > &) [private]

Creation function, called when adding quads elements.

Referenced by sofa::component::topology::EdgeData< T, Alloc >::handleTopologyEvents(), and sofa::component::topology::EdgeData< sofa::component::forcefield::TriangularFEMForceField::EdgeInformation >::setCreateQuadFunction().

template<class T , class Alloc = std::allocator<T>>
void(* sofa::component::topology::EdgeData< T, Alloc >::m_createTetrahedronFunc)(const sofa::helper::vector< unsigned int > &, void *, helper::vector< T > &) [private]

Creation function, called when adding tetrahedra elements.

Referenced by sofa::component::topology::EdgeData< T, Alloc >::handleTopologyEvents(), and sofa::component::topology::EdgeData< sofa::component::forcefield::TriangularFEMForceField::EdgeInformation >::setCreateTetrahedronFunction().

template<class T , class Alloc = std::allocator<T>>
void(* sofa::component::topology::EdgeData< T, Alloc >::m_createTriangleFunc)(const sofa::helper::vector< unsigned int > &, void *, helper::vector< T > &) [private]

Creation function, called when adding triangles elements.

Referenced by sofa::component::topology::EdgeData< T, Alloc >::handleTopologyEvents(), and sofa::component::topology::EdgeData< sofa::component::forcefield::TriangularFEMForceField::EdgeInformation >::setCreateTriangleFunction().

template<class T , class Alloc = std::allocator<T>>
void(* sofa::component::topology::EdgeData< T, Alloc >::m_destroyFunc)(int, void *, T &) [private]

Destruction function, called when deleting elements.

Referenced by sofa::component::topology::EdgeData< T, Alloc >::remove(), and sofa::component::topology::EdgeData< sofa::component::forcefield::TriangularFEMForceField::EdgeInformation >::setDestroyFunction().

template<class T , class Alloc = std::allocator<T>>
void* sofa::component::topology::EdgeData< T, Alloc >::m_destroyParam [private]

Parameter to be passed to destruction function.

Warning : construction and destruction of this object is not of the responsibility of EdgeData.

Definition at line 216 of file EdgeData.h.

Referenced by sofa::component::topology::EdgeData< T, Alloc >::remove(), and sofa::component::topology::EdgeData< sofa::component::forcefield::TriangularFEMForceField::EdgeInformation >::setDestroyParameter().

template<class T , class Alloc = std::allocator<T>>
void(* sofa::component::topology::EdgeData< T, Alloc >::m_destroyQuadFunc)(const sofa::helper::vector< unsigned int > &, void *, helper::vector< T > &) [private]

Destruction function, called when removing quads elements.

Referenced by sofa::component::topology::EdgeData< T, Alloc >::handleTopologyEvents(), and sofa::component::topology::EdgeData< sofa::component::forcefield::TriangularFEMForceField::EdgeInformation >::setDestroyQuadFunction().

template<class T , class Alloc = std::allocator<T>>
void(* sofa::component::topology::EdgeData< T, Alloc >::m_destroyTetrahedronFunc)(const sofa::helper::vector< unsigned int > &, void *, helper::vector< T > &) [private]

Destruction function, called when removing tetrahedra elements.

Referenced by sofa::component::topology::EdgeData< T, Alloc >::handleTopologyEvents(), and sofa::component::topology::EdgeData< sofa::component::forcefield::TriangularFEMForceField::EdgeInformation >::setDestroyTetrahedronFunction().

template<class T , class Alloc = std::allocator<T>>
void(* sofa::component::topology::EdgeData< T, Alloc >::m_destroyTriangleFunc)(const sofa::helper::vector< unsigned int > &, void *, helper::vector< T > &) [private]

Destruction function, called when removing triangles elements.

Referenced by sofa::component::topology::EdgeData< T, Alloc >::handleTopologyEvents(), and sofa::component::topology::EdgeData< sofa::component::forcefield::TriangularFEMForceField::EdgeInformation >::setDestroyTriangleFunction().

The documentation for this class was generated from the following files:
Generated on Sun Nov 23 04:21:22 2008 for Sofa by  doxygen 1.5.7.1