SOFA API  fdacdac3
Open source framework for multi-physics simuation
Protected Attributes | Public Member Functions | Static Public Member Functions | Protected Member Functions | Friends | List of all members
sofa::core::TMultiVecId< vtype, vaccess > Class Template Reference

#include <MultiVecId.h>

Inheritance diagram for sofa::core::TMultiVecId< vtype, vaccess >:
Inheritance graph
[legend]

Detailed Description

template<VecType vtype, VecAccess vaccess>
class sofa::core::TMultiVecId< vtype, vaccess >

Identify a vector of a given type stored in multiple State instances This class is templated in order to create different variations (generic versus specific type, read-only vs write access)

Protected Attributes

MyVecId defaultId
 

Public Member Functions

bool hasIdMap () const
 
const IdMap & getIdMap () const
 
 TMultiVecId ()=default
 
template<VecAccess vaccess2>
 TMultiVecId (const TVecId< vtype, vaccess2 > &v)
 
template<VecAccess vaccess2>
TMultiVecId< vtype, vaccess > & operator= (const TVecId< vtype, vaccess2 > &v)
 Copy assignment from another VecId. More...
 
 TMultiVecId (const TMultiVecId< vtype, vaccess > &mv)
 
TMultiVecId< vtype, vaccess > & operator= (const TMultiVecId< vtype, vaccess > &mv)
 Copy assignment. More...
 
template<VecAccess vaccess2>
 TMultiVecId (const TMultiVecId< vtype, vaccess2 > &mv)
 
template<VecAccess vaccess2>
TMultiVecId< vtype, vaccess > & operator= (const TMultiVecId< vtype, vaccess2 > &mv)
 
template<VecAccess vaccess2>
 TMultiVecId (const TMultiVecId< V_ALL, vaccess2 > &mv)
 
template<VecAccess vaccess2>
TMultiVecId< vtype, vaccess > & operator= (const TMultiVecId< V_ALL, vaccess2 > &mv)
 
void setDefaultId (const MyVecId &id)
 
template<class State >
void setId (const std::set< State > &states, const MyVecId &id)
 
void setId (const BaseState *s, const MyVecId &id)
 
void assign (const MyVecId &id)
 
const MyVecId & getId (const BaseState *s) const
 
const MyVecId & getDefaultId () const
 
std::string getName () const
 
bool isNull () const
 
template<class DataTypes >
StateVecAccessor< DataTypes, vtype, vaccess > operator[] (State< DataTypes > *s) const
 
template<class DataTypes >
StateVecAccessor< DataTypes, vtype, V_READ > operator[] (const State< DataTypes > *s) const
 

Static Public Member Functions

static TMultiVecId< vtype, vaccess > null ()
 

Protected Member Functions

IdMap & writeIdMap ()
 

Friends

template<VecType vtype2, VecAccess vaccess2>
class TMultiVecId
 
std::ostream & operator<< (std::ostream &out, const TMultiVecId< vtype, vaccess > &v)
 

Attribute details

◆ defaultId

template<VecType vtype, VecAccess vaccess>
MyVecId sofa::core::TMultiVecId< vtype, vaccess >::defaultId
protected

Constructor details

◆ TMultiVecId() [1/5]

template<VecType vtype, VecAccess vaccess>
sofa::core::TMultiVecId< vtype, vaccess >::TMultiVecId ( )
default

◆ TMultiVecId() [2/5]

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

Copy from another VecId, possibly with another type of access, with the constraint that the access must be compatible (i.e. cannot create a write-access VecId from a read-only VecId.

◆ TMultiVecId() [3/5]

template<VecType vtype, VecAccess vaccess>
sofa::core::TMultiVecId< vtype, vaccess >::TMultiVecId ( const TMultiVecId< vtype, vaccess > &  mv)
inline

◆ TMultiVecId() [4/5]

template<VecType vtype, VecAccess vaccess>
template<VecAccess vaccess2>
sofa::core::TMultiVecId< vtype, vaccess >::TMultiVecId ( const TMultiVecId< vtype, vaccess2 > &  mv)
inline

◆ TMultiVecId() [5/5]

template<VecType vtype, VecAccess vaccess>
template<VecAccess vaccess2>
sofa::core::TMultiVecId< vtype, vaccess >::TMultiVecId ( const TMultiVecId< V_ALL, vaccess2 > &  mv)
inlineexplicit

Function details

◆ assign()

template<VecType vtype, VecAccess vaccess>
void sofa::core::TMultiVecId< vtype, vaccess >::assign ( const MyVecId &  id)
inline

◆ getDefaultId()

template<VecType vtype, VecAccess vaccess>
const MyVecId& sofa::core::TMultiVecId< vtype, vaccess >::getDefaultId ( ) const
inline

◆ getId()

template<VecType vtype, VecAccess vaccess>
const MyVecId& sofa::core::TMultiVecId< vtype, vaccess >::getId ( const BaseState *  s) const
inline

◆ getIdMap()

template<VecType vtype, VecAccess vaccess>
const IdMap& sofa::core::TMultiVecId< vtype, vaccess >::getIdMap ( ) const
inline

◆ getName()

template<VecType vtype, VecAccess vaccess>
std::string sofa::core::TMultiVecId< vtype, vaccess >::getName ( ) const
inline

◆ hasIdMap()

template<VecType vtype, VecAccess vaccess>
bool sofa::core::TMultiVecId< vtype, vaccess >::hasIdMap ( ) const
inline

◆ isNull()

template<VecType vtype, VecAccess vaccess>
bool sofa::core::TMultiVecId< vtype, vaccess >::isNull ( ) const
inline

◆ null()

template<VecType vtype, VecAccess vaccess>
static TMultiVecId<vtype, vaccess> sofa::core::TMultiVecId< vtype, vaccess >::null ( )
inlinestatic

◆ operator=() [1/4]

template<VecType vtype, VecAccess vaccess>
template<VecAccess vaccess2>
TMultiVecId<vtype, vaccess>& sofa::core::TMultiVecId< vtype, vaccess >::operator= ( const TMultiVecId< V_ALL, vaccess2 > &  mv)
inline

◆ operator=() [2/4]

template<VecType vtype, VecAccess vaccess>
TMultiVecId<vtype, vaccess>& sofa::core::TMultiVecId< vtype, vaccess >::operator= ( const TMultiVecId< vtype, vaccess > &  mv)
inline

Copy assignment.

◆ operator=() [3/4]

template<VecType vtype, VecAccess vaccess>
template<VecAccess vaccess2>
TMultiVecId<vtype, vaccess>& sofa::core::TMultiVecId< vtype, vaccess >::operator= ( const TMultiVecId< vtype, vaccess2 > &  mv)
inline

◆ operator=() [4/4]

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

Copy assignment from another VecId.

◆ operator[]() [1/2]

template<VecType vtype, VecAccess vaccess>
template<class DataTypes >
StateVecAccessor<DataTypes,vtype,V_READ> sofa::core::TMultiVecId< vtype, vaccess >::operator[] ( const State< DataTypes > *  s) const
inline

◆ operator[]() [2/2]

template<VecType vtype, VecAccess vaccess>
template<class DataTypes >
StateVecAccessor<DataTypes,vtype,vaccess> sofa::core::TMultiVecId< vtype, vaccess >::operator[] ( State< DataTypes > *  s) const
inline

◆ setDefaultId()

template<VecType vtype, VecAccess vaccess>
void sofa::core::TMultiVecId< vtype, vaccess >::setDefaultId ( const MyVecId &  id)
inline

◆ setId() [1/2]

template<VecType vtype, VecAccess vaccess>
void sofa::core::TMultiVecId< vtype, vaccess >::setId ( const BaseState *  s,
const MyVecId &  id 
)
inline

◆ setId() [2/2]

template<VecType vtype, VecAccess vaccess>
template<class State >
void sofa::core::TMultiVecId< vtype, vaccess >::setId ( const std::set< State > &  states,
const MyVecId &  id 
)
inline

◆ writeIdMap()

template<VecType vtype, VecAccess vaccess>
IdMap& sofa::core::TMultiVecId< vtype, vaccess >::writeIdMap ( )
inlineprotected

Related details

◆ operator<<

template<VecType vtype, VecAccess vaccess>
std::ostream& operator<< ( std::ostream &  out,
const TMultiVecId< vtype, vaccess > &  v 
)
friend

◆ TMultiVecId

template<VecType vtype, VecAccess vaccess>
template<VecType vtype2, VecAccess vaccess2>
friend class TMultiVecId
friend