Back to index

salome-kernel  6.5.0
Public Member Functions
SALOMEDSClient_IParameters Class Reference

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

#include <SALOMEDSClient_IParameters.hxx>

Inheritance diagram for SALOMEDSClient_IParameters:
Inheritance graph
[legend]

List of all members.

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.
virtual int nbValues (const std::string &listName)=0
 Returns a number elements in the list.
virtual std::vector< std::string > getValues (const std::string &listName)=0
 Returns a list of values in the list.
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].
virtual std::vector< std::string > getLists ()=0
 Returns a list all entries lists.
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.
virtual std::string getParameter (const std::string &entry, const std::string &parameterName)=0
 Gets a named parameter value for the given entry.
virtual void setIdParameter (const std::string &entry, const std::string &value)=0
 Sets an id parameter value for the given entry.
virtual std::string getIdParameter (const std::string &entry)=0
 Gets an id parameter value for the given entry.
virtual std::vector< std::string > getAllParameterNames (const std::string &entry)=0
 Returns all parameter names of the given entry.
virtual std::vector< std::string > getAllParameterValues (const std::string &entry)=0
 Returns all parameter values of the given entry.
virtual int getNbParameters (const std::string &entry)=0
 Returns a number of parameters of the given entry.
virtual std::vector< std::string > getEntries ()=0
 Returns a list all entries.
virtual void setProperty (const std::string &name, const std::string &value)=0
 Sets a global named property value.
virtual std::string getProperty (const std::string &name)=0
 Gets a value of global named property.
virtual std::vector< std::string > getProperties ()=0
 Returns a list all properties.
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.
virtual std::string encodeEntry (const std::string &entry, const std::string &compName)=0
 Returns encoded entry that is a relative entry for the component.
virtual std::string decodeEntry (const std::string &entry)=0
 Returns decoded entry that is an absolute entry.
virtual void setDumpPython (_PTR(Study) study, const std::string &theID="")=0
 Enables/Disables the dumping visual parameters, static implementation is supposed.
virtual bool isDumpPython (_PTR(Study) study, const std::string &theID="")=0
 Returns whether there is the dumping visual parameters, static implementation is supposed.
virtual std::string getDefaultVisualComponent ()=0
 Returns a default name of the component where the visula parameters are stored.

Detailed Description

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

Definition at line 36 of file SALOMEDSClient_IParameters.hxx.


Constructor & Destructor Documentation

Definition at line 40 of file SALOMEDSClient_IParameters.hxx.

{}

Member Function Documentation

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.

virtual std::string SALOMEDSClient_IParameters::decodeEntry ( const std::string &  entry) [pure virtual]

Returns decoded entry that is an absolute entry.

Implemented in SALOMEDS_IParameters.

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.

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.

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.

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.

virtual std::vector<std::string> SALOMEDSClient_IParameters::getEntries ( ) [pure virtual]

Returns a list all entries.

Implemented in SALOMEDS_IParameters.

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.

virtual std::vector<std::string> SALOMEDSClient_IParameters::getLists ( ) [pure virtual]

Returns a list all entries lists.

Implemented in SALOMEDS_IParameters.

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

Returns a number of parameters of the given entry.

Implemented in SALOMEDS_IParameters.

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.

virtual std::vector<std::string> SALOMEDSClient_IParameters::getProperties ( ) [pure virtual]

Returns a list all properties.

Implemented in SALOMEDS_IParameters.

virtual std::string SALOMEDSClient_IParameters::getProperty ( const std::string &  name) [pure virtual]

Gets a value of global named property.

Implemented in SALOMEDS_IParameters.

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.

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.

virtual bool SALOMEDSClient_IParameters::isDumpPython ( _PTR(Study)  study,
const std::string &  theID = "" 
) [pure virtual]

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

Implemented in SALOMEDS_IParameters.

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

Returns a number elements in the list.

Implemented in SALOMEDS_IParameters.

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.

virtual void SALOMEDSClient_IParameters::setDumpPython ( _PTR(Study)  study,
const std::string &  theID = "" 
) [pure virtual]

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

Implemented in SALOMEDS_IParameters.

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.

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.

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.


The documentation for this class was generated from the following file: