#include <BaseData.h>

Abstract base class for Data. More...

Inheritance diagram for sofa::core::objectmodel::BaseData:

[legend]

Detailed Description

Abstract base class for Data.

Classes
class	BaseInitData
	This internal class is used by the initData() methods to store initialization parameters of a Data. More...

Protected Attributes
std::string	help {""}
	Help message. More...

std::string	ownerClass {""}
	Owner class. More...

std::string	group {""}
	group More...

std::string	widget {""}
	widget More...

int	m_counter
	Number of changes since creation. More...

bool	m_isSet
	True if this Data is set, i.e. its value is different from the default value. More...

DataFlags	m_dataFlags
	Flags indicating the purpose and behaviour of this Data. More...

Base *	m_owner {nullptr}
	Return the Base component owning this Data. More...

std::string	m_name
	Data name within the Base component. More...

SingleLink< BaseData, BaseData, BaseLink::FLAG_STOREPATH\|BaseLink::FLAG_DATALINK\|BaseLink::FLAG_DUPLICATE >	parentBaseData
	Parent Data. More...

Protected Attributes inherited from sofa::core::objectmodel::DDGNode
DDGLinkContainer	inputs

DDGLinkContainer	outputs

Public Member Functions
virtual BaseData *	getNewInstance ()

	BaseData (const BaseInitData &init)

	BaseData (const std::string &helpMsg, DataFlags flags=FLAG_DEFAULT)

	BaseData (const char *helpMsg, DataFlags flags=FLAG_DEFAULT)

	BaseData (const std::string &helpMsg, bool isDisplayed=true, bool isReadOnly=false)

	BaseData (const char *helpMsg, bool isDisplayed=true, bool isReadOnly=false)

	~BaseData () override
	Destructor. More...

virtual bool	read (const std::string &value)=0

virtual void	printValue (std::ostream &) const =0
	Print the value of this Data to a stream. More...

virtual std::string	getValueString () const =0
	Get a string representation of the value held in this Data. More...

virtual std::string	getValueTypeString () const =0
	Get the name of the type of the value held in this Data. More...

virtual const sofa::defaulttype::AbstractTypeInfo *	getValueTypeInfo () const =0

virtual const void *	getValueVoidPtr () const =0

virtual void *	beginEditVoidPtr ()=0

virtual void	endEditVoidPtr ()=0
	Must be called after beginEditVoidPtr(), after you are finished modifying this Data. More...

virtual bool	copyValue (const BaseData *parent)

const std::string &	getHelp () const
	Get a help message that describes this Data. More...

void	setHelp (const std::string &val)
	Set the help message. More...

const std::string &	getOwnerClass () const
	Get owner class. More...

void	setOwnerClass (const char *val)
	Set owner class. More...

const std::string &	getGroup () const
	Get group. More...

void	setGroup (const std::string &val)
	Set group. More...

const std::string &	getWidget () const
	Get widget. More...

void	setWidget (const char *val)
	Set widget. More...

virtual bool	isCounterValid () const =0
	True if the counter of modification gives valid information. More...

std::string	getLinkPath () const
	If we use the Data as a link and not as value directly. More...

virtual bool	canBeLinked () const

Base *	getOwner () const
	Return the Base component owning this Data. More...

void	setOwner (Base *o)
	Set the owner of this Data. More...

BaseData *	getData () const
	This method is needed by DDGNode. More...

const std::string &	getName () const
	Return the name of this Data within the Base component. More...

void	setName (const std::string &name)

bool	setParent (BaseData *parent, const std::string &path=std::string())
	Link to a parent data. The value of this data will automatically duplicate the value of the parent data. More...

bool	setParent (const std::string &path)

virtual bool	validParent (BaseData *parent)
	Check if a given Data can be linked as a parent of this data. More...

BaseData *	getParent () const

void	update () override
	Update the value of this Data. More...

Flags
void	setFlag (DataFlagsEnum flag, bool b)
	Set one of the flags. More...

bool	getFlag (DataFlagsEnum flag) const
	Get one of the flags. More...

bool	isDisplayed () const
	Return whether this Data has to be displayed in GUIs. More...

bool	isReadOnly () const
	Return whether this Data will be read-only in GUIs. More...

bool	isPersistent () const
	Return whether this Data contains persistent information. More...

bool	isAutoLink () const
	Return whether this Data should be autolinked when using the src="" syntax. More...

bool	isRequired () const
	Return whether the Data has to be set by the user for the owner component to be valid. More...

void	setDisplayed (bool b)
	Set whether this Data should be displayed in GUIs. More...

void	setReadOnly (bool b)
	Set whether this Data is read-only. More...

void	setPersistent (bool b)
	Set whether this Data contains persistent information. More...

void	setAutoLink (bool b)
	Set whether this data should be autolinked when using the src="" syntax. More...

void	setRequired (bool b)
	Set whether the Data has to be set by the user for the owner component to be valid. More...

Optimized edition and retrieval API (for multi-threading performances)
bool	isSet (const core::ExecParams *) const

bool	isSet () const

void	unset (const core::ExecParams *)
	Reset the isSet flag to false, to indicate that the current value is the default for this Data. More...

void	unset ()

void	forceSet (const core::ExecParams *)
	Reset the isSet flag to true, to indicate that the current value has been modified. More...

void	forceSet ()

int	getCounter (const core::ExecParams *) const

int	getCounter () const

Public Member Functions inherited from sofa::core::objectmodel::DDGNode
	DDGNode ()
	Constructor. More...

virtual	~DDGNode ()
	Destructor. Automatically remove remaining links. More...

void	addInput (DDGNode *n)
	Add a new input to this node. More...

void	delInput (DDGNode *n)
	Remove an input from this node. More...

void	addOutput (DDGNode *n)
	Add a new output to this node. More...

void	delOutput (DDGNode *n)
	Remove an output from this node. More...

const DDGLinkContainer &	getInputs ()
	Get the list of inputs for this DDGNode. More...

const DDGLinkContainer &	getOutputs ()
	Get the list of outputs for this DDGNode. More...

bool	isDirty (const core::ExecParams *) const
	Returns true if the DDGNode needs to be updated. More...

bool	isDirty () const

virtual void	setDirtyValue (const core::ExecParams *) final
	Indicate the value needs to be updated. More...

virtual void	setDirtyValue ()

virtual void	setDirtyOutputs (const core::ExecParams *) final
	Indicate the outputs needs to be updated. This method must be called after changing the value of this node. More...

virtual void	setDirtyOutputs ()

void	cleanDirty (const core::ExecParams *)
	Set dirty flag to false. More...

void	cleanDirty ()

virtual void	notifyEndEdit (const core::ExecParams *) final
	Notify links that the DGNode has been modified. More...

virtual void	notifyEndEdit ()

void	updateIfDirty (const core::ExecParams *) const
	Utility method to call update if necessary. This method should be called before reading of writing the value of this node. More...

void	updateIfDirty () const

Static Public Member Functions
template<class T >
static std::string	typeName (const T *=nullptr)
	Helper method to get the type name of type T. More...

Protected Member Functions
virtual void	doSetParent (BaseData *parent)

void	doDelInput (DDGNode *n) override

virtual bool	updateFromParentValue (const BaseData *parent)
	Update this Data from the value of its parent. More...

Protected Member Functions inherited from sofa::core::objectmodel::DDGNode
virtual void	doAddInput (DDGNode *n)

virtual void	doAddOutput (DDGNode *n)

virtual void	doDelOutput (DDGNode *n)

void	cleanDirtyOutputsOfInputs (const core::ExecParams *)
	the dirtyOutputs flags of all the inputs will be set to false More...

void	cleanDirtyOutputsOfInputs ()

Static Protected Member Functions
static std::string	decodeTypeName (const std::type_info &t)
	Helper method to decode the type name to a more readable form if possible. More...

Class reflection system
typedef TClass< BaseData >	MyClass

static const sofa::core::objectmodel::BaseClass *	GetClass ()

template<class T >
static void	dynamicCast (T &ptr, Base )

const BaseClass *	getClass () const

Links management
typedef std::vector< BaseLink * >	VecLink

VecLink	m_vecLink
	List of links. More...

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

virtual bool	findDataLinkDest (BaseData &ptr, const std::string &path, const BaseLink link)

template<class DataT >
bool	findDataLinkDest (DataT &ptr, const std::string &path, const BaseLink link)

void	addLink (BaseLink *l)
	Add a link. More...

BaseLink::InitLink< BaseData >	initLink (const std::string &name, const std::string &help)

Attribute details

std::string sofa::core::objectmodel::BaseData::group {""}

protected

group

std::string sofa::core::objectmodel::BaseData::help {""}

protected

Help message.

int sofa::core::objectmodel::BaseData::m_counter

protected

Number of changes since creation.

DataFlags sofa::core::objectmodel::BaseData::m_dataFlags

protected

Flags indicating the purpose and behaviour of this Data.

bool sofa::core::objectmodel::BaseData::m_isSet

protected

True if this Data is set, i.e. its value is different from the default value.

std::string sofa::core::objectmodel::BaseData::m_name

protected

Data name within the Base component.

Base* sofa::core::objectmodel::BaseData::m_owner {nullptr}

protected

Return the Base component owning this Data.

VecLink sofa::core::objectmodel::BaseData::m_vecLink

protected

List of links.

std::string sofa::core::objectmodel::BaseData::ownerClass {""}

protected

Owner class.

SingleLink<BaseData,BaseData,BaseLink::FLAG_STOREPATH|BaseLink::FLAG_DATALINK|BaseLink::FLAG_DUPLICATE> sofa::core::objectmodel::BaseData::parentBaseData

protected

Parent Data.

std::string sofa::core::objectmodel::BaseData::widget {""}

protected

widget

Constructor details

sofa::core::objectmodel::BaseData::BaseData ( const BaseInitData & init )

explicit

Constructor used via the Base::initData() methods.

sofa::core::objectmodel::BaseData::BaseData	(	const std::string &	helpMsg,
		DataFlags	flags = `FLAG_DEFAULT`
	)

Constructor.

Parameters

helpMsg	A help message that describes this Data.
flags	The flags for this Data (see DataFlagsEnum).

sofa::core::objectmodel::BaseData::BaseData	(	const char *	helpMsg,
		DataFlags	flags = `FLAG_DEFAULT`
	)

sofa::core::objectmodel::BaseData::BaseData	(	const std::string &	helpMsg,
		bool	isDisplayed = `true`,
		bool	isReadOnly = `false`
	)

Constructor.

Parameters

helpMsg	A help message that describes this Data.
isDisplayed	Whether this Data should be displayed in GUIs.
isReadOnly	Whether this Data should be modifiable in GUIs.

sofa::core::objectmodel::BaseData::BaseData	(	const char *	helpMsg,
		bool	isDisplayed = `true`,
		bool	isReadOnly = `false`
	)

sofa::core::objectmodel::BaseData::~BaseData ( )

override

Destructor.

Function details

void sofa::core::objectmodel::BaseData::addLink ( BaseLink * l )

Add a link.

Add a link. Note that this method should only be called if the link was not initialized with the initLink method

virtual void* sofa::core::objectmodel::BaseData::beginEditVoidPtr ( )

pure virtual

Get a void pointer to the value held in this Data, to be used with AbstractTypeInfo.

This pointer should be used via the instance of AbstractTypeInfo returned by getValueTypeInfo().

Warning: You must call endEditVoidPtr() once you're done modifying the value.

virtual bool sofa::core::objectmodel::BaseData::canBeLinked ( ) const

inlinevirtual

Return whether this Data can be used as a linkPath.

True by default. Useful if you want to customize the use of @ syntax (see ObjectRef and DataObjectRef)

bool sofa::core::objectmodel::BaseData::copyValue ( const BaseData * parent )

virtual

Copy the value from another Data.

Note that this is a one-time copy and not a permanent link (otherwise see setParent())

Returns: true if the copy was successful.

Copy the value of another Data. Note that this is a one-time copy and not a permanent link (otherwise see setParent)

Returns: true if copy was successfull

std::string sofa::core::objectmodel::BaseData::decodeTypeName ( const std::type_info & t )

staticprotected

Helper method to decode the type name to a more readable form if possible.

void sofa::core::objectmodel::BaseData::doDelInput ( DDGNode * n )

overrideprotectedvirtual

Reimplemented from sofa::core::objectmodel::DDGNode.

void sofa::core::objectmodel::BaseData::doSetParent ( BaseData * parent )

protectedvirtual

template<class T >

static void sofa::core::objectmodel::BaseData::dynamicCast	(	T *&	ptr,
		Base *
	)

inlinestatic

virtual void sofa::core::objectmodel::BaseData::endEditVoidPtr ( )

pure virtual

Must be called after beginEditVoidPtr(), after you are finished modifying this Data.

bool sofa::core::objectmodel::BaseData::findDataLinkDest	(	BaseData *&	ptr,
		const std::string &	path,
		const BaseLink *	link
	)

virtual

template<class DataT >

bool sofa::core::objectmodel::BaseData::findDataLinkDest	(	DataT *&	ptr,
		const std::string &	path,
		const BaseLink *	link
	)

inline

void sofa::core::objectmodel::BaseData::forceSet ( const core::ExecParams * )

inline

Reset the isSet flag to true, to indicate that the current value has been modified.

void sofa::core::objectmodel::BaseData::forceSet ( )

inline

static const sofa::core::objectmodel::BaseClass* sofa::core::objectmodel::BaseData::GetClass ( )

inlinestatic

const BaseClass* sofa::core::objectmodel::BaseData::getClass ( ) const

inline

int sofa::core::objectmodel::BaseData::getCounter ( const core::ExecParams * ) const

inline

Return the number of changes since creation This can be used to efficiently detect changes

int sofa::core::objectmodel::BaseData::getCounter ( ) const

inline

BaseData* sofa::core::objectmodel::BaseData::getData ( ) const

inline

This method is needed by DDGNode.

bool sofa::core::objectmodel::BaseData::getFlag ( DataFlagsEnum flag ) const

inline

Get one of the flags.

const std::string& sofa::core::objectmodel::BaseData::getGroup ( ) const

inline

Get group.

const std::string& sofa::core::objectmodel::BaseData::getHelp ( ) const

inline

Get a help message that describes this Data.

std::string sofa::core::objectmodel::BaseData::getLinkPath ( ) const

inline

If we use the Data as a link and not as value directly.

const VecLink& sofa::core::objectmodel::BaseData::getLinks ( ) const

inline

Accessor to the vector containing all the fields of this object.

const std::string& sofa::core::objectmodel::BaseData::getName ( ) const

inline

Return the name of this Data within the Base component.

virtual BaseData* sofa::core::objectmodel::BaseData::getNewInstance ( )

inlinevirtual

Base* sofa::core::objectmodel::BaseData::getOwner ( ) const

inline

Return the Base component owning this Data.

const std::string& sofa::core::objectmodel::BaseData::getOwnerClass ( ) const

inline

Get owner class.

BaseData* sofa::core::objectmodel::BaseData::getParent ( ) const

inline

virtual std::string sofa::core::objectmodel::BaseData::getValueString ( ) const

pure virtual

Get a string representation of the value held in this Data.

virtual const sofa::defaulttype::AbstractTypeInfo* sofa::core::objectmodel::BaseData::getValueTypeInfo ( ) const

pure virtual

Get the TypeInfo for the type of the value held in this Data.

This can be used to access the content of the Data generically, without knowing its type.

See also: sofa::defaulttype::AbstractTypeInfo

virtual std::string sofa::core::objectmodel::BaseData::getValueTypeString ( ) const

pure virtual

Get the name of the type of the value held in this Data.

virtual const void* sofa::core::objectmodel::BaseData::getValueVoidPtr ( ) const

pure virtual

Get a constant void pointer to the value held in this Data, to be used with AbstractTypeInfo.

This pointer should be used via the instance of AbstractTypeInfo returned by getValueTypeInfo().

const std::string& sofa::core::objectmodel::BaseData::getWidget ( ) const

inline

Get widget.

BaseLink::InitLink<BaseData> sofa::core::objectmodel::BaseData::initLink	(	const std::string &	name,
		const std::string &	help
	)

inlineprotected

bool sofa::core::objectmodel::BaseData::isAutoLink ( ) const

inline

Return whether this Data should be autolinked when using the src="" syntax.

virtual bool sofa::core::objectmodel::BaseData::isCounterValid ( ) const

pure virtual

True if the counter of modification gives valid information.

bool sofa::core::objectmodel::BaseData::isDisplayed ( ) const

inline

Return whether this Data has to be displayed in GUIs.

bool sofa::core::objectmodel::BaseData::isPersistent ( ) const

inline

Return whether this Data contains persistent information.

bool sofa::core::objectmodel::BaseData::isReadOnly ( ) const

inline

Return whether this Data will be read-only in GUIs.

bool sofa::core::objectmodel::BaseData::isRequired ( ) const

inline

Return whether the Data has to be set by the user for the owner component to be valid.

bool sofa::core::objectmodel::BaseData::isSet ( const core::ExecParams * ) const

inline

True if the value has been modified If this data is linked, the value of this data will be considered as modified (even if the parent's value has not been modified)s

bool sofa::core::objectmodel::BaseData::isSet ( ) const

inline

virtual void sofa::core::objectmodel::BaseData::printValue ( std::ostream & ) const

pure virtual

Print the value of this Data to a stream.

virtual bool sofa::core::objectmodel::BaseData::read ( const std::string & value )

pure virtual

Assign a value to this Data from a string representation.

Returns: true on success.

void sofa::core::objectmodel::BaseData::setAutoLink ( bool b )

inline

Set whether this data should be autolinked when using the src="" syntax.

void sofa::core::objectmodel::BaseData::setDisplayed ( bool b )

inline

Set whether this Data should be displayed in GUIs.

void sofa::core::objectmodel::BaseData::setFlag	(	DataFlagsEnum	flag,
		bool	b
	)

inline

Set one of the flags.

void sofa::core::objectmodel::BaseData::setGroup ( const std::string & val )

inline

Set group.

void sofa::core::objectmodel::BaseData::setHelp ( const std::string & val )

inline

Set the help message.

void sofa::core::objectmodel::BaseData::setName ( const std::string & name )

inline

Set the name of this Data.

This method should not be called directly, the Data registration methods in Base should be used instead.

void sofa::core::objectmodel::BaseData::setOwner ( Base * o )

inline

Set the owner of this Data.

void sofa::core::objectmodel::BaseData::setOwnerClass ( const char * val )

inline

Set owner class.

bool sofa::core::objectmodel::BaseData::setParent	(	BaseData *	parent,
		const std::string &	path = `std::string()`
	)

Link to a parent data. The value of this data will automatically duplicate the value of the parent data.

bool sofa::core::objectmodel::BaseData::setParent ( const std::string & path )

void sofa::core::objectmodel::BaseData::setPersistent ( bool b )

inline

Set whether this Data contains persistent information.

void sofa::core::objectmodel::BaseData::setReadOnly ( bool b )

inline

Set whether this Data is read-only.

void sofa::core::objectmodel::BaseData::setRequired ( bool b )

inline

Set whether the Data has to be set by the user for the owner component to be valid.

void sofa::core::objectmodel::BaseData::setWidget ( const char * val )

inline

Set widget.

template<class T >

static std::string sofa::core::objectmodel::BaseData::typeName ( const T * = nullptr )

inlinestatic

Helper method to get the type name of type T.

void sofa::core::objectmodel::BaseData::unset ( const core::ExecParams * )

inline

Reset the isSet flag to false, to indicate that the current value is the default for this Data.

void sofa::core::objectmodel::BaseData::unset ( )

inline

void sofa::core::objectmodel::BaseData::update ( )

overridevirtual

Update the value of this Data.

Implements sofa::core::objectmodel::DDGNode.

Reimplemented in sofa::core::objectmodel::DataFileNameVector, and sofa::core::objectmodel::DataFileName.

bool sofa::core::objectmodel::BaseData::updateFromParentValue ( const BaseData * parent )

protectedvirtual

Update this Data from the value of its parent.

bool sofa::core::objectmodel::BaseData::validParent ( BaseData * parent )

virtual

Check if a given Data can be linked as a parent of this data.

Enum details

anonymous enum

Default value used for flags.

Enumerator
FLAG_DEFAULT

enum sofa::core::objectmodel::BaseData::DataFlagsEnum

Flags that describe some properties of a Data, and that can be OR'd together.

Enumerator
FLAG_NONE	Means "no flag" when a value is required.
FLAG_READONLY	The Data will be read-only in GUIs.
FLAG_DISPLAYED	The Data will be displayed in GUIs.
FLAG_PERSISTENT	The Data contains persistent information.
FLAG_AUTOLINK	The Data should be autolinked when using the src="..." syntax.
FLAG_REQUIRED	True if the Data has to be set for the owner component to be valid (a warning is displayed at init otherwise)
FLAG_ANIMATION_INSTANCE
FLAG_VISUAL_INSTANCE
FLAG_HAPTICS_INSTANCE

Detailed Description

Classes

Protected Attributes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Class reflection system

Links management

Attribute details

Constructor details

Function details

Enum details