Struct IParameters#

Inheritance Relationships#

Derived Type#

Struct Documentation#

struct IParameters#

Interface to access parameters.

Subclassed by sdv::CSdvParamMap

Public Functions

virtual sdv::sequence<sdv::u8string> GetParamPaths() const = 0#

Return a sequence with parameter paths. Each path is unique and can be used to get and set the parameter value.

Returns:

Sequence containing parameter paths. Parameter paths are composed from group/sub-groups and the parameter name, separated by a dot.

virtual sdv::any_t GetParam(const sdv::u8string &ssPath) const = 0#

Returns the parameter value.

Parameters:

ssPath – [in] Path of the parameter. The parameter path is composed from group/sub-groups and the parameter name, separated by a dot.

Returns:

Returns the parameter value. Returns an ‘empty’ parameter value when not successful or the parameter is not set.

virtual bool SetParam(const sdv::u8string &ssPath, sdv::any_t anyValue) = 0#

Set the parameter value.

Parameters:

  • ssPath – [in] Path of the parameter. The parameter path is composed from group/sub-groups and the parameter name, separated by a dot.

  • anyValue – [in] Reference to the parameter value to set.

Returns:

Returns ‘true’ on success or ‘false’ when parameter could not be set (e.g. the parameter is read-only) or the index is larger than the amount of parameters being available.

virtual SParamInfo GetParamInfo(const sdv::u8string &ssPath) const = 0#

Get parameter information.

Parameters:

ssPath – [in] Path of the parameter. The parameter path is composed from group/sub-groups and the parameter name, separated by a dot.

Returns:

Return the parameter information for the requested parameter or an empty structure when no parameter information is available or the parameter is not available.

virtual bool IsParamDirty(const sdv::u8string &ssPath) const = 0#

Is the parameter dirty (was it changed)? Checks the parameter dirty flag.

Parameters:

ssPath – [in] Path of the parameter. The parameter path is composed from group/sub-groups and the parameter name, separated by a dot.

Returns:

Returns whether the parameter was changed either by an explicit call to the SetParam function or internally by the object itself.

virtual void ResetParamDirtyFlag(const sdv::u8string &ssPath) = 0#

Reset the dirty flag for the parameter.

Parameters:

ssPath – [in] Path of the parameter. The parameter path is composed from group/sub-groups and the parameter name, separated by a dot.

virtual bool IsParamMapDirty() const = 0#

Is there at least one parameter with a dirty flag?

Returns:

Returns whether at least one parameter has its dirty flag enabled.

virtual void ResetParamMapDirtyFlags() = 0#

Reset the dirty flag for all parameters.

sequence<u8string> GetParamPaths() const

Return a sequence with parameter paths. Each path is unique and can be used to get and set the parameter value.

Returns:

Sequence containing parameter paths. Parameter paths are composed from group/sub-groups and the parameter name, separated by a dot.

any GetParam (in u8string ssPath) const

Returns the parameter value.

Parameters:

ssPath – [in] Path of the parameter. The parameter path is composed from group/sub-groups and the parameter name, separated by a dot.

Returns:

Returns the parameter value. Returns an ‘empty’ parameter value when not successful or the parameter is not set.

boolean SetParam (in u8string ssPath, in any anyValue)

Set the parameter value.

Parameters:

  • ssPath – [in] Path of the parameter. The parameter path is composed from group/sub-groups and the parameter name, separated by a dot.

  • anyValue – [in] Reference to the parameter value to set.

Returns:

Returns ‘true’ on success or ‘false’ when parameter could not be set (e.g. the parameter is read-only) or the index is larger than the amount of parameters being available.

SParamInfo GetParamInfo (in u8string ssPath) const

Get parameter information.

Parameters:

ssPath – [in] Path of the parameter. The parameter path is composed from group/sub-groups and the parameter name, separated by a dot.

Returns:

Return the parameter information for the requested parameter or an empty structure when no parameter information is available or the parameter is not available.

boolean IsParamDirty (in u8string ssPath) const

Is the parameter dirty (was it changed)? Checks the parameter dirty flag.

Parameters:

ssPath – [in] Path of the parameter. The parameter path is composed from group/sub-groups and the parameter name, separated by a dot.

Returns:

Returns whether the parameter was changed either by an explicit call to the SetParam function or internally by the object itself.

void ResetParamDirtyFlag (in u8string ssPath)

Reset the dirty flag for the parameter.

Parameters:

ssPath – [in] Path of the parameter. The parameter path is composed from group/sub-groups and the parameter name, separated by a dot.

boolean IsParamMapDirty() const

Is there at least one parameter with a dirty flag?

Returns:

Returns whether at least one parameter has its dirty flag enabled.

void ResetParamMapDirtyFlags()

Reset the dirty flag for all parameters.

Public Static Attributes

static constexpr ::sdv::interface_id _id = 0x454F3BF881A931D2#

Interface ID.