SOFA API  59c939c2
Open source framework for multi-physics simuation
sofa::core::objectmodel::EmptyData Class Reference

#include <Data.h>

Inheritance diagram for sofa::core::objectmodel::EmptyData:

Additional Inherited Members

- Protected Attributes inherited from sofa::core::objectmodel::Data< void * >
ValueType m_value
 Value. More...
 
- Protected Attributes inherited from sofa::core::objectmodel::TData< void * >
SingleLink< TData< void * >, TData< void * >, BaseLink::FLAG_DATALINK|BaseLink::FLAG_DUPLICATE > parentData
 
- Protected Attributes inherited from sofa::core::objectmodel::BaseData
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...
 
Basem_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_DUPLICATEparentBaseData
 Parent Data. More...
 
VecLink m_vecLink
 List of links. More...
 
- Protected Attributes inherited from sofa::core::objectmodel::DDGNode
DDGLinkContainer inputs
 
DDGLinkContainer outputs
 
- Public Member Functions inherited from sofa::core::objectmodel::Data< void * >
bool operator== (const void *&value) const
 
bool operator!= (const void *&value) const
 
void operator= (const void *&value)
 
virtual BaseDatagetNewInstance ()
 
 Data (const BaseData::BaseInitData &init)
 
 Data (const InitData &init)
 
 Data (const char *helpMsg=nullptr, bool isDisplayed=true, bool isReadOnly=false)
 
 Data (const std::string &helpMsg, bool isDisplayed=true, bool isReadOnly=false)
 
 Data (const void *&value, const char *helpMsg=nullptr, bool isDisplayed=true, bool isReadOnly=false)
 
 Data (const void *&value, const std::string &helpMsg, bool isDisplayed=true, bool isReadOnly=false)
 
virtual ~Data ()
 Destructor. More...
 
void ** beginEdit ()
 BeginEdit method if it is only to write the value. More...
 
void ** beginEdit (const core::ExecParams *)
 
void ** beginWriteOnly ()
 
void ** beginWriteOnly (const core::ExecParams *)
 
void endEdit ()
 
void endEdit (const core::ExecParams *)
 
void setValue (const void *&value)
 
void setValue (const core::ExecParams *, const void *&value)
 
const void *& getValue () const
 
const void *& getValue (const core::ExecParams *) const
 
virtual const void *& virtualGetValue () const
 
virtual void virtualSetValue (const void *&v)
 
virtual void virtualSetLink (const BaseData &bd)
 
virtual void ** virtualBeginEdit ()
 
virtual void virtualEndEdit ()
 
virtual const BaseClassgetClass () const
 
- Public Member Functions inherited from sofa::core::objectmodel::TData< void * >
 TData (const BaseInitData &init)
 
 TData (const char *helpMsg=nullptr, bool isDisplayed=true, bool isReadOnly=false)
 
 TData (const std::string &helpMsg, bool isDisplayed=true, bool isReadOnly=false)
 
 ~TData () override
 
void printValue (std::ostream &out) const override
 General case for printing default value. More...
 
std::string getValueString () const override
 General case for printing default value. More...
 
std::string getValueTypeString () const override
 Get the name of the type of the value held in this Data. More...
 
const sofa::defaulttype::AbstractTypeInfogetValueTypeInfo () const override
 Get info about the value type of the associated variable. More...
 
const void * getValueVoidPtr () const override
 Get current value as a void pointer (use getValueTypeInfo to find how to access it) More...
 
void * beginEditVoidPtr () override
 Begin edit current value as a void pointer (use getValueTypeInfo to find how to access it) More...
 
void endEditVoidPtr () override
 End edit current value as a void pointer (use getValueTypeInfo to find how to access it) More...
 
virtual bool read (const std::string &s) override
 
bool isCounterValid () const override
 True if the counter of modification gives valid information. More...
 
bool copyValue (const TData< void * > *parent)
 
bool copyValue (const BaseData *parent) override
 
bool validParent (BaseData *parent) override
 Check if a given Data can be linked as a parent of this data. More...
 
const BaseClassgetClass () const
 
- Public Member Functions inherited from sofa::core::objectmodel::BaseData
 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...
 
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...
 
std::string getLinkPath () const
 If we use the Data as a link and not as value directly. More...
 
virtual bool canBeLinked () const
 
BasegetOwner () const
 Return the Base component owning this Data. More...
 
void setOwner (Base *o)
 Set the owner of this Data. More...
 
BaseDatagetData () 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)
 
BaseDatagetParent () const
 
void update () override
 Update the value of this Data. More...
 
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...
 
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
 
const BaseClassgetClass () const
 
const VecLinkgetLinks () 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...
 
- 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 DDGLinkContainergetInputs ()
 Get the list of inputs for this DDGNode. More...
 
const DDGLinkContainergetOutputs ()
 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 inherited from sofa::core::objectmodel::Data< void * >
static const sofa::core::objectmodel::BaseClassGetClass ()
 
static std::string templateName (const Data< void * > *=nullptr)
 
- Static Public Member Functions inherited from sofa::core::objectmodel::TData< void * >
static const sofa::core::objectmodel::BaseClassGetClass ()
 
static std::string templateName (const TData< void * > *=nullptr)
 
- Static Public Member Functions inherited from sofa::core::objectmodel::BaseData
template<class T >
static std::string typeName (const T *=nullptr)
 Helper method to get the type name of type T. More...
 
static const sofa::core::objectmodel::BaseClassGetClass ()
 
template<class T >
static void dynamicCast (T *&ptr, Base *)
 
- Protected Member Functions inherited from sofa::core::objectmodel::TData< void * >
BaseLink::InitLink< TData< void * > > initLink (const char *name, const char *help)
 
void doSetParent (BaseData *parent) override
 
bool updateFromParentValue (const BaseData *parent) override
 Update this Data from the value of its parent. More...
 
- Protected Member Functions inherited from sofa::core::objectmodel::BaseData
void doDelInput (DDGNode *n) override
 
BaseLink::InitLink< BaseDatainitLink (const std::string &name, const std::string &help)
 
- 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 inherited from sofa::core::objectmodel::BaseData
static std::string decodeTypeName (const std::type_info &t)
 Helper method to decode the type name to a more readable form if possible. More...