SOFA API  59c939c2
Open source framework for multi-physics simuation
sofa::component::misc::ExtraMonitor< DataTypes > Class Template Reference

#include <ExtraMonitor.h>

Inheritance diagram for sofa::component::misc::ExtraMonitor< DataTypes >:

Public Attributes

Data< boolsaveWcinToGnuplot
 Editable Data. More...
 
Data< boolsaveWextToGnuplot
 export Wext of the monitored dofs as gnuplot file More...
 
Data< boolresultantF
 
Data< intminX
 
Data< intmaxX
 
Data< intdisp
 
- Public Attributes inherited from sofa::component::misc::Monitor< DataTypes >
Data< helper::vector< unsigned int > > d_indices
 Editable Data. More...
 
Data< boold_saveXToGnuplot
 export Monitored positions as gnuplot file More...
 
Data< boold_saveVToGnuplot
 export Monitored velocities as gnuplot file More...
 
Data< boold_saveFToGnuplot
 export Monitored forces as gnuplot file More...
 
Data< boold_showPositions
 see the Monitored positions More...
 
Data< RGBAColord_positionsColor
 define the color of positions More...
 
Data< boold_showVelocities
 see the Monitored velocities More...
 
Data< RGBAColord_velocitiesColor
 define the color of velocities More...
 
Data< boold_showForces
 see the Monitored forces More...
 
Data< RGBAColord_forcesColor
 define the color of forces More...
 
Data< doubled_showMinThreshold
 under this value, vectors are not represented More...
 
Data< boold_showTrajectories
 print the trajectory of Monitored particles More...
 
Data< doubled_trajectoriesPrecision
 set the dt between to save of positions More...
 
Data< RGBAColord_trajectoriesColor
 define the color of the trajectories More...
 
Data< doubled_showSizeFactor
 factor to multiply to arrows More...
 
core::objectmodel::DataFileName d_fileName
 
- Public Attributes inherited from sofa::core::objectmodel::BaseObject
Data< boolf_listening
 if true, handle the events, otherwise ignore the events More...
 
- Public Attributes inherited from sofa::core::objectmodel::Base
helper::system::SofaOStream< helper::logging::Message::Warningserr
 
helper::system::SofaOStream< helper::logging::Message::Infosout
 
helper::system::SofaEndl< Basesendl
 runs the stream processing More...
 
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::defaulttype::BoundingBoxf_bbox
 this object bounding box More...
 
Data< ComponentStated_componentstate
 the object state More...
 
Data< ComponentState > & m_componentstate {d_componentstate}
 TODO bruno: uncomment once c++17 is enabled in SOFA. More...
 
std::string m_definitionSourceFileName {""}
 
int m_definitionSourceFilePos {-1}
 
std::string m_instanciationSourceFileName {""}
 
int m_instanciationSourceFilePos {-1}
 

Protected Attributes

std::ofstream * saveGnuplotWcin
 
std::ofstream * saveGnuplotWext
 
sofa::helper::vector< RealinitialMinPos
 store the initial position on the considered coordinate for min computation More...
 
sofa::helper::vector< RealinitialMaxPos
 
sofa::helper::vector< RealinitialPos
 store the initial position on the considered coordinate for the monitored dofs More...
 
- Protected Attributes inherited from sofa::component::misc::Monitor< DataTypes >
std::ofstream * m_saveGnuplotX
 
std::ofstream * m_saveGnuplotV
 
std::ofstream * m_saveGnuplotF
 
const VecCoordm_X
 positions of the mechanical object monitored; More...
 
const VecDerivm_V
 velocities of the mechanical object monitored; More...
 
const VecDerivm_F
 forces of the mechanical object monitored; More...
 
double m_internalDt
 use for trajectoriesPrecision (save value only if trajectoriesPrecision <= internalDt) More...
 
sofa::helper::vector< sofa::helper::vector< Coord > > m_savedPos
 store all the monitored positions, for trajectories display More...
 
- Protected Attributes inherited from sofa::core::objectmodel::BaseObject
SingleLink< BaseObject, BaseContext, BaseLink::FLAG_DOUBLELINKl_context
 
LinkSlaves l_slaves
 
SingleLink< BaseObject, BaseObject, BaseLink::FLAG_DOUBLELINKl_master
 
- Protected Attributes inherited from sofa::core::objectmodel::Base
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 (SOFA_TEMPLATE(ExtraMonitor, DataTypes), SOFA_TEMPLATE(Monitor, DataTypes))
 
void init () override
 Initialization method called at graph creation and modification, during top-down traversal. More...
 
void handleEvent (core::objectmodel::Event *ev) override
 Handle an event. More...
 
void initGnuplot (const std::string path) override
 create gnuplot files More...
 
void exportGnuplot (Real time) override
 write in gnuplot files the Monitored desired data (velocities,positions,forces) More...
 
- Public Member Functions inherited from sofa::component::misc::Monitor< DataTypes >
 SOFA_CLASS (SOFA_TEMPLATE(Monitor, DataTypes), core::objectmodel::BaseObject)
 
void init () override
 init data More...
 
void reset () override
 reset Monitored values More...
 
void reinit () override
 
void handleEvent (core::objectmodel::Event *ev) override
 
void draw (const core::visual::VisualParams *vparams) override
 Render internal data of this object, for debugging purposes. 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)
 
void * findLinkDestClass (const BaseClass *destType, const std::string &path, const BaseLink *link) override
 
virtual std::string getPathName () const
 Return the full path name of this object. More...
 
virtual bool insertInNode (BaseNode *)
 
virtual bool removeInNode (BaseNode *)
 
template<class T >
T::SPtr searchLocal () const
 Local search of an object of the given type. More...
 
template<class T >
T::SPtr searchUp () const
 Upward search of an object of the given type, starting from the local context. More...
 
template<class T >
T::SPtr searchDown () const
 Downward search of an object of the given type, starting from the local context. More...
 
template<class T >
T::SPtr searchFromRoot () const
 
template<class T >
T::SPtr searchInParents () const
 
template<class T >
helper::vector< typename T::SPtr > searchAllLocal () const
 Local search of all objects of the given type. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllUp () const
 Upward search of all objects of the given type, starting from the local context. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllDown () const
 Downward search of all objects of the given type, starting from the local context. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllFromRoot () const
 Search of all objects of the given type, starting from the root. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllInParents () const
 
template<class T >
helper::vector< typename T::SPtr > searchAllLocal (const Tag &t) const
 Local search of all objects of the given type with a given Tag. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllUp (const Tag &t) const
 Upward search of all objects of the given type with a given Tag, starting from the local context. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllDown (const Tag &t) const
 Downward search of all objects of the given typee with a given Tag, starting from the local context. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllFromRoot (const Tag &t) const
 Search of all objects of the given typee with a given Tag, starting from the root. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllInParents (const Tag &t) const
 
template<class T >
helper::vector< typename T::SPtr > searchAllLocal (const TagSet &t) const
 Local search of all objects of the given type with a given TagSet. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllUp (const TagSet &t) const
 Upward search of all objects of the given type with a given TagSet, starting from the local context. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllDown (const TagSet &t) const
 Downward search of all objects of the given typee with a given TagSet, starting from the local context. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllFromRoot (const TagSet &t) const
 Search of all objects of the given typee with a given TagSet, starting from the root. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllInParents (const TagSet &t) const
 
SReal getTime () const
 Current time. More...
 
const BaseContextgetContext () const
 
BaseContextgetContext ()
 
const BaseObjectgetMaster () const
 
BaseObjectgetMaster ()
 
const VecSlavesgetSlaves () const
 
BaseObjectgetSlave (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 cleanup ()
 
- Public Member Functions inherited from sofa::core::objectmodel::Base
virtual const BaseClassgetClass () const
 
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 addOutputToCallback (const std::string &name, BaseData *output)
 
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...
 
virtual 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
 Get the template type names (if any) used to instantiate this object. More...
 
virtual 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
 
const std::string getWarnings () const
 
const std::string getOutputs () const
 use getLoggedMessageAsString() or getLoggedMessage instead. More...
 
void clearWarnings ()
 use getLoggedMessageAsString() or getLoggedMessage instead. More...
 
void clearOutputs ()
 use clearLoggedMessages() instead More...
 
void processStream (std::ostream &out)
 use clearLoggedMessages() instead More...
 
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
 
bool IsInheritingFromBase ()
 
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...
 
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 (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)
 
template<class T >
bool findLinkDest (T *&ptr, const std::string &path, const BaseLink *link)
 

Protected Member Functions

 ExtraMonitor ()
 
- Protected Member Functions inherited from sofa::component::misc::Monitor< DataTypes >
 Monitor ()
 
 ~Monitor () 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, unsigned int, 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 BaseClassGetClass ()
 
template<class T >
static void dynamicCast (T *&ptr, Base *b)
 
template<class T >
static std::string typeName (const T *ptr=nullptr)
 
template<class T >
static std::string className (const T *ptr=nullptr)
 
template<class T >
static std::string namespaceName (const T *ptr=nullptr)
 
template<class T >
static std::string templateName (const T *ptr=nullptr)
 
template<class T >
static std::string shortName (const T *ptr=nullptr, BaseObjectDescription *=nullptr)
 

Attribute details

template<class DataTypes >
Data< int > sofa::component::misc::ExtraMonitor< DataTypes >::disp

to get the displacement of the set of dofs on a given coordinate used only if savePToGnuplot is set to true (ExportPositions)

template<class DataTypes >
sofa::helper::vector< Real > sofa::component::misc::ExtraMonitor< DataTypes >::initialMaxPos
protected

store the initial position on the considered coordinate for max computation the two versions are for the case we set minX != maxX

template<class DataTypes >
sofa::helper::vector< Real > sofa::component::misc::ExtraMonitor< DataTypes >::initialMinPos
protected

store the initial position on the considered coordinate for min computation

template<class DataTypes >
sofa::helper::vector< Real > sofa::component::misc::ExtraMonitor< DataTypes >::initialPos
protected

store the initial position on the considered coordinate for the monitored dofs

template<class DataTypes >
Data< int > sofa::component::misc::ExtraMonitor< DataTypes >::maxX

to get the maximum displacement of the monitored dof on a given coordinate used only if savePToGnuplot is set to true (ExportPositions)

template<class DataTypes >
Data< int > sofa::component::misc::ExtraMonitor< DataTypes >::minX

to get the minimum displacement of the monitored dof on a given coordinate used only if savePToGnuplot is set to true (ExportPositions)

template<class DataTypes >
Data< bool > sofa::component::misc::ExtraMonitor< DataTypes >::resultantF

to compute the forces resultant on the monitored dof used only if saveFToGnuplot is set to true (ExportForces)

template<class DataTypes >
std::ofstream* sofa::component::misc::ExtraMonitor< DataTypes >::saveGnuplotWcin
protected
template<class DataTypes >
std::ofstream* sofa::component::misc::ExtraMonitor< DataTypes >::saveGnuplotWext
protected
template<class DataTypes >
Data< bool > sofa::component::misc::ExtraMonitor< DataTypes >::saveWcinToGnuplot

Editable Data.

template<class DataTypes >
Data< bool > sofa::component::misc::ExtraMonitor< DataTypes >::saveWextToGnuplot

export Wext of the monitored dofs as gnuplot file

Constructor details

template<class DataTypes >
sofa::component::misc::ExtraMonitor< DataTypes >::ExtraMonitor ( )
protected

Function details

template<class DataTypes >
void sofa::component::misc::ExtraMonitor< DataTypes >::exportGnuplot ( Real  time)
overridevirtual

write in gnuplot files the Monitored desired data (velocities,positions,forces)

Reimplemented from sofa::component::misc::Monitor< DataTypes >.

template<class DataTypes >
void sofa::component::misc::ExtraMonitor< DataTypes >::handleEvent ( core::objectmodel::Event )
overridevirtual

Handle an event.

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

template<class DataTypes >
void sofa::component::misc::ExtraMonitor< DataTypes >::init ( void  )
overridevirtual

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

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

template<class DataTypes >
void sofa::component::misc::ExtraMonitor< DataTypes >::initGnuplot ( const std::string  path)
overridevirtual

create gnuplot files

Reimplemented from sofa::component::misc::Monitor< DataTypes >.

template<class DataTypes >
sofa::component::misc::ExtraMonitor< DataTypes >::SOFA_CLASS ( SOFA_TEMPLATE(ExtraMonitor< DataTypes >, DataTypes)  ,
SOFA_TEMPLATE(Monitor, DataTypes)   
)