Class TcoToggleTask

Provides basic toggling between two states. The states are triggered by calling the Toggle() method.

To get the actual state of the toggle task, , and State properties are available.

Inheritance
System.Object
TcoObject
TcoToggleTask
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: PlcDocu.TcoCore
Assembly: TcoCoreConnector.dll
Syntax
public abstract class TcoToggleTask : TcoObject

Constructors

| Improve this Doc View Source

TcoToggleTask()

Prevents creating instance of this class via public constructor

Declaration
public TcoToggleTask()

Fields

| Improve this Doc View Source

_enabled

Use to determine if the manipulation is enabled for example from the HMI application. This value is read only, to modify it use the property Enabled

Declaration
public object _enabled
Field Value
Type Description
System.Object
| Improve this Doc View Source

_isServiceable

Indicated whether the task is in serviceable state. The default state 'serviceable' that means that the task can be invoked from the higher-level application. The serviceable state is cancelled when the immediate parent is ITcoServiceable and at the same time the parent is not in servicebable state. TcoComponent is serviceable, in order for the component's task to be invokable from higher-level application component must call Service method to induce the component into serviceable state.

Declaration
public object _isServiceable
Field Value
Type Description
System.Object
| Improve this Doc View Source

_state

Declaration
public object _state
Field Value
Type Description
System.Object
| Improve this Doc View Source

_toggleRequest

Use to toggle the state of this instance.

Declaration
public object _toggleRequest
Field Value
Type Description
System.Object

Properties

| Improve this Doc View Source

Context

Gets the context of this object. This context is given by declaration, its value is assigned after download by calling the implicit method FB_init() and cannot be changed during runtime.

Declaration
[IgnoreReflection]
public dynamic Context { get; }
Property Value
Type Description
System.Object

Plc type ITcoContext; Twin type:

| Improve this Doc View Source

Enabled

Gets whether the any manipulation with this instance is enabled.

Declaration
[IgnoreReflection]
public dynamic Enabled { get; }
Property Value
Type Description
System.Object

Plc type BOOL; Twin type: Vortex.Connector.ValueTypes.OnlinerBool
| Improve this Doc View Source

Identity

Gets identity of this TcoToggleTask(). This value is assigned after download by calling the implicit method FB_init() and cannot be changed during runtime. This variable is used in the higher level applications.

Declaration
[IgnoreReflection]
public dynamic Identity { get; }
Property Value
Type Description
System.Object

Plc type ULINT; Twin type: Vortex.Connector.ValueTypes.OnlinerULInt
| Improve this Doc View Source

State

Gets actual value of this instance.

Declaration
[IgnoreReflection]
public dynamic State { get; }
Property Value
Type Description
System.Object

Plc type BOOL; Twin type: Vortex.Connector.ValueTypes.OnlinerBool

Methods

| Improve this Doc View Source

Off()

Use to set the state of the '''TcoToggleTask''' to the value '''FALSE'''.

Declaration
[IgnoreReflection]
public dynamic Off()
Returns
Type Description
System.Object

Plc type BOOL; Twin type: Vortex.Connector.ValueTypes.OnlinerBool
| Improve this Doc View Source

On()

Use to set the state of the '''TcoToggleTask''' to the value '''TRUE'''.

Declaration
[IgnoreReflection]
public dynamic On()
Returns
Type Description
System.Object

Plc type BOOL; Twin type: Vortex.Connector.ValueTypes.OnlinerBool
| Improve this Doc View Source

OnFtrig()

Executes when toggle task changes its state from '''TRUE''' to '''FALSE'''.

Declaration
[IgnoreReflection]
protected void OnFtrig()
| Improve this Doc View Source

OnRtrig()

Executes when toggle task changes its state from '''FALSE''' to '''TRUE'''.

Declaration
[IgnoreReflection]
protected void OnRtrig()
| Improve this Doc View Source

OnStateChange()

Executes when toggle task changes its state .

Declaration
[IgnoreReflection]
protected void OnStateChange()
| Improve this Doc View Source

Run()

This method needs to be called cyclically.

Declaration
[IgnoreReflection]
public void Run()
| Improve this Doc View Source

TaskOff()

Executes when toggle task is in Off state .

Declaration
[IgnoreReflection]
protected void TaskOff()
| Improve this Doc View Source

TaskOn()

Executes when toggle task is in On state .

Declaration
[IgnoreReflection]
protected void TaskOn()
| Improve this Doc View Source

Toggle()

Use to toggle the state of the '''TcoToggletask'''.

Declaration
[IgnoreReflection]
public dynamic Toggle()
Returns
Type Description
System.Object

Plc type BOOL; Twin type: Vortex.Connector.ValueTypes.OnlinerBool