AuxStateChangeStrategy Property

General info

Label

Strategy

Description

Specifies how auxiliary state changes are handled.

Data type

UInt32

Default value

1 (syslib.model.codes.AuxStateChangeStrategy.INHERIT)

Type

CodingGroup

Code

1571

Symbolic name

MODEL_PROP_AUXSTATECHANGESTRATEGY

Lua access code

syslib.model.properties.AuxStateChangeStrategy

Available since

1.6

Parent properties

AuxStateManagement

Attributes

Name Tooltip
PROP_CONFIGURABLE The property is configurable and can be changed with DataStudio and the various inmation APIs.
PROP_VISIBLE The property is visible in DataStudio and can be read by the inmation APIs.
PROP_HAS_DEFAULT The property has a default value as standard.

Codings

Coding group: AuxStateChangeStrategy

Name Code Label Tooltip

INHERIT

1

Inherit

Inherit the setting from the parent object. In case of no parent object, the "Persist" mode is used.

PERSIST

2

Persist

All object auxiliary states are indicated and persisted to the archive.

VOLATILE

3

Volatile

Auxiliary state changes are volatile and not persisted.

INHIBIT

4

Inhibit

Inhibit all auxiliary state changes.

Examples

Read from or write to the AuxStateChangeStrategy property.

  • Lua

  • C#

-- Read from the AuxStateChangeStrategy
syslib.getvalue("<OBJECT FULL PATH>.TPMOEEPresetOptions.TPMOEEIndexPreset.AuxStateManagement.AuxStateChangeStrategy")

-- Write to the AuxStateChangeStrategy
syslib.setvalue("<OBJECT FULL PATH>.TPMOEEPresetOptions.TPMOEEIndexPreset.AuxStateManagement.AuxStateChangeStrategy",
    syslib.model.codes.AuxStateChangeStrategy.INHERIT)
TcpConfig tcpcfg = new TcpConfig() { HostNameOrIp = "localhost", Port = 6512 };
SecurityCredentials sc = new SecurityCredentials() { ProfileName = "<username>", Password = "<password>" };
StatelessInterface sli = new StatelessInterface(tcpcfg);

// Read from the AuxStateChangeStrategy
Result result = sli.ReadValue(sc, new ReadItem("<OBJECT FULL PATH>.TPMOEEPresetOptions.TPMOEEIndexPreset.AuxStateManagement.AuxStateChangeStrategy"));
// Write to the AuxStateChangeStrategy
Result result = sli.WriteValue(sc, new WriteItem(AuxStateChangeStrategy.INHERIT, "<OBJECT FULL PATH>.TPMOEEPresetOptions.TPMOEEIndexPreset.AuxStateManagement.AuxStateChangeStrategy"));

A switch-like function of the codings.

function get_coding_name(code)
    local _ascs = syslib.model.codes.AuxStateChangeStrategy
    if _ascs.INHERIT==code then return 'INHERIT'
    elseif _ascs.PERSIST==code then return 'PERSIST'
    elseif _ascs.VOLATILE==code then return 'VOLATILE'
    elseif _ascs.INHIBIT==code then return 'INHIBIT'
    end
end
return get_coding_name(syslib.model.codes.AuxStateChangeStrategy.INHERIT)