Class which an interface to store the parameters of the objects. More...

#include <SALOMEDSClient_IParameters.hxx>

Inheritance diagram for SALOMEDSClient_IParameters:

Public Member Functions
virtual	~SALOMEDSClient_IParameters ()

virtual int	append (const std::string &listName, const std::string &value)=0
	Appends a string value to a named list. More...

virtual int	nbValues (const std::string &listName)=0
	Returns a number elements in the list. More...

virtual std::vector< std::string >	getValues (const std::string &listName)=0
	Returns a list of values in the list. More...

virtual std::string	getValue (const std::string &listName, int index)=0
	Returns a value with given index, where index is in range [0:nbValues-1]. More...

virtual std::vector< std::string >	getLists ()=0
	Returns a list all entries lists. More...

virtual void	setParameter (const std::string &entry, const std::string &parameterName, const std::string &value)=0
	Sets a new named parameter value for the given entry. More...

virtual std::string	getParameter (const std::string &entry, const std::string &parameterName)=0
	Gets a named parameter value for the given entry. More...

virtual void	setIdParameter (const std::string &entry, const std::string &value)=0
	Sets an id parameter value for the given entry. More...

virtual std::string	getIdParameter (const std::string &entry)=0
	Gets an id parameter value for the given entry. More...

virtual std::vector< std::string >	getAllParameterNames (const std::string &entry)=0
	Returns all parameter names of the given entry. More...

virtual std::vector< std::string >	getAllParameterValues (const std::string &entry)=0
	Returns all parameter values of the given entry. More...

virtual int	getNbParameters (const std::string &entry)=0
	Returns a number of parameters of the given entry. More...

virtual std::vector< std::string >	getEntries ()=0
	Returns a list all entries. More...

virtual void	setProperty (const std::string &name, const std::string &value)=0
	Sets a global named property value. More...

virtual std::string	getProperty (const std::string &name)=0
	Gets a value of global named property. More...

virtual std::vector< std::string >	getProperties ()=0
	Returns a list all properties. More...

virtual std::vector< std::string >	parseValue (const std::string &value, const char separator, bool fromEnd=true)=0
	Breaks a value string in two parts which is divided by separator. More...

virtual std::string	encodeEntry (const std::string &entry, const std::string &compName)=0
	Returns encoded entry that is a relative entry for the component. More...

virtual std::string	decodeEntry (const std::string &entry)=0
	Returns decoded entry that is an absolute entry. More...

virtual void	setDumpPython (const std::string &theID="")=0
	Enables/Disables the dumping visual parameters, static implementation is supposed. More...

virtual bool	isDumpPython (const std::string &theID="")=0
	Returns whether there is the dumping visual parameters, static implementation is supposed. More...

virtual std::string	getDefaultVisualComponent ()=0
	Returns a default name of the component where the visula parameters are stored. More...

Detailed Description

Class which an interface to store the parameters of the objects.

Constructor & Destructor Documentation

◆ ~SALOMEDSClient_IParameters()

virtual SALOMEDSClient_IParameters::~SALOMEDSClient_IParameters ( )

virtual

Member Function Documentation

◆ append()

virtual int SALOMEDSClient_IParameters::append	(	const std::string &	listName,
		const std::string &	value
	)

pure virtual

Appends a string value to a named list.

Returns a number of the added value. Note: the name of the list MUST be unique

Implemented in SALOMEDS_IParameters.

Referenced by KERNEL_PY.iparameters.IParameters::append(), KERNEL_PY.iparameters.IParameters::setParameter(), and KERNEL_PY.iparameters.IParameters::setProperty().

◆ decodeEntry()

virtual std::string SALOMEDSClient_IParameters::decodeEntry ( const std::string & entry )

pure virtual

Returns decoded entry that is an absolute entry.

Implemented in SALOMEDS_IParameters.

◆ encodeEntry()

virtual std::string SALOMEDSClient_IParameters::encodeEntry	(	const std::string &	entry,
		const std::string &	compName
	)

pure virtual

Returns encoded entry that is a relative entry for the component.

Implemented in SALOMEDS_IParameters.

◆ getAllParameterNames()

virtual std::vector<std::string> SALOMEDSClient_IParameters::getAllParameterNames ( const std::string & entry )

pure virtual

Returns all parameter names of the given entry.

Implemented in SALOMEDS_IParameters.

◆ getAllParameterValues()

virtual std::vector<std::string> SALOMEDSClient_IParameters::getAllParameterValues ( const std::string & entry )

pure virtual

Returns all parameter values of the given entry.

Implemented in SALOMEDS_IParameters.

◆ getDefaultVisualComponent()

virtual std::string SALOMEDSClient_IParameters::getDefaultVisualComponent ( )

pure virtual

Returns a default name of the component where the visula parameters are stored.

Static implementation is supposed

Implemented in SALOMEDS_IParameters.

◆ getEntries()

virtual std::vector<std::string> SALOMEDSClient_IParameters::getEntries ( )

pure virtual

Returns a list all entries.

Implemented in SALOMEDS_IParameters.

◆ getIdParameter()

virtual std::string SALOMEDSClient_IParameters::getIdParameter ( const std::string & entry )

pure virtual

Gets an id parameter value for the given entry.

Implemented in SALOMEDS_IParameters.

◆ getLists()

virtual std::vector<std::string> SALOMEDSClient_IParameters::getLists ( )

pure virtual

Returns a list all entries lists.

Implemented in SALOMEDS_IParameters.

◆ getNbParameters()

virtual int SALOMEDSClient_IParameters::getNbParameters ( const std::string & entry )

pure virtual

Returns a number of parameters of the given entry.

Implemented in SALOMEDS_IParameters.

◆ getParameter()

virtual std::string SALOMEDSClient_IParameters::getParameter	(	const std::string &	entry,
		const std::string &	parameterName
	)

pure virtual

Gets a named parameter value for the given entry.

Implemented in SALOMEDS_IParameters.

◆ getProperties()

virtual std::vector<std::string> SALOMEDSClient_IParameters::getProperties ( )

pure virtual

Returns a list all properties.

Implemented in SALOMEDS_IParameters.

◆ getProperty()

virtual std::string SALOMEDSClient_IParameters::getProperty ( const std::string & name )

pure virtual

Gets a value of global named property.

Implemented in SALOMEDS_IParameters.

◆ getValue()

virtual std::string SALOMEDSClient_IParameters::getValue	(	const std::string &	listName,
		int	index
	)

pure virtual

Returns a value with given index, where index is in range [0:nbValues-1].

Implemented in SALOMEDS_IParameters.

◆ getValues()

virtual std::vector<std::string> SALOMEDSClient_IParameters::getValues ( const std::string & listName )

pure virtual

Returns a list of values in the list.

Implemented in SALOMEDS_IParameters.

◆ isDumpPython()

virtual bool SALOMEDSClient_IParameters::isDumpPython ( const std::string & theID = "" )

pure virtual

Returns whether there is the dumping visual parameters, static implementation is supposed.

Implemented in SALOMEDS_IParameters.

◆ nbValues()

virtual int SALOMEDSClient_IParameters::nbValues ( const std::string & listName )

pure virtual

Returns a number elements in the list.

Implemented in SALOMEDS_IParameters.

◆ parseValue()

virtual std::vector<std::string> SALOMEDSClient_IParameters::parseValue	(	const std::string &	value,
		const char	separator,
		bool	fromEnd = `true`
	)

pure virtual

Breaks a value string in two parts which is divided by separator.

If fromEnd is True the search of separator starts from the end of the string

Implemented in SALOMEDS_IParameters.

◆ setDumpPython()

virtual void SALOMEDSClient_IParameters::setDumpPython ( const std::string & theID = "" )

pure virtual

Enables/Disables the dumping visual parameters, static implementation is supposed.

Implemented in SALOMEDS_IParameters.

◆ setIdParameter()

virtual void SALOMEDSClient_IParameters::setIdParameter	(	const std::string &	entry,
		const std::string &	value
	)

pure virtual

Sets an id parameter value for the given entry.

Implemented in SALOMEDS_IParameters.

◆ setParameter()

virtual void SALOMEDSClient_IParameters::setParameter	(	const std::string &	entry,
		const std::string &	parameterName,
		const std::string &	value
	)

pure virtual

Sets a new named parameter value for the given entry.

Implemented in SALOMEDS_IParameters.

◆ setProperty()

virtual void SALOMEDSClient_IParameters::setProperty	(	const std::string &	name,
		const std::string &	value
	)

pure virtual

Sets a global named property value.

Implemented in SALOMEDS_IParameters.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~SALOMEDSClient_IParameters()

Member Function Documentation

◆ append()

◆ decodeEntry()

◆ encodeEntry()

◆ getAllParameterNames()

◆ getAllParameterValues()

◆ getDefaultVisualComponent()

◆ getEntries()

◆ getIdParameter()

◆ getLists()

◆ getNbParameters()

◆ getParameter()

◆ getProperties()

◆ getProperty()

◆ getValue()

◆ getValues()

◆ isDumpPython()

◆ nbValues()

◆ parseValue()

◆ setDumpPython()

◆ setIdParameter()

◆ setParameter()

◆ setProperty()