#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...

Public 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...

bool	m_hasDefaultValue = false
	True if this Data has a default value. More...

DataLink< BaseData >	parentData
	Parent Data. More...

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	getDefaultValueString () const =0
	Get a string representation of the default 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

const void *	getValueVoidPtr () const
	Get current value as a void pointer (use getValueTypeInfo to find how to access it) More...

void *	beginEditVoidPtr ()
	Begin edit current value as a void pointer (use getValueTypeInfo to find how to access it) More...

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

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 &	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 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	hasDefaultValue () const
	Return whether the Data has a default value or not. More...

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 (const 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...

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

bool	updateValueFromLink (const BaseData *data)

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)
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	isSet () const

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

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

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
	Returns true if the DDGNode needs to be updated. More...

virtual void	setDirtyValue ()
	Indicate the value needs to be updated. More...

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

void	cleanDirty ()
	Set dirty flag to false. More...

virtual void	notifyEndEdit ()
	Notify links that the DGNode has been modified. More...

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

Static Public 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...

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

Protected Member Functions
bool	genericCopyValueFrom (const BaseData *parent)
	Try to update this Data from the value of its parent in "fast mode";. 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 ()
	the dirtyOutputs flags of all the inputs will be set to false More...

Additional Inherited Members
Protected Attributes inherited from sofa::core::objectmodel::DDGNode
DDGLinkContainer	inputs

DDGLinkContainer	outputs

Attribute details

◆ group

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

group

◆ help

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

Help message.

◆ m_counter

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

Number of changes since creation.

◆ m_dataFlags

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

Flags indicating the purpose and behaviour of this Data.

◆ m_hasDefaultValue

bool sofa::core::objectmodel::BaseData::m_hasDefaultValue = false

True if this Data has a default value.

◆ m_isSet

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

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

◆ m_name

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

Data name within the Base component.

◆ m_owner

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

Return the Base component owning this Data.

◆ ownerClass

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

Owner class.

◆ parentData

DataLink<BaseData> sofa::core::objectmodel::BaseData::parentData

Parent Data.

◆ widget

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

widget

Constructor details

◆ BaseData() [1/5]

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

explicit

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

◆ BaseData() [2/5]

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).

◆ BaseData() [3/5]

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

◆ BaseData() [4/5]

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.

◆ BaseData() [5/5]

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

◆ ~BaseData()

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

override

Destructor.

Function details

◆ beginEditVoidPtr()

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

Begin edit current value as a void pointer (use getValueTypeInfo to find how to access it)

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.

◆ canBeLinked()

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)

◆ copyValueFrom()

bool sofa::core::objectmodel::BaseData::copyValueFrom ( const BaseData * data )

Update this Data from the value of its parent.

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.

◆ decodeTypeName()

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

static

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

◆ endEditVoidPtr()

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

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

End edit current value as a void pointer (use getValueTypeInfo to find how to access it)

◆ forceSet()

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

inline

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

◆ genericCopyValueFrom()

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

protected

Try to update this Data from the value of its parent in "fast mode";.

Update this Data from the value of its parent.

◆ getCounter()

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

inline

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

◆ getData()

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

inline

This method is needed by DDGNode.

◆ getDefaultValueString()

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

pure virtual

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

Implemented in sofa::core::objectmodel::Data< T >.

◆ getFlag()

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

inline

Get one of the flags.

◆ getGroup()

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

inline

Get group.

◆ getHelp()

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

inline

Get a help message that describes this Data.

◆ getLinkPath()

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

virtual

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

◆ getName()

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

inline

Return the name of this Data within the Base component.

◆ getNewInstance()

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

inlinevirtual

◆ getOwner()

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

inline

Return the Base component owning this Data.

◆ getParent()

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

inline

◆ getValueString()

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

pure virtual

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

Implemented in sofa::core::objectmodel::Data< T >.

◆ getValueTypeInfo()

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

Implemented in sofa::core::objectmodel::Data< T >.

◆ getValueTypeString()

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

pure virtual

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

Implemented in sofa::core::objectmodel::Data< T >.

◆ getValueVoidPtr()

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

Get current value as a void pointer (use getValueTypeInfo to find how to access it)

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().

◆ getWidget()

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

inline

Get widget.

◆ hasDefaultValue()

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

inline

Return whether the Data has a default value or not.

◆ isAutoLink()

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

inline

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

◆ isDisplayed()

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

inline

Return whether this Data has to be displayed in GUIs.

◆ isPersistent()

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

inline

Return whether this Data contains persistent information.

◆ isReadOnly()

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

inline

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

◆ isRequired()

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.

◆ isSet()

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

inline

◆ printValue()

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

pure virtual

Print the value of this Data to a stream.

◆ read()

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.

◆ setAutoLink()

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

inline

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

◆ setDisplayed()

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

inline

Set whether this Data should be displayed in GUIs.

◆ setFlag()

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

inline

Set one of the flags.

◆ setGroup()

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

inline

Set group.

◆ setHelp()

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

inline

Set the help message.

◆ setName()

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.

◆ setOwner()

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

inline

Set the owner of this Data.

◆ setParent() [1/2]

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.

◆ setParent() [2/2]

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

◆ setPersistent()

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

inline

Set whether this Data contains persistent information.

◆ setReadOnly()

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

inline

Set whether this Data is read-only.

◆ setRequired()

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.

◆ setWidget()

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

inline

Set widget.

◆ typeName()

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.

◆ unset()

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

inline

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

◆ update()

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

overridevirtual

Update the value of this Data.

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

◆ updateValueFromLink()

bool sofa::core::objectmodel::BaseData::updateValueFromLink ( const BaseData * data )

◆ validParent()

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

virtual

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

Enum details

◆ anonymous enum

anonymous enum

Default value used for flags.

Enumerator
FLAG_DEFAULT

◆ DataFlagsEnum

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

Public Attributes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Attribute details

◆ group

◆ help

◆ m_counter

◆ m_dataFlags

◆ m_hasDefaultValue

◆ m_isSet

◆ m_name

◆ m_owner

◆ ownerClass

◆ parentData

◆ widget

Constructor details

◆ BaseData() [1/5]

◆ BaseData() [2/5]

◆ BaseData() [3/5]

◆ BaseData() [4/5]

◆ BaseData() [5/5]

◆ ~BaseData()

Function details

◆ beginEditVoidPtr()

◆ canBeLinked()

◆ copyValueFrom()

◆ decodeTypeName()

◆ endEditVoidPtr()

◆ forceSet()

◆ genericCopyValueFrom()

◆ getCounter()

◆ getData()

◆ getDefaultValueString()

◆ getFlag()

◆ getGroup()

◆ getHelp()

◆ getLinkPath()

◆ getName()

◆ getNewInstance()

◆ getOwner()

◆ getParent()

◆ getValueString()

◆ getValueTypeInfo()

◆ getValueTypeString()

◆ getValueVoidPtr()

◆ getWidget()

◆ hasDefaultValue()

◆ isAutoLink()

◆ isDisplayed()

◆ isPersistent()

◆ isReadOnly()

◆ isRequired()

◆ isSet()

◆ printValue()

◆ read()

◆ setAutoLink()

◆ setDisplayed()

◆ setFlag()

◆ setGroup()

◆ setHelp()

◆ setName()

◆ setOwner()

◆ setParent() [1/2]

◆ setParent() [2/2]

◆ setPersistent()

◆ setReadOnly()

◆ setRequired()

◆ setWidget()

◆ typeName()

◆ unset()

◆ update()

◆ updateValueFromLink()

◆ validParent()

Enum details

◆ anonymous enum

◆ DataFlagsEnum