SOFA API  cd4ffb93
Open source framework for multi-physics simuation
Public Member Functions | Static Public Member Functions | Friends | List of all members
sofa::core::TVecId< V_ALL, vaccess > Class Template Reference

#include <VecId.h>

Identify any vector stored in State. More...

Inheritance diagram for sofa::core::TVecId< V_ALL, vaccess >:
Inheritance graph
[legend]

Detailed Description

template<VecAccess vaccess>
class sofa::core::TVecId< V_ALL, vaccess >

Identify any vector stored in State.

Public Member Functions

 TVecId ()
 
 TVecId (VecType t, unsigned int i)
 
template<VecType vtype2, VecAccess vaccess2>
 TVecId (const TVecId< vtype2, vaccess2 > &v)
 
template<VecType vtype2, VecAccess vaccess2>
TVecId< V_ALL, vaccess > & operator= (const TVecId< vtype2, vaccess2 > &other)
 
template<VecType vtype2, VecAccess vaccess2>
bool operator== (const TVecId< vtype2, vaccess2 > &v) const
 
template<VecType vtype2, VecAccess vaccess2>
bool operator!= (const TVecId< vtype2, vaccess2 > &v) const
 
bool isNull () const
 
std::string getName () const
 
std::string getGroup () const
 
- Public Member Functions inherited from sofa::core::BaseVecId
VecType getType () const
 
unsigned int getIndex () const
 

Static Public Member Functions

static TVecId null ()
 
- Static Public Member Functions inherited from sofa::core::TStandardVec< V_ALL, vaccess >
static unsigned int getFirstDynamicIndex (VecType t)
 
static std::string getName (const MyVecId &v)
 
- Static Public Member Functions inherited from sofa::core::TStandardVec< V_COORD, vaccess >
static MyVecId position ()
 
static MyVecId restPosition ()
 
static MyVecId freePosition ()
 
static MyVecId resetPosition ()
 
static std::string getName (const MyVecId &v)
 
static std::string getGroup (const MyVecId &v)
 
- Static Public Member Functions inherited from sofa::core::TStandardVec< V_DERIV, vaccess >
static MyVecId velocity ()
 
static MyVecId resetVelocity ()
 
static MyVecId freeVelocity ()
 
static MyVecId normal ()
 
static MyVecId force ()
 
static MyVecId externalForce ()
 
static MyVecId dx ()
 
static MyVecId dforce ()
 
static std::string getName (const MyVecId &v)
 
static std::string getGroup (const MyVecId &v)
 
- Static Public Member Functions inherited from sofa::core::TStandardVec< V_MATDERIV, vaccess >
static MyVecId constraintJacobian ()
 
static MyVecId mappingJacobian ()
 
static std::string getName (const MyVecId &v)
 
static std::string getGroup (const MyVecId &v)
 

Friends

std::ostream & operator<< (std::ostream &out, const TVecId &v)
 

Additional Inherited Members

- Public Attributes inherited from sofa::core::BaseVecId
VecType type
 
unsigned int index
 
- Protected Member Functions inherited from sofa::core::BaseVecId
 BaseVecId (VecType t, unsigned int i)
 

Constructor details

◆ TVecId() [1/3]

template<VecAccess vaccess>
sofa::core::TVecId< V_ALL, vaccess >::TVecId ( )
inline

◆ TVecId() [2/3]

template<VecAccess vaccess>
sofa::core::TVecId< V_ALL, vaccess >::TVecId ( VecType  t,
unsigned int  i 
)
inline

◆ TVecId() [3/3]

template<VecAccess vaccess>
template<VecType vtype2, VecAccess vaccess2>
sofa::core::TVecId< V_ALL, vaccess >::TVecId ( const TVecId< vtype2, vaccess2 > &  v)
inline

Create a generic VecId from a specific or generic one, with the constraint that the access must be compatible (i.e. cannot create a write-access VecId from a read-only VecId.

Function details

◆ getGroup()

template<VecAccess vaccess>
std::string sofa::core::TVecId< V_ALL, vaccess >::getGroup ( ) const
inline

◆ getName()

template<VecAccess vaccess>
std::string sofa::core::TVecId< V_ALL, vaccess >::getName ( ) const
inline

◆ isNull()

template<VecAccess vaccess>
bool sofa::core::TVecId< V_ALL, vaccess >::isNull ( ) const
inline

◆ null()

template<VecAccess vaccess>
static TVecId sofa::core::TVecId< V_ALL, vaccess >::null ( )
inlinestatic

◆ operator!=()

template<VecAccess vaccess>
template<VecType vtype2, VecAccess vaccess2>
bool sofa::core::TVecId< V_ALL, vaccess >::operator!= ( const TVecId< vtype2, vaccess2 > &  v) const
inline

◆ operator=()

template<VecAccess vaccess>
template<VecType vtype2, VecAccess vaccess2>
TVecId<V_ALL, vaccess>& sofa::core::TVecId< V_ALL, vaccess >::operator= ( const TVecId< vtype2, vaccess2 > &  other)
inline

◆ operator==()

template<VecAccess vaccess>
template<VecType vtype2, VecAccess vaccess2>
bool sofa::core::TVecId< V_ALL, vaccess >::operator== ( const TVecId< vtype2, vaccess2 > &  v) const
inline

Related details

◆ operator<<

template<VecAccess vaccess>
std::ostream& operator<< ( std::ostream &  out,
const TVecId< V_ALL, vaccess > &  v 
)
friend