DpgRangeModifier Object


Description:

Ranged value modifier used to modify a flow variable.

Parents: DpgVariable

Relations:

Side name
(Type)
Relative Description
CarryChainTo
(DpgCarryChainTo)

DpgRandomModifier, DpgRangeModifier, DpgTableModifier

Target modifier if this modifier is carry-chained to another modifier.

DpgRangeModifier Writable Attributes

Attribute Description
Common Writable Attributes Active, Name
Data

Initial value for this modifier's data.

Type: string

Default: 00

Mask

Hexadecimal mask value for this modifier.

Type: string

Default: FF

ModifierMode

Mode for the ranged modifier.

Type: enum

Default: INCR

Possible Values:

Value Description
INCR

Values increment.

DECR

Values decrement.

RecycleCount

Number of unique values this modifier has.

Type: u32

Default: 1

Range: 1 - 4294967295

RepeatCount

Number of times a given value repeats for a modifier.

Type: u32

Default: 0

StepValue

Step value used by this modifier.

Type: string

Default: 01

DpgRangeModifier Read-Only Attributes

Read-Only Attribute Description
DefinedByFlow

Whether the flow file was created from loading a flow file or user-created.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Modifier was created from the flow file.

FALSE

Modifier was created by the user.