#include <WriteState.h>

Inheritance diagram for sofa::component::playback::WriteState:

Detailed Description

Write State vectors to file at a given set of time instants A period can be established 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

Public Attributes
sofa::core::objectmodel::DataFileName	d_filename

Data< bool >	d_writeX
	flag enabling output of X vector More...

Data< bool >	d_writeX0
	flag enabling output of X0 vector More...

Data< bool >	d_writeV
	flag enabling output of V vector More...

Data< bool >	d_writeF
	flag enabling output of F vector More...

Data< type::vector< double > >	d_time
	set time to write outputs (by default export at t=0) More...

Data< double >	d_period
	period between outputs More...

Data< type::vector< unsigned int > >	d_DOFsX
	set the position DOFs to write More...

Data< type::vector< unsigned int > >	d_DOFsV
	set the velocity DOFs to write More...

Data< double >	d_stopAt
	stop the simulation when the given threshold is reached More...

Data< double >	d_keperiod
	set the period to measure the kinetic energy increase More...

Public Attributes inherited from sofa::core::objectmodel::BaseObject
Data< bool >	f_listening
	if true, handle the events, otherwise ignore the events More...

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< bool >	f_printLog
	if true, emits extra messages at runtime. More...

Data< sofa::core::objectmodel::TagSet >	f_tags
	list of the subsets the object belongs to More...

Data< sofa::type::BoundingBox >	f_bbox
	this object bounding box More...

Data< sofa::core::objectmodel::ComponentState >	d_componentState
	The state of the component among (Dirty, Valid, Undefined, Loading, Invalid). More...

std::string	m_definitionSourceFileName {""}

int	m_definitionSourceFilePos {-1}

std::string	m_instanciationSourceFileName {""}

int	m_instanciationSourceFilePos {-1}

Protected Attributes
core::behavior::BaseMechanicalState *	mmodel

std::ofstream *	outfile

unsigned int	nextIteration

double	lastTime

bool	kineticEnergyThresholdReached

double	timeToTestEnergyIncrease

double	savedKineticEnergy

bool	firstExport

bool	periodicExport

bool	validInit

Protected Attributes inherited from sofa::core::objectmodel::BaseObject
SingleLink< BaseObject, BaseContext, BaseLink::FLAG_DOUBLELINK >	l_context

LinkSlaves	l_slaves

SingleLink< BaseObject, BaseObject, BaseLink::FLAG_DOUBLELINK >	l_master

Protected Attributes inherited from sofa::core::objectmodel::Base
std::map< std::string, sofa::core::DataTrackerCallback >	m_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
	SOFA_CLASS (WriteState, core::objectmodel::BaseObject)

void	init () override
	Initialization method called at graph creation and modification, during top-down traversal. More...

void	reinit () override
	Update method called when variables used in precomputation are modified. More...

void	reset () override
	Reset to initial state. More...

void	handleEvent (sofa::core::objectmodel::Event *event) override
	Handle an event. More...

Public Member Functions inherited from sofa::core::objectmodel::BaseObject
	SOFA_CLASS (BaseObject, Base)

virtual void	draw (const core::visual::VisualParams *)
	Render internal data of this object, for debugging purposes. More...

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)

Base *	findLinkDestClass (const BaseClass destType, const std::string &path, const BaseLink link) override

virtual std::string	getPathName () const override
	Return the full path name of this object. More...

virtual bool	insertInNode (BaseNode *)

virtual bool	removeInNode (BaseNode *)

SReal	getTime () const
	Current time. More...

const BaseContext *	getContext () const

BaseContext *	getContext ()

const BaseObject *	getMaster () const

BaseObject *	getMaster ()

const VecSlaves &	getSlaves () const

BaseObject *	getSlave (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 BaseClass *	getClass () 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)

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::TagSet &	getTags () 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=" ")

BaseData *	findData (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...

BaseLink *	findLink (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 VecData &	getDataFields () const
	Accessor to the vector containing all the fields of this object. More...

const MapData &	getDataAliases () const
	Accessor to the map containing all the aliases of this object. More...

const VecLink &	getLinks () const
	Accessor to the vector containing all the fields of this object. More...

const MapLink &	getLinkAliases () 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)

Static Public Member Functions
template<class T >
static bool	canCreate (T &obj, core::objectmodel::BaseContext context, core::objectmodel::BaseObjectDescription *arg)

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 BaseClass *	GetClass ()

template<class T >
static std::string	shortName (const T ptr=nullptr, BaseObjectDescription =nullptr)

Protected Member Functions
	WriteState ()

	~WriteState () 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, std::size_t, 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...

Attribute details

◆ d_DOFsV

Data< type::vector<unsigned int> > sofa::component::playback::WriteState::d_DOFsV

set the velocity DOFs to write

◆ d_DOFsX

Data< type::vector<unsigned int> > sofa::component::playback::WriteState::d_DOFsX

set the position DOFs to write

◆ d_filename

sofa::core::objectmodel::DataFileName sofa::component::playback::WriteState::d_filename

◆ d_keperiod

Data< double > sofa::component::playback::WriteState::d_keperiod

set the period to measure the kinetic energy increase

◆ d_period

Data< double > sofa::component::playback::WriteState::d_period

period between outputs

◆ d_stopAt

Data< double > sofa::component::playback::WriteState::d_stopAt

stop the simulation when the given threshold is reached

◆ d_time

Data< type::vector<double> > sofa::component::playback::WriteState::d_time

set time to write outputs (by default export at t=0)

◆ d_writeF

Data< bool > sofa::component::playback::WriteState::d_writeF

flag enabling output of F vector

◆ d_writeV

Data< bool > sofa::component::playback::WriteState::d_writeV

flag enabling output of V vector

◆ d_writeX

Data< bool > sofa::component::playback::WriteState::d_writeX

flag enabling output of X vector

◆ d_writeX0

Data< bool > sofa::component::playback::WriteState::d_writeX0

flag enabling output of X0 vector

◆ firstExport

bool sofa::component::playback::WriteState::firstExport

protected

◆ kineticEnergyThresholdReached

bool sofa::component::playback::WriteState::kineticEnergyThresholdReached

protected

◆ lastTime

double sofa::component::playback::WriteState::lastTime

protected

◆ mmodel

core::behavior::BaseMechanicalState* sofa::component::playback::WriteState::mmodel

protected

◆ nextIteration

unsigned int sofa::component::playback::WriteState::nextIteration

protected

◆ outfile

std::ofstream* sofa::component::playback::WriteState::outfile

protected

◆ periodicExport

bool sofa::component::playback::WriteState::periodicExport

protected

◆ savedKineticEnergy

double sofa::component::playback::WriteState::savedKineticEnergy

protected

◆ timeToTestEnergyIncrease

double sofa::component::playback::WriteState::timeToTestEnergyIncrease

protected

◆ validInit

bool sofa::component::playback::WriteState::validInit

protected

Constructor details

◆ WriteState()

sofa::component::playback::WriteState::WriteState ( )

protected

◆ ~WriteState()

sofa::component::playback::WriteState::~WriteState ( )

overrideprotected

Function details

◆ canCreate()

template<class T >

static bool sofa::component::playback::WriteState::canCreate	(	T *&	obj,
		core::objectmodel::BaseContext *	context,
		core::objectmodel::BaseObjectDescription *	arg
	)

inlinestatic

Pre-construction check method called by ObjectFactory. Check that DataTypes matches the MechanicalState.

◆ handleEvent()

void sofa::component::playback::WriteState::handleEvent ( sofa::core::objectmodel::Event * )

overridevirtual

Handle an event.

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

◆ init()

void sofa::component::playback::WriteState::init ( void )

overridevirtual

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

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

◆ reinit()

void sofa::component::playback::WriteState::reinit ( )

overridevirtual

Update method called when variables used in precomputation are modified.

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

◆ reset()

void sofa::component::playback::WriteState::reset ( )

overridevirtual

Reset to initial state.

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

◆ SOFA_CLASS()

sofa::component::playback::WriteState::SOFA_CLASS	(	WriteState	,
		core::objectmodel::BaseObject
	)

Detailed Description

Public Attributes

Protected Attributes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Attribute details

◆ d_DOFsV

◆ d_DOFsX

◆ d_filename

◆ d_keperiod

◆ d_period

◆ d_stopAt

◆ d_time

◆ d_writeF

◆ d_writeV

◆ d_writeX

◆ d_writeX0

◆ firstExport

◆ kineticEnergyThresholdReached

◆ lastTime

◆ mmodel

◆ nextIteration

◆ outfile

◆ periodicExport

◆ savedKineticEnergy

◆ timeToTestEnergyIncrease

◆ validInit

Constructor details

◆ WriteState()

◆ ~WriteState()

Function details

◆ canCreate()

◆ handleEvent()

◆ init()

◆ reinit()

◆ reset()

◆ SOFA_CLASS()