#include <DataFileName.h>

Inheritance diagram for sofa::core::objectmodel::DataFileNameVector:

[legend]

Protected Attributes
sofa::helper::vector< std::string >	m_fullpath

PathType	m_pathType

Protected Attributes inherited from sofa::core::objectmodel::Data< sofa::helper::SVector< std::string > >
ValueType	m_value
	Value. More...

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

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

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

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

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

DDGLinkContainer	outputs

Public Member Functions
	DataFileNameVector (const char *helpMsg=nullptr, bool isDisplayed=true, bool isReadOnly=false)

	DataFileNameVector (const sofa::helper::vector< std::string > &value, const char *helpMsg=nullptr, bool isDisplayed=true, bool isReadOnly=false)

	DataFileNameVector (const BaseData::BaseInitData &init)

	DataFileNameVector (const Inherit::InitData &init)

virtual	~DataFileNameVector ()

void	endEdit ()

void	endEdit (const core::ExecParams *)

void	setValue (const sofa::helper::vector< std::string > &v)

virtual void	virtualEndEdit ()

void	addPath (const std::string &v, bool clear=false)

void	setValueAsString (const std::string &v)

virtual void	virtualSetValueAsString (const std::string &v)

virtual bool	read (const std::string &s)

virtual const std::string &	getRelativePath (unsigned int i)

virtual const std::string &	getFullPath (unsigned int i) const

virtual const std::string &	getAbsolutePath (unsigned int i) const

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

void	setPathType (PathType pathType)

PathType	getPathType ()

Public Member Functions inherited from sofa::core::objectmodel::Data< sofa::helper::SVector< std::string > >
bool	operator== (const sofa::helper::SVector< std::string > &value) const

bool	operator!= (const sofa::helper::SVector< std::string > &value) const

void	operator= (const sofa::helper::SVector< std::string > &value)

sofa::helper::SVector< std::string > *	beginEdit ()
	BeginEdit method if it is only to write the value. More...

sofa::helper::SVector< std::string > *	beginEdit (const core::ExecParams *)

sofa::helper::SVector< std::string > *	beginWriteOnly ()

sofa::helper::SVector< std::string > *	beginWriteOnly (const core::ExecParams *)

void	endEdit ()

void	endEdit (const core::ExecParams *)

void	setValue (const sofa::helper::SVector< std::string > &value)

void	setValue (const core::ExecParams *, const sofa::helper::SVector< std::string > &value)

const sofa::helper::SVector< std::string > &	getValue () const

const sofa::helper::SVector< std::string > &	getValue (const core::ExecParams *) const

virtual const sofa::helper::SVector< std::string > &	virtualGetValue () const

virtual void	virtualSetValue (const sofa::helper::SVector< std::string > &v)

virtual void	virtualSetLink (const BaseData &bd)

virtual sofa::helper::SVector< std::string > *	virtualBeginEdit ()

virtual BaseData *	getNewInstance ()

	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 sofa::helper::SVector< std::string > &value, const char *helpMsg=nullptr, bool isDisplayed=true, bool isReadOnly=false)

	Data (const sofa::helper::SVector< std::string > &value, const std::string &helpMsg, bool isDisplayed=true, bool isReadOnly=false)

virtual	~Data ()
	Destructor. More...

Public Member Functions inherited from sofa::core::objectmodel::TData< sofa::helper::SVector< std::string > >
	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::AbstractTypeInfo *	getValueTypeInfo () 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...

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

bool	copyValue (const TData< sofa::helper::SVector< std::string > > *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...

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

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

BaseData *	getParent ()

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

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

Protected Member Functions
void	updatePath ()

Protected Member Functions inherited from sofa::core::objectmodel::TData< sofa::helper::SVector< std::string > >
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
	Delegates from DDGNode. 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 ()

Additional Inherited Members
Static Public Member Functions inherited from sofa::core::objectmodel::Data< sofa::helper::SVector< std::string > >
static std::string	templateName ()

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

Attribute details

sofa::helper::vector<std::string> sofa::core::objectmodel::DataFileNameVector::m_fullpath

protected

PathType sofa::core::objectmodel::DataFileNameVector::m_pathType

protected

Constructor details

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

inline

sofa::core::objectmodel::DataFileNameVector::DataFileNameVector	(	const sofa::helper::vector< std::string > &	value,
		const char *	helpMsg = `nullptr`,
		bool	isDisplayed = `true`,
		bool	isReadOnly = `false`
	)

inline

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

inlineexplicit

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

sofa::core::objectmodel::DataFileNameVector::DataFileNameVector ( const Inherit::InitData & init )

inlineexplicit

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

sofa::core::objectmodel::DataFileNameVector::~DataFileNameVector ( )

virtual

Function details

void sofa::core::objectmodel::DataFileNameVector::addPath	(	const std::string &	v,
		bool	clear = `false`
	)

inline

void sofa::core::objectmodel::DataFileNameVector::endEdit ( )

inline

void sofa::core::objectmodel::DataFileNameVector::endEdit ( const core::ExecParams * )

inline

virtual const std::string& sofa::core::objectmodel::DataFileNameVector::getAbsolutePath ( unsigned int i ) const

inlinevirtual

virtual const std::string& sofa::core::objectmodel::DataFileNameVector::getFullPath ( unsigned int i ) const

inlinevirtual

PathType sofa::core::objectmodel::DataFileNameVector::getPathType ( )

inline

virtual const std::string& sofa::core::objectmodel::DataFileNameVector::getRelativePath ( unsigned int i )

inlinevirtual

virtual bool sofa::core::objectmodel::DataFileNameVector::read ( const std::string & s )

inlinevirtual

Try to read argument value from an input stream. Return false if failed

Reimplemented from sofa::core::objectmodel::TData< sofa::helper::SVector< std::string > >.

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

inline

void sofa::core::objectmodel::DataFileNameVector::setValue ( const sofa::helper::vector< std::string > & v )

inline

void sofa::core::objectmodel::DataFileNameVector::setValueAsString ( const std::string & v )

inline

virtual void sofa::core::objectmodel::DataFileNameVector::update ( )

inlinevirtual

Update the value of this Data.

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

void sofa::core::objectmodel::DataFileNameVector::updatePath ( )

protected

virtual void sofa::core::objectmodel::DataFileNameVector::virtualEndEdit ( )

inlinevirtual

Reimplemented from sofa::core::objectmodel::Data< sofa::helper::SVector< std::string > >.

virtual void sofa::core::objectmodel::DataFileNameVector::virtualSetValueAsString ( const std::string & v )

inlinevirtual

Protected Attributes

Public Member Functions

Protected Member Functions

Additional Inherited Members

Attribute details

Constructor details

Function details