RecurWeekDistance Property

General info

Label

Activate all

Description

Recurrence after the specified number of weeks.

Data type

Int32

Default value

1

Min value

1

Max value

1000000

Type

Regular

Code

2706

Symbolic name

MODEL_PROP_RECURWEEKDISTANCE

Lua access code

syslib.model.properties.RecurWeekDistance

Available since

1.34
Parent properties

RecurWeekly

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 RecurWeekDistance property.

  • Lua

  • C#

-- Read from the RecurWeekDistance
syslib.getvalue("<OBJECT FULL PATH>.Schedule.RecurWeekly.RecurWeekDistance")

-- Write to the RecurWeekDistance
syslib.setvalue("<OBJECT FULL PATH>.Schedule.RecurWeekly.RecurWeekDistance", 1)
TcpConfig tcpcfg = new TcpConfig() { HostNameOrIp = "localhost", Port = 6512 };
SecurityCredentials sc = new SecurityCredentials() { ProfileName = "<username>", Password = "<password>" };
StatelessInterface sli = new StatelessInterface(tcpcfg);

// Read from the RecurWeekDistance
Result result = sli.ReadValue(sc, new ReadItem("<OBJECT FULL PATH>.Schedule.RecurWeekly.RecurWeekDistance"));
// Write to the RecurWeekDistance
Result result = sli.WriteValue(sc, new WriteItem(1, "<OBJECT FULL PATH>.Schedule.RecurWeekly.RecurWeekDistance"));