SOFA API  7352f41a
Open source framework for multi-physics simuation
sofa::helper::AdvancedTimer::Id< Base > Class Template Reference

#include <AdvancedTimer.h>

Inheritance diagram for sofa::helper::AdvancedTimer::Id< Base >:

Classes

class  IdFactory
 

Protected Attributes

unsigned int id
 
- Protected Attributes inherited from sofa::core::objectmodel::Base
std::map< std::string, sofa::core::DataTrackerCallbackm_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

 Id ()
 
 Id (const std::string &s)
 An Id is constructed from a string and appears like one after, without actually storing a string. More...
 
 Id (const char *s)
 An Id is constructed from a string and appears like one after, without actually storing a string. More...
 
 Id (unsigned int id)
 This constructor should be used only if really necessary. More...
 
 operator unsigned int () const
 Any operation requiring an int can be used on an id using this conversion. More...
 
 operator std::string () const
 Any operation requiring a string can be used on an id using this conversion. More...
 
bool operator== (const Id< Base > &t) const
 
bool operator!= (const Id< Base > &t) const
 
bool operator< (const Id< Base > &t) const
 
bool operator> (const Id< Base > &t) const
 
bool operator<= (const Id< Base > &t) const
 
bool operator>= (const Id< Base > &t) const
 
bool operator! () const
 
- Public Member Functions inherited from sofa::core::objectmodel::Base
virtual const BaseClassgetClass () 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)
 
virtual std::string getPathName () const
 
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::TagSetgetTags () 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...
 
virtual void parse (BaseObjectDescription *arg)
 Parse the given description to assign values to this object's fields and potentially other parameters. 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=" ")
 
BaseDatafindData (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...
 
BaseLinkfindLink (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 VecDatagetDataFields () const
 Accessor to the vector containing all the fields of this object. More...
 
const MapDatagetDataAliases () const
 Accessor to the map containing all the aliases of this object. More...
 
const VecLinkgetLinks () const
 Accessor to the vector containing all the fields of this object. More...
 
const MapLinkgetLinkAliases () 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)
 
virtual BasefindLinkDestClass (const BaseClass *destType, const std::string &path, const BaseLink *link)
 
template<class T >
bool findLinkDest (T *&ptr, const std::string &path, const BaseLink *link)
 

Friends

std::ostream & operator<< (std::ostream &o, const Id< Base > &t)
 
std::istream & operator>> (std::istream &i, Id< Base > &t)
 

Additional Inherited Members

- 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< boolf_printLog
 if true, emits extra messages at runtime. More...
 
Data< sofa::core::objectmodel::TagSetf_tags
 list of the subsets the objet belongs to More...
 
Data< sofa::type::BoundingBoxf_bbox
 this object bounding box More...
 
Data< sofa::core::objectmodel::ComponentStated_componentState
 the object state More...
 
std::string m_definitionSourceFileName {""}
 
int m_definitionSourceFilePos {-1}
 
std::string m_instanciationSourceFileName {""}
 
int m_instanciationSourceFilePos {-1}
 
- Static Public Member Functions inherited from sofa::core::objectmodel::Base
static const BaseClassGetClass ()
 
template<class T >
static std::string shortName (const T *ptr=nullptr, BaseObjectDescription *=nullptr)
 
- 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...
 

Attribute details

◆ id

template<class Base >
unsigned int sofa::helper::AdvancedTimer::Id< Base >::id
protected

Constructor details

◆ Id() [1/4]

template<class Base >
sofa::helper::AdvancedTimer::Id< Base >::Id ( )
inline

◆ Id() [2/4]

template<class Base >
sofa::helper::AdvancedTimer::Id< Base >::Id ( const std::string &  s)
inline

An Id is constructed from a string and appears like one after, without actually storing a string.

◆ Id() [3/4]

template<class Base >
sofa::helper::AdvancedTimer::Id< Base >::Id ( const char s)
inline

An Id is constructed from a string and appears like one after, without actually storing a string.

◆ Id() [4/4]

template<class Base >
sofa::helper::AdvancedTimer::Id< Base >::Id ( unsigned int  id)
inline

This constructor should be used only if really necessary.

Function details

◆ operator std::string()

template<class Base >
sofa::helper::AdvancedTimer::Id< Base >::operator std::string ( ) const
inline

Any operation requiring a string can be used on an id using this conversion.

◆ operator unsigned int()

template<class Base >
sofa::helper::AdvancedTimer::Id< Base >::operator unsigned int ( ) const
inline

Any operation requiring an int can be used on an id using this conversion.

◆ operator!()

template<class Base >
bool sofa::helper::AdvancedTimer::Id< Base >::operator! ( ) const
inline

◆ operator!=()

template<class Base >
bool sofa::helper::AdvancedTimer::Id< Base >::operator!= ( const Id< Base > &  t) const
inline

◆ operator<()

template<class Base >
bool sofa::helper::AdvancedTimer::Id< Base >::operator< ( const Id< Base > &  t) const
inline

◆ operator<=()

template<class Base >
bool sofa::helper::AdvancedTimer::Id< Base >::operator<= ( const Id< Base > &  t) const
inline

◆ operator==()

template<class Base >
bool sofa::helper::AdvancedTimer::Id< Base >::operator== ( const Id< Base > &  t) const
inline

◆ operator>()

template<class Base >
bool sofa::helper::AdvancedTimer::Id< Base >::operator> ( const Id< Base > &  t) const
inline

◆ operator>=()

template<class Base >
bool sofa::helper::AdvancedTimer::Id< Base >::operator>= ( const Id< Base > &  t) const
inline

Related details

◆ operator<<

template<class Base >
std::ostream& operator<< ( std::ostream &  o,
const Id< Base > &  t 
)
friend

◆ operator>>

template<class Base >
std::istream& operator>> ( std::istream &  i,
Id< Base > &  t 
)
friend