SOFA API  ca70b0f0
Open source framework for multi-physics simuation
sofa::core::objectmodel::DataFileName Class Reference

#include <DataFileName.h>

Data specialized to store filenames, potentially relative to the current directory at the time it was specified. More...

Inheritance diagram for sofa::core::objectmodel::DataFileName:

Detailed Description

Data specialized to store filenames, potentially relative to the current directory at the time it was specified.

Protected Attributes

std::string m_fullpath
 
std::string m_relativepath
 
std::string m_extension
 
PathType m_pathType
 used to determine how file dialogs should be opened More...
 
- Protected Attributes inherited from sofa::core::objectmodel::Data< std::string >
std::string m_defaultValue
 
ValueType m_value
 Value. More...
 
- Protected Attributes inherited from sofa::core::objectmodel::DDGNode
DDGLinkContainer inputs
 
DDGLinkContainer outputs
 

Public Member Functions

 DataFileName (const std::string &helpMsg="", bool isDisplayed=true, bool isReadOnly=false)
 
 DataFileName (const std::string &value, const std::string &helpMsg="", bool isDisplayed=true, bool isReadOnly=false)
 
 DataFileName (const BaseData::BaseInitData &init)
 
 DataFileName (const Inherit::InitData &init)
 
 ~DataFileName () override=default
 
void setPathType (PathType pathType)
 
PathType getPathType () const
 
bool read (const std::string &s) override
 
void endEdit () override
 
virtual const std::string & getRelativePath () const
 
virtual const std::string & getFullPath () const
 
virtual const std::string & getAbsolutePath () const
 
virtual const std::string & getExtension () const
 
void doOnUpdate () override
 
 DataFileName (const Inherit &d)=delete
 
DataFileNameoperator= (const DataFileName &)=delete
 
- Public Member Functions inherited from sofa::core::objectmodel::Data< std::string >
 Data (const Data &)=delete
 
const sofa::defaulttype::AbstractTypeInfogetValueTypeInfo () const override
 Get info about the value type of the associated variable. More...
 
bool read (const std::string &s) override
 
bool SOFA_CORE_API read (const std::string &str)
 Specialization for reading strings. More...
 
bool SOFA_CORE_API read (const std::string &str)
 Specialization for reading booleans. More...
 
bool read (const std::string &str)
 Specialization for reading strings. More...
 
bool read (const std::string &str)
 Specialization for reading booleans. More...
 
void printValue (std::ostream &out) const override
 General case for printing default value. More...
 
std::string getValueString () const override
 General case for printing value. More...
 
std::string getDefaultValueString () 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...
 
void operator= (const std::string &value)
 
Dataoperator= (const Data &)=delete
 
bool copyValueFrom (const Data< std::string > *data)
 
virtual std::string * beginEdit ()
 
virtual std::string * beginWriteOnly ()
 
void setValue (const std::string &value)
 
const std::string & getValue () const
 
BaseDatagetNewInstance () override
 
 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 std::string &value, const char *helpMsg=nullptr, bool isDisplayed=true, bool isReadOnly=false)
 
 Data (const std::string &value, const std::string &helpMsg, bool isDisplayed=true, bool isReadOnly=false)
 
 ~Data () override
 Destructor. More...
 
- 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 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
 
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 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...
 
BaseDatagetParent () 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)
 
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
 
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 DDGLinkContainergetInputs ()
 Get the list of inputs for this DDGNode. More...
 
const DDGLinkContainergetOutputs ()
 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...
 

Protected Member Functions

void updatePath ()
 
- Protected Member Functions inherited from sofa::core::objectmodel::Data< std::string >
std::istream & readValue (std::istream &in)
 
std::istream & readValue (std::istream &in)
 
SOFA_CORE_API std::istream & readValue (std::istream &in)
 
- Protected Member Functions inherited from sofa::core::objectmodel::BaseData
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

- Public Attributes inherited from sofa::core::objectmodel::Data< std::string >
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...
 
- Public 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...
 
bool m_hasDefaultValue = false
 True if this Data has a default value. More...
 
DataLink< BaseDataparentData
 Parent Data. More...
 
- Static Public Member Functions inherited from sofa::core::objectmodel::Data< std::string >
static constexpr bool isCopyOnWrite ()
 
static std::string templateName ()
 
- Static Public 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...
 
template<class T >
static std::string typeName (const T *=nullptr)
 Helper method to get the type name of type T. More...
 

Attribute details

◆ m_extension

std::string sofa::core::objectmodel::DataFileName::m_extension
protected

◆ m_fullpath

std::string sofa::core::objectmodel::DataFileName::m_fullpath
protected

◆ m_pathType

PathType sofa::core::objectmodel::DataFileName::m_pathType
protected

used to determine how file dialogs should be opened

◆ m_relativepath

std::string sofa::core::objectmodel::DataFileName::m_relativepath
protected

Constructor details

◆ DataFileName() [1/5]

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

◆ DataFileName() [2/5]

sofa::core::objectmodel::DataFileName::DataFileName ( const std::string &  value,
const std::string &  helpMsg = "",
bool  isDisplayed = true,
bool  isReadOnly = false 
)

◆ DataFileName() [3/5]

sofa::core::objectmodel::DataFileName::DataFileName ( const BaseData::BaseInitData init)
explicit

Constructor this constructor should be used through the initData() methods

◆ DataFileName() [4/5]

sofa::core::objectmodel::DataFileName::DataFileName ( const Inherit::InitData &  init)
explicit

Constructor this constructor should be used through the initData() methods

◆ ~DataFileName()

sofa::core::objectmodel::DataFileName::~DataFileName ( )
overridedefault

◆ DataFileName() [5/5]

sofa::core::objectmodel::DataFileName::DataFileName ( const Inherit d)
delete

Function details

◆ doOnUpdate()

void sofa::core::objectmodel::DataFileName::doOnUpdate ( )
overridevirtual

Reimplemented from sofa::core::objectmodel::BaseData.

◆ endEdit()

void sofa::core::objectmodel::DataFileName::endEdit ( )
overridevirtual

◆ getAbsolutePath()

const std::string & sofa::core::objectmodel::DataFileName::getAbsolutePath ( ) const
virtual

◆ getExtension()

const std::string & sofa::core::objectmodel::DataFileName::getExtension ( ) const
virtual

◆ getFullPath()

const std::string & sofa::core::objectmodel::DataFileName::getFullPath ( ) const
virtual

◆ getPathType()

PathType sofa::core::objectmodel::DataFileName::getPathType ( ) const

◆ getRelativePath()

const std::string & sofa::core::objectmodel::DataFileName::getRelativePath ( ) const
virtual

◆ operator=()

DataFileName& sofa::core::objectmodel::DataFileName::operator= ( const DataFileName )
delete

◆ read()

bool sofa::core::objectmodel::DataFileName::read ( const std::string &  value)
overridevirtual

Assign a value to this Data from a string representation.

Returns
true on success.

Implements sofa::core::objectmodel::BaseData.

◆ setPathType()

void sofa::core::objectmodel::DataFileName::setPathType ( PathType  pathType)

◆ updatePath()

void sofa::core::objectmodel::DataFileName::updatePath ( )
protected