Skip to content

ChildStatusParam

Bases: ParentStatusParam

ChildStatusParam class represents a dependent status parameter.

This class defines a status parameter that derives its value from a parent status parameter by applying a specified mathematical operation (offset or multiplication).

__init__(*args)

Overload 1:

Copy constructor.

Parameters:

Name Type Description Default
other ChildStatusParam

The ChildStatusParam to copy | Overload 2: Constructor with parent, operation, and operand.

required
subDeviceId SubDeviceId

The sub-device ID of the associated sub-device

required
parent ParentStatusParam

The parent status parameter

required
operation int

The operation to apply (OFFSET or MULTIPLICATION)

required
operand float

The value to apply in the operation | Overload 3: Constructor with parent, operation, operand, and tag.

required
tag int

A tag to associate with this parameter

required

getParent()

Get parent parameter.

Retrieves the parent status parameter.

Returns:

Type Description
ParentStatusParam

The parent parameter

setParent(parent)

Set parent parameter.

Sets the parent status parameter.

Parameters:

Name Type Description Default
parent ParentStatusParam

The parent parameter

required

getOperation()

Get operation.

Retrieves the operation applied by this parameter.

Returns:

Type Description
int

The operation

setOperation(operation)

Set operation.

Sets the operation to be applied by this parameter.

Parameters:

Name Type Description Default
operation int

The operation

required

getOperand()

Get operand.

Retrieves the operand value used in the operation.

Returns:

Type Description
float

The operand value

setOperand(operand)

Set operand.

Sets the operand value used in the operation.

Parameters:

Name Type Description Default
operand float

The operand value

required

getTag()

Get tag.

Retrieves the tag associated with this parameter.

Returns:

Type Description
int

The tag value

setTag(tag)

Set tag.

Sets the tag associated with this parameter.

Parameters:

Name Type Description Default
tag int

The tag value

required

clone()

Clone object.

Creates a deep copy of this instance.

Returns:

Type Description
StatusParam

The copy

equals(other)

Check equality.

Compares this instance with another for equality.

Parameters:

Name Type Description Default
other StatusParam

The status parameter to compare with

required

Returns:

Type Description
boolean

True if equal, false otherwise