sofa::component::misc::WriteState Class Reference
Write State vectors to file at a given set of time instants A period can be etablished at the last time instant The DoFs to print can be chosen using DOFsX and DOFsV Stop to write the state if the kinematic energy reach a given threshold (stopAt) The energy will be measured at each period determined by keperiod. More...
#include <WriteState.h>
Public Member Functions | |
| WriteState () | |
| virtual | ~WriteState () |
| virtual void | init () |
| Initialization method called at graph modification, during bottom-up traversal. | |
| virtual void | reset () |
| Reset to initial state. | |
| virtual void | handleEvent (sofa::core::objectmodel::Event *event) |
| Handle an event. | |
Static Public Member Functions | |
| template<class T > | |
| static bool | canCreate (T *&obj, core::objectmodel::BaseContext *context, core::objectmodel::BaseObjectDescription *arg) |
| Pre-construction check method called by ObjectFactory. | |
Data Fields | |
| Data< std::string > | f_filename |
| Data< bool > | f_writeX |
| Data< bool > | f_writeV |
| Data< double > | f_interval |
| Data< helper::vector< double > > | f_time |
| Data< double > | f_period |
| Data< helper::vector< unsigned int > > | f_DOFsX |
| Data< helper::vector< unsigned int > > | f_DOFsV |
| Data< double > | f_stopAt |
| Data< double > | f_keperiod |
Protected Attributes | |
| core::componentmodel::behavior::BaseMechanicalState * | mmodel |
| std::ofstream * | outfile |
| unsigned int | nextTime |
| double | lastTime |
| bool | kineticEnergyThresholdReached |
| double | timeToTestEnergyIncrease |
| double | savedKineticEnergy |
Detailed Description
Write State vectors to file at a given set of time instants A period can be etablished at the last time instant The DoFs to print can be chosen using DOFsX and DOFsV Stop to write the state if the kinematic energy reach a given threshold (stopAt) The energy will be measured at each period determined by keperiod.Definition at line 54 of file WriteState.h.
Constructor & Destructor Documentation
| sofa::component::misc::WriteState::WriteState | ( | ) |
Definition at line 43 of file WriteState.inl.
References sofa::core::objectmodel::BaseObject::f_listening, and sofa::core::objectmodel::Data< T >::setValue().
| sofa::component::misc::WriteState::~WriteState | ( | ) | [virtual] |
Member Function Documentation
| static bool sofa::component::misc::WriteState::canCreate | ( | T *& | obj, | |
| core::objectmodel::BaseContext * | context, | |||
| core::objectmodel::BaseObjectDescription * | arg | |||
| ) | [inline, static] |
Pre-construction check method called by ObjectFactory.
Check that DataTypes matches the MechanicalState.
Reimplemented from sofa::core::objectmodel::BaseObject.
Definition at line 92 of file WriteState.h.
References sofa::core::objectmodel::BaseContext::getMechanicalState().
| void sofa::component::misc::WriteState::handleEvent | ( | sofa::core::objectmodel::Event * | e | ) | [virtual] |
Handle an event.
Reimplemented from sofa::core::objectmodel::BaseObject.
Definition at line 116 of file WriteState.inl.
References f_keperiod, f_period, f_stopAt, f_time, f_writeV, f_writeX, sofa::core::objectmodel::BaseObject::getContext(), sofa::core::objectmodel::Base::getName(), sofa::core::objectmodel::BaseContext::getTime(), sofa::core::objectmodel::Data< T >::getValue(), kineticEnergyThresholdReached, lastTime, sofa::simulation::Node::mass, mmodel, nextTime, outfile, savedKineticEnergy, timeToTestEnergyIncrease, sofa::core::componentmodel::behavior::BaseMechanicalState::writeV(), and sofa::core::componentmodel::behavior::BaseMechanicalState::writeX().
| void sofa::component::misc::WriteState::init | ( | void | ) | [virtual] |
Initialization method called at graph modification, during bottom-up traversal.
Reimplemented from sofa::core::objectmodel::BaseObject.
Definition at line 73 of file WriteState.inl.
References f_filename, f_keperiod, sofa::core::objectmodel::BaseObject::getContext(), sofa::core::objectmodel::BaseContext::getMechanicalState(), sofa::core::objectmodel::Data< T >::getValue(), mmodel, outfile, and timeToTestEnergyIncrease.
Referenced by sofa::component::misc::WriteStateCreator::addWriteState().
| void sofa::component::misc::WriteState::reset | ( | void | ) | [virtual] |
Reset to initial state.
Reimplemented from sofa::core::objectmodel::BaseObject.
Definition at line 106 of file WriteState.inl.
References f_keperiod, sofa::core::objectmodel::Data< T >::getValue(), kineticEnergyThresholdReached, lastTime, nextTime, savedKineticEnergy, and timeToTestEnergyIncrease.
Referenced by sofa::component::misc::WriteStateActivator::changeStateWriter().
Field Documentation
| Data< helper::vector<unsigned int> > sofa::component::misc::WriteState::f_DOFsV |
Definition at line 64 of file WriteState.h.
| Data< helper::vector<unsigned int> > sofa::component::misc::WriteState::f_DOFsX |
Definition at line 63 of file WriteState.h.
| Data< std::string > sofa::component::misc::WriteState::f_filename |
Definition at line 57 of file WriteState.h.
Referenced by sofa::component::misc::WriteStateCreator::addWriteState(), and init().
Definition at line 60 of file WriteState.h.
double sofa::component::misc::WriteState::lastTime [protected] |
unsigned int sofa::component::misc::WriteState::nextTime [protected] |
std::ofstream* sofa::component::misc::WriteState::outfile [protected] |
double sofa::component::misc::WriteState::savedKineticEnergy [protected] |
double sofa::component::misc::WriteState::timeToTestEnergyIncrease [protected] |
The documentation for this class was generated from the following files:
- modules/sofa/component/misc/WriteState.h
- modules/sofa/component/misc/WriteState.inl
