 |
ALPHA-VISION® Functions: aci.Obj_TickOn
|
aci.Obj_TickOn
SUMMARY
Make a data object value "tick": synchronize it's value with the system clock minus an offset.
SYNTAX
aci.Obj_TickOn(
(<object number>|<point id>),
<offset> [,
<interval>])
ARGUMENTS
- object number (type:number)
-
A data object number
- point id (type:string)
-
The name of a data object
- offset (type:integer)
-
The offset (seconds) between the actual time and the data object value.
- interval (type:integer)
-
The time interval (seconds) between value changes (the default is 1 second and this is the correct value for nearly all
use cases).
ERROR HANDLING
The function will fail and terminate script execution if strict error checking is enabled (see
aci.SetStrictMode()) and
one of the following conditions is met:
-
The given data object does not exist.
-
The status cannot be set or ticking cannot be activated.
If this occurs and strict checking is disabled the function returns
nil.
DESCRIPTION
The status of the data object will be set to 1 to indicate ticking is on.
EXAMPLES
aci.Obj_TickOn("TREND_X", 120)
Syntax Notation
- [aaa]
- aaa is optional (zero or one occurences)
- (aaa|bbb)
- aaa exclusive or bbb
- (aaa)*
- aaa may occur indefinitely often or may be omitted
- (aaa)+
- aaa may occur indefinitely often but at least once
- (aaa)m..n
- aaa may occur from m to n times