SnapshotRefreshPeriod Property

General info

Label

Snapshot Refresh Period

Description

The time after snapshots will be updated

Data type

UInt16

Default value

10

Min value

1

Max value

3600

Type

Regular

Code

6748

Symbolic name

MODEL_PROP_SNAPSHOTREFRESHPERIOD

Lua access code

inmation.model.properties.SnapshotRefreshPeriod

Parent properties

SnapshotOptions

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
PROP_UNIT The property has an engineering unit
PROP_HAS_LOLIMIT The property has a low limit
PROP_HAS_HILIMIT The property has a high limit

Examples

Read from or write to the SnapshotRefreshPeriod property.

  • Lua

  • C#

-- Read from the SnapshotRefreshPeriod
inmation.getvalue("<OBJECT FULL PATH>.SnapshotOptions.SnapshotRefreshPeriod")

-- Write to the SnapshotRefreshPeriod
inmation.setvalue("<OBJECT FULL PATH>.SnapshotOptions.SnapshotRefreshPeriod", 10)
TcpConfig tcpcfg = new TcpConfig() { HostNameOrIp = "localhost", Port = 6512 };
SecurityCredentials sc = new SecurityCredentials() { ProfileName = "so", Password = "inmation" };
StatelessInterface sli = new StatelessInterface(tcpcfg);

// Read from the SnapshotRefreshPeriod
Result result = sli.ReadValue(sc, new ReadItem("<OBJECT FULL PATH>.SnapshotOptions.SnapshotRefreshPeriod"));
// Write to the SnapshotRefreshPeriod
Result result = sli.WriteValue(sc, new WriteItem(10, "<OBJECT FULL PATH>.SnapshotOptions.SnapshotRefreshPeriod"));