Agent that gradually changes a property setting from one value to another.
Works on a scalar numeric or boolean property of a specified object. Does not work for array, list, map, struct, or string properties.
Contains timer features to allow ramps to start immediately or at any time in the future.
This is a weakly typed class. All ramping parameters are specified as a
OcaFloat64 numbers.
- For unsigned integer targets, the ramping parameters are coerced to OcaUint64 before comparing.
- For signed integer targets, the ramping parameters are coerced to OcaInt64 before comparing.
- For boolean values, the the ramping parameters are coerced to OcaUint8. True is assigned the value One, False is assigned the value Zero.
static
readonly
OcaClassID ClassID
= 1.2.3
Level: 1 Index: 1
This property is an override of the OcaRoot property.
Level: 1 Index: 2
This property is an override of the OcaRoot property.
Level: 3 Index: 1
{Ready, Ramping, Paused, Completed, Disabled} Readonly.
Level: 3 Index: 2
Identification of the property being ramped.
OcaTimeMode
TimeMode
Level: 3 Index: 3
Absolute or Relative time.
OcaTimeNTP
StartTime
Level: 3 Index: 4
Time at which to start ramp.
If TimeMode=Relative, the actual event start time equals the value of StartTime plus the absolute time that StartTime was most recently set.
If TimeMode=Absolute, the actual event start time equals the value of StartTime
OcaTimeInterval
Duration
Level: 3 Index: 5
Duration of ramp period.
Level: 3 Index: 6
Ramper interpolation law
Level: 3 Index: 7
Final value of ramp. Datatype is target property's datatype.
Properties inherited from OcaAgent
Properties inherited from OcaRoot
Level: 3 Index: 1
Executes the given ramper command. The return value indicates whether the command was successfully executed.
OcaRamper::GetState (
)
→ (
OcaRamperState State)
Level: 3 Index: 2
Gets current state of ramper. The return value indicates whether the state was successfully retrieved.
OcaRamper::GetRampedProperty (
)
→ (
OcaProperty property)
Level: 3 Index: 3
Gets definition of ramped property. The return value indicates whether the object number was successfully retrieved.
OcaRamper::SetRampedProperty (
OcaProperty property )
Level: 3 Index: 4
Defines property to be ramped. The return value indicates whether the definition was successful.
OcaRamper::GetTimeMode (
)
→ (
OcaTimeMode
TimeMode)
Level: 3 Index: 5
Gets ramper time mode (absolute or relative). The return value indicates whether the time mode was successfully retrieved.
OcaRamper::SetTimeMode (
OcaTimeMode
TimeMode )
Level: 3 Index: 6
Sets ramper time mode (absolute or relative). The return value indicates whether the time mode was successfully set.
OcaRamper::GetStartTime (
)
→ (
OcaTimeNTP
StartTime)
Level: 3 Index: 7
Gets ramp start time. The return value indicates whether the start time was successfully retrieved.
OcaRamper::SetStartTime (
OcaTimeNTP
TimeMode )
Level: 3 Index: 8
Sets ramper start time. The return value indicates whether the start time was successfully set.
OcaRamper::GetDuration (
)
→ (
OcaTimeInterval
Duration, OcaTimeInterval
miinDuration, OcaTimeInterval
maxDuration)
Level: 3 Index: 9
Gets ramp duration. The return value indicates whether the duration was successfully retrieved.
OcaRamper::SetDuration (
OcaTimeInterval
Duration )
Level: 3 Index: 10
Sets ramp duration. The return value indicates whether the duration was successfully set.
Level: 3 Index: 11
Retrieves interpolation law setting. The return value indicates whether the setting was successfully retrieved.
Level: 3 Index: 12
Sets ramp interpolation law. The return value indicates whether the law was successfully set.
OcaRamper::GetGoal (
)
→ (
OcaFloat64 goal)
Level: 3 Index: 13
Retrieves ramp goal value. The return value indicates whether the duration was successfully retrieved.
OcaRamper::SetGoal (
OcaFloat64 goal )
Level: 3 Index: 14
Sets ramp goal value. The return value indicates whether the duration was successfully set.