Inscoper::ModifiableStatusParam¶

ModifiableStatusParam class represents a status parameter that can be modified during a sequence execution. More...

#include <ModifiableStatusParam.h>

Inherits from Inscoper::ParentStatusParam, Inscoper::StatusParam

Public Functions¶

	Name
	ModifiableStatusParam(const ModifiableStatusParam & other) Copy constructor.
	ModifiableStatusParam(ModifiableStatusParam && other) Move constructor.
ModifiableStatusParam &	operator=(const ModifiableStatusParam & other) Copy assignment operator.
ModifiableStatusParam &	operator=(ModifiableStatusParam && other) Move assignment operator.
	ModifiableStatusParam(const Inscoper::SubDeviceId & subDeviceId, unsigned int modifIndex) Constructor without value.
	ModifiableStatusParam(const Inscoper::SubDeviceId & subDeviceId, unsigned int modifIndex, const std::string & value) Constructor from string value.
	ModifiableStatusParam(const Inscoper::SubDeviceId & subDeviceId, unsigned int modifIndex, unsigned char value) Constructor from unsigned char value.
	ModifiableStatusParam(const Inscoper::SubDeviceId & subDeviceId, unsigned int modifIndex, char value) Constructor from char value.
	ModifiableStatusParam(const Inscoper::SubDeviceId & subDeviceId, unsigned int modifIndex, unsigned short value) Constructor from unsigned short value.
	ModifiableStatusParam(const Inscoper::SubDeviceId & subDeviceId, unsigned int modifIndex, short value) Constructor from short value.
	ModifiableStatusParam(const Inscoper::SubDeviceId & subDeviceId, unsigned int modifIndex, unsigned int value) Constructor from unsigned int value.
	ModifiableStatusParam(const Inscoper::SubDeviceId & subDeviceId, unsigned int modifIndex, int value) Constructor from int value.
	ModifiableStatusParam(const Inscoper::SubDeviceId & subDeviceId, unsigned int modifIndex, unsigned long long int value) Constructor from unsigned long long value.
	ModifiableStatusParam(const Inscoper::SubDeviceId & subDeviceId, unsigned int modifIndex, long long int value) Constructor from long long value.
	ModifiableStatusParam(const Inscoper::SubDeviceId & subDeviceId, unsigned int modifIndex, float value) Constructor from float value.
	ModifiableStatusParam(const Inscoper::SubDeviceId & subDeviceId, unsigned int modifIndex, double value) Constructor from double value.
	ModifiableStatusParam(const Inscoper::SubDeviceId & subDeviceId, unsigned int modifIndex, bool value) Constructor from boolean value.
	ModifiableStatusParam(const Inscoper::SubDeviceId & subDeviceId, unsigned int modifIndex, const char * value) Constructor from C-string value.
virtual std::shared_ptr< StatusParam >	clone() override Clone object.
virtual bool	equals(const std::shared_ptr< StatusParam > & other) override Check equality.

Additional inherited members¶

Public Functions inherited from Inscoper::ParentStatusParam

	Name
virtual unsigned int	getModifierIndex() Get modifiable parameter identifier.

Protected Functions inherited from Inscoper::ParentStatusParam

	Name
	ParentStatusParam(const ParentStatusParam & other) Copy constructor.
	ParentStatusParam(ParentStatusParam && other) Move constructor.
	ParentStatusParam(const Inscoper::SubDeviceId & subDeviceId) Constructor with sub-device ID.

Public Functions inherited from Inscoper::StatusParam

	Name
	StatusParam(const StatusParam & other) Copy constructor.
	StatusParam(StatusParam && other) Move constructor.
	StatusParam(const Inscoper::SubDeviceId & subDeviceId) Constructor from sub-device ID.
	StatusParam(const Inscoper::SubDeviceId & subDeviceId, const std::string & value) Constructor from sub-device ID and string value.
	StatusParam(const Inscoper::SubDeviceId & subDeviceId, unsigned char value) Constructor from sub-device ID and unsigned char value.
	StatusParam(const Inscoper::SubDeviceId & subDeviceId, char value) Constructor from sub-device ID and char value.
	StatusParam(const Inscoper::SubDeviceId & subDeviceId, unsigned short value) Constructor from sub-device ID and unsigned short value.
	StatusParam(const Inscoper::SubDeviceId & subDeviceId, short value) Constructor from sub-device ID and short value.
	StatusParam(const Inscoper::SubDeviceId & subDeviceId, unsigned int value) Constructor from sub-device ID and unsigned int value.
	StatusParam(const Inscoper::SubDeviceId & subDeviceId, int value) Constructor from sub-device ID and int value.
	StatusParam(const Inscoper::SubDeviceId & subDeviceId, unsigned long long int value) Constructor from sub-device ID and unsigned long long value.
	StatusParam(const Inscoper::SubDeviceId & subDeviceId, long long int value) Constructor from sub-device ID and long long value.
	StatusParam(const Inscoper::SubDeviceId & subDeviceId, float value) Constructor from sub-device ID and float value.
	StatusParam(const Inscoper::SubDeviceId & subDeviceId, double value) Constructor from sub-device ID and double value.
	StatusParam(const Inscoper::SubDeviceId & subDeviceId, bool value) Constructor from sub-device ID and boolean value.
	StatusParam(const Inscoper::SubDeviceId & subDeviceId, const char * value) Constructor from sub-device ID and C-string value.
	~StatusParam() Destructor.
const Inscoper::SubDeviceId	getSubDeviceId() const Get sub-device ID.
void	setSubDeviceId(const Inscoper::SubDeviceId & subDeviceId) Set sub-device ID.
bool	hasValue() Check if the status parameter has a value.
std::string	getStringValue() Get value as string.
unsigned char	getUnsignedCharValue() Get value as unsigned char.
char	getCharValue() Get value as char.
unsigned short	getUnsignedShortValue() Get value as unsigned short.
short	getShortValue() Get value as short.
unsigned int	getUnsignedIntValue() Get value as unsigned int.
int	getIntValue() Get value as int.
unsigned long long int	getUnsignedLongValue() Get value as unsigned long long.
long long int	getLongValue() Get value as long long.
float	getFloatValue() Get value as float.
double	getDoubleValue() Get value as double.
void	setValue(const std::string & value) Set value from string.
void	setValue(unsigned char value) Set value from unsigned char.
void	setValue(char value) Set value from char.
void	setValue(unsigned short value) Set value from unsigned short.
void	setValue(short value) Set value from short.
void	setValue(unsigned int value) Set value from unsigned int.
void	setValue(int value) Set value from int.
void	setValue(unsigned long long int value) Set value from unsigned long long.
void	setValue(long long int value) Set value from long long.
void	setValue(float value) Set value from float.
void	setValue(double value) Set value from double.
void	setValue(bool value) Set value from bool.
void	setValue(const char * value) Set value from C-string.
void	addValue(unsigned short tag, const std::string & value) Add a string value for a specific parameter index.
void	addValue(unsigned short tag, unsigned char value) Add a tagged unsigned char value for a specific parameter index.
void	addValue(unsigned short tag, char value) Add a tagged char value for a specific parameter index.
void	addValue(unsigned short tag, unsigned short value) Add a tagged unsigned short value for a specific parameter index.
void	addValue(unsigned short tag, short value) Add a tagged short value for a specific parameter index.
void	addValue(unsigned short tag, unsigned int value) Add a tagged unsigned int value for a specific parameter index.
void	addValue(unsigned short tag, int value) Add a tagged int value for a specific parameter index.
void	addValue(unsigned short tag, unsigned long long int value) Add a tagged unsigned long long value for a specific parameter index.
void	addValue(unsigned short tag, long long int value) Add a tagged long long value for a specific parameter index.
void	addValue(unsigned short tag, float value) Add a tagged float value for a specific parameter index.
void	addValue(unsigned short tag, double value) Add a tagged double value for a specific parameter index.
void	addValue(unsigned short tag, bool value) Add a tagged boolean value for a specific parameter index.
void	addValue(unsigned short tag, const char * value) Add a tagged C-string value for a specific parameter index.
void	addValue(unsigned short index, unsigned short tag, const std::string & value) Add a string value associated with a specific parameter index and value index.
void	addValue(unsigned short index, unsigned short tag, unsigned char value) Add an unsigned char value associated with a specific parameter index and value index.
void	addValue(unsigned short index, unsigned short tag, char value) Add a char value associated with a specific parameter index and value index.
void	addValue(unsigned short index, unsigned short tag, unsigned short value) Add an unsigned short value associated with a specific parameter index and value index.
void	addValue(unsigned short index, unsigned short tag, short value) Add a short value associated with a specific parameter index and value index.
void	addValue(unsigned short index, unsigned short tag, unsigned int value) Add an unsigned int value associated with a specific parameter index and value index.
void	addValue(unsigned short index, unsigned short tag, int value) Add an int value associated with a specific parameter index and value index.
void	addValue(unsigned short index, unsigned short tag, unsigned long long int value) Add an unsigned long long value associated with a specific parameter index and value index.
void	addValue(unsigned short index, unsigned short tag, long long int value) Add a long long value associated with a specific parameter index and value index.
void	addValue(unsigned short index, unsigned short tag, float value) Add a float value associated with a specific parameter index and value index.
void	addValue(unsigned short index, unsigned short tag, double value) Add a double value associated with a specific parameter index and value index.
void	addValue(unsigned short index, unsigned short tag, bool value) Add a bool value associated with a specific parameter index and value index.
void	addValue(unsigned short index, unsigned short tag, const char * value) Add a C-string value associated with a specific parameter index and value index.
virtual std::string	getType() Get type as string (deprecated).
virtual std::string	print() Get string representation.
Inscoper::EParamType	getValueType() Get value type.
virtual std::shared_ptr< Core::InternalStatusParam >	getInternal() Get internal object.

Protected Attributes inherited from Inscoper::StatusParam

	Name
std::shared_ptr< Core::InternalStatusParam >	_internal

Detailed Description¶

class Inscoper::ModifiableStatusParam;

ModifiableStatusParam class represents a status parameter that can be modified during a sequence execution.

This class serves as a status parameter where the value is associated with a specific index, allowing for indexed modifications during a sequence execution.

Public Functions Documentation¶

function ModifiableStatusParam¶

ModifiableStatusParam(
    const ModifiableStatusParam & other
)

Copy constructor.

Parameters:

other : The ModifiableStatusParam to copy

function ModifiableStatusParam¶

ModifiableStatusParam(
    ModifiableStatusParam && other
)

Move constructor.

Parameters:

other : The ModifiableStatusParam to move

function operator=¶

ModifiableStatusParam & operator=(
    const ModifiableStatusParam & other
)

Copy assignment operator.

Parameters:

other : The ModifiableStatusParam to copy

Return: A reference to this object

function operator=¶

ModifiableStatusParam & operator=(
    ModifiableStatusParam && other
)

Move assignment operator.

Parameters:

other : The ModifiableStatusParam to move

Return: A reference to this object

function ModifiableStatusParam¶

ModifiableStatusParam(
    const Inscoper::SubDeviceId & subDeviceId,
    unsigned int modifIndex
)

Constructor without value.

Parameters:

subDeviceId : The sub-device ID of the associated sub-device
modifIndex : The modifiable parameter identifier

function ModifiableStatusParam¶

ModifiableStatusParam(
    const Inscoper::SubDeviceId & subDeviceId,
    unsigned int modifIndex,
    const std::string & value
)

Constructor from string value.

Parameters:

subDeviceId : The sub-device ID of the associated sub-device
modifIndex : The modifiable parameter identifier
value : The string value

function ModifiableStatusParam¶

ModifiableStatusParam(
    const Inscoper::SubDeviceId & subDeviceId,
    unsigned int modifIndex,
    unsigned char value
)

Constructor from unsigned char value.

Parameters:

subDeviceId : The sub-device ID of the associated sub-device
modifIndex : The modifiable parameter identifier
value : The unsigned char value

function ModifiableStatusParam¶

ModifiableStatusParam(
    const Inscoper::SubDeviceId & subDeviceId,
    unsigned int modifIndex,
    char value
)

Constructor from char value.

Parameters:

subDeviceId : The sub-device ID of the associated sub-device
modifIndex : The modifiable parameter identifier
value : The char value

function ModifiableStatusParam¶

ModifiableStatusParam(
    const Inscoper::SubDeviceId & subDeviceId,
    unsigned int modifIndex,
    unsigned short value
)

Constructor from unsigned short value.

Parameters:

subDeviceId : The sub-device ID of the associated sub-device
modifIndex : The modifiable parameter identifier
value : The unsigned short value

function ModifiableStatusParam¶

ModifiableStatusParam(
    const Inscoper::SubDeviceId & subDeviceId,
    unsigned int modifIndex,
    short value
)

Constructor from short value.

Parameters:

subDeviceId : The sub-device ID of the associated sub-device
modifIndex : The modifiable parameter identifier
value : The short value

function ModifiableStatusParam¶

ModifiableStatusParam(
    const Inscoper::SubDeviceId & subDeviceId,
    unsigned int modifIndex,
    unsigned int value
)

Constructor from unsigned int value.

Parameters:

subDeviceId : The sub-device ID of the associated sub-device
modifIndex : The modifiable parameter identifier
value : The unsigned int value

function ModifiableStatusParam¶

ModifiableStatusParam(
    const Inscoper::SubDeviceId & subDeviceId,
    unsigned int modifIndex,
    int value
)

Constructor from int value.

Parameters:

subDeviceId : The sub-device ID of the associated sub-device
modifIndex : The modifiable parameter identifier
value : The int value

function ModifiableStatusParam¶

ModifiableStatusParam(
    const Inscoper::SubDeviceId & subDeviceId,
    unsigned int modifIndex,
    unsigned long long int value
)

Constructor from unsigned long long value.

Parameters:

subDeviceId : The sub-device ID of the associated sub-device
modifIndex : The modifiable parameter identifier
value : The unsigned long long value

function ModifiableStatusParam¶

ModifiableStatusParam(
    const Inscoper::SubDeviceId & subDeviceId,
    unsigned int modifIndex,
    long long int value
)

Constructor from long long value.

Parameters:

subDeviceId : The sub-device ID of the associated sub-device
modifIndex : The modifiable parameter identifier
value : The long long value

function ModifiableStatusParam¶

ModifiableStatusParam(
    const Inscoper::SubDeviceId & subDeviceId,
    unsigned int modifIndex,
    float value
)

Constructor from float value.

Parameters:

subDeviceId : The sub-device ID of the associated sub-device
modifIndex : The modifiable parameter identifier
value : The float value

function ModifiableStatusParam¶

ModifiableStatusParam(
    const Inscoper::SubDeviceId & subDeviceId,
    unsigned int modifIndex,
    double value
)

Constructor from double value.

Parameters:

subDeviceId : The sub-device ID of the associated sub-device
modifIndex : The modifiable parameter identifier
value : The double value

function ModifiableStatusParam¶

ModifiableStatusParam(
    const Inscoper::SubDeviceId & subDeviceId,
    unsigned int modifIndex,
    bool value
)

Constructor from boolean value.

Parameters:

subDeviceId : The sub-device ID of the associated sub-device
modifIndex : The modifiable parameter identifier
value : The boolean value

function ModifiableStatusParam¶

ModifiableStatusParam(
    const Inscoper::SubDeviceId & subDeviceId,
    unsigned int modifIndex,
    const char * value
)

Constructor from C-string value.

Parameters:

subDeviceId : The sub-device ID of the associated sub-device
modifIndex : The modifiable parameter identifier
value : The C-string value

function clone¶

virtual std::shared_ptr< StatusParam > clone() override

Clone object.

Return: The copy

Reimplements: Inscoper::StatusParam::clone

Creates a deep copy.

function equals¶

virtual bool equals(
    const std::shared_ptr< StatusParam > & other
) override

Check equality.

Parameters:

other : The status param to compare with

Return: True if equal, false otherwise

Reimplements: Inscoper::StatusParam::equals

Compares this instance with another for equality. Test if the modifiable parameter identifiers are equal.

Updated on 2026-04-02 at 10:55:36 +0200