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
Implements
Vortex.Connector.Identity.IVortexIdentity
System.Windows.Input.ICommand
Vortex.Connector.IVortexObject
Vortex.Connector.ITwinObject
Vortex.Connector.IVortexElement
Vortex.Connector.IVortexOnlineObject
Vortex.Connector.IVortexShadowObject
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: TcoCore
Assembly: TcoCoreConnector.dll
Syntax
[TypeMetaDescriptor("{attribute addProperty StateOnDesc \"<#On#>\" } {attribute addProperty StateOffDesc \"<#Off#>\" } {attribute addProperty Name \"\" }", "TcoToggleTask", "TcoCore", TypeComplexityEnum.Complex)]
public class TcoToggleTask : TcoObject, IVortexIdentity, IsTcoObject, ICommand, IDecorateLog, IsTask, IVortexObject, ITwinObject, IVortexElement, ITcoToggleTask, ITcoObject, IShadowTcoToggleTask, IShadowTcoObject, IVortexOnlineObject, IVortexShadowObject

Constructors

| Improve this Doc View Source

TcoToggleTask()

Declaration
public TcoToggleTask()
| Improve this Doc View Source

TcoToggleTask(IVortexObject, String, String)

Declaration
public TcoToggleTask(IVortexObject parent, string readableTail, string symbolTail)
Parameters
Type Name Description
Vortex.Connector.IVortexObject parent
System.String readableTail
System.String symbolTail

Fields

| Improve this Doc View Source

__enabled

Declaration
OnlinerBool __enabled
Field Value
Type Description
Vortex.Connector.ValueTypes.OnlinerBool
| Improve this Doc View Source

__isServiceable

Declaration
OnlinerBool __isServiceable
Field Value
Type Description
Vortex.Connector.ValueTypes.OnlinerBool
| Improve this Doc View Source

__state

Declaration
OnlinerBool __state
Field Value
Type Description
Vortex.Connector.ValueTypes.OnlinerBool
| Improve this Doc View Source

__toggleRequest

Declaration
OnlinerBool __toggleRequest
Field Value
Type Description
Vortex.Connector.ValueTypes.OnlinerBool
| Improve this Doc View Source

_logPayloadDecoration

Declaration
Func<object> _logPayloadDecoration
Field Value
Type Description
System.Func<System.Object>
| Improve this Doc View Source

codeProvider

Declaration
ICodeProvider codeProvider
Field Value
Type Description
ICodeProvider

Properties

| Improve this Doc View Source

_AttributeStateOffDesc

Declaration
string _AttributeStateOffDesc { }
Property Value
Type Description
System.String
| Improve this Doc View Source

_AttributeStateOnDesc

Declaration
string _AttributeStateOnDesc { }
Property Value
Type Description
System.String
| 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
[ReadOnly]
public OnlinerBool _enabled { get; }
Property Value
Type Description
Vortex.Connector.ValueTypes.OnlinerBool
| 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
[ReadOnly]
[RenderIgnore]
public OnlinerBool _isServiceable { get; }
Property Value
Type Description
Vortex.Connector.ValueTypes.OnlinerBool
| Improve this Doc View Source

_state

Declaration
[ReadOnly]
public OnlinerBool _state { get; }
Property Value
Type Description
Vortex.Connector.ValueTypes.OnlinerBool
| Improve this Doc View Source

_toggleRequest

Use to toggle the state of this instance.

Declaration
public OnlinerBool _toggleRequest { get; }
Property Value
Type Description
Vortex.Connector.ValueTypes.OnlinerBool
| Improve this Doc View Source

AttributeStateOffDesc

Declaration
public string AttributeStateOffDesc { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

AttributeStateOnDesc

Declaration
public string AttributeStateOnDesc { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

CodeProvider

Gets swift code provider for this task.

Declaration
public virtual ICodeProvider CodeProvider { get; protected set; }
Property Value
Type Description
ICodeProvider
| Improve this Doc View Source

LogPayloadDecoration

Declaration
public Func<object> LogPayloadDecoration { get; set; }
Property Value
Type Description
System.Func<System.Object>
| Improve this Doc View Source

RecordTaskAction

Gets or set action recording delegate for this task.

Declaration
public RecordTaskActionDelegate RecordTaskAction { get; set; }
Property Value
Type Description
RecordTaskActionDelegate

Methods

| Improve this Doc View Source

CanExecute(Object)

Queries whether the command can be executed.

Declaration
public bool CanExecute(object parameter)
Parameters
Type Name Description
System.Object parameter
Returns
Type Description
System.Boolean

Boolean result of the query.
| Improve this Doc View Source

CopyPlainToShadow(PlainTcoToggleTask)

Declaration
public void CopyPlainToShadow(PlainTcoToggleTask source)
Parameters
Type Name Description
PlainTcoToggleTask source
| Improve this Doc View Source

CreatePlainerType()

Declaration
public PlainTcoToggleTask CreatePlainerType()
Returns
Type Description
PlainTcoToggleTask
| Improve this Doc View Source

CreatePlainerType(PlainTcoToggleTask)

Declaration
protected PlainTcoToggleTask CreatePlainerType(PlainTcoToggleTask cloned)
Parameters
Type Name Description
PlainTcoToggleTask cloned
Returns
Type Description
PlainTcoToggleTask
| Improve this Doc View Source

Execute(Object)

Executes this task.

Declaration
public void Execute(object parameter)
Parameters
Type Name Description
System.Object parameter
| Improve this Doc View Source

FlushOnlineToPlain(PlainTcoToggleTask)

Declaration
public void FlushOnlineToPlain(PlainTcoToggleTask source)
Parameters
Type Name Description
PlainTcoToggleTask source
| Improve this Doc View Source

FlushOnlineToShadow()

Declaration
public void FlushOnlineToShadow()
| Improve this Doc View Source

FlushPlainToOnline(PlainTcoToggleTask)

Declaration
public void FlushPlainToOnline(PlainTcoToggleTask source)
Parameters
Type Name Description
PlainTcoToggleTask source
| Improve this Doc View Source

FlushShadowToOnline()

Declaration
public void FlushShadowToOnline()
| Improve this Doc View Source

LazyOnlineToShadow()

Declaration
public void LazyOnlineToShadow()
| Improve this Doc View Source

LazyShadowToOnline()

Declaration
public void LazyShadowToOnline()
| Improve this Doc View Source

PexConstructor(IVortexObject, String, String)

Declaration
void PexConstructor(IVortexObject parent, string readableTail, string symbolTail)
Parameters
Type Name Description
Vortex.Connector.IVortexObject parent
System.String readableTail
System.String symbolTail
| Improve this Doc View Source

PexConstructorParameterless()

Declaration
void PexConstructorParameterless()
| Improve this Doc View Source

PexPreConstructor(IVortexObject, String, String)

Declaration
void PexPreConstructor(IVortexObject parent, string readableTail, string symbolTail)
Parameters
Type Name Description
Vortex.Connector.IVortexObject parent
System.String readableTail
System.String symbolTail
| Improve this Doc View Source

PexPreConstructorParameterless()

Declaration
void PexPreConstructorParameterless()
| Improve this Doc View Source

TcoToggleTask_CanExecuteChanged(Object, EventArgs)

Declaration
void TcoToggleTask_CanExecuteChanged(object sender, EventArgs e)
Parameters
Type Name Description
System.Object sender
System.EventArgs e
| Improve this Doc View Source

ValidateCanExecute(IValueTag, ValueChangedEventArgs)

Declaration
void ValidateCanExecute(IValueTag sender, ValueChangedEventArgs args)
Parameters
Type Name Description
Vortex.Connector.IValueTag sender
Vortex.Connector.ValueTypes.ValueChangedEventArgs args

Events

| Improve this Doc View Source

CanExecuteChanged

Declaration
public event EventHandler CanExecuteChanged
Event Type
Type Description
System.EventHandler

Explicit Interface Implementations

| Improve this Doc View Source

IShadowTcoToggleTask._enabled

Declaration
[ReadOnly]
IShadowBool IShadowTcoToggleTask._enabled { get; }
Returns
Type Description
Vortex.Connector.ValueTypes.Shadows.IShadowBool
| Improve this Doc View Source

IShadowTcoToggleTask._isServiceable

Declaration
[ReadOnly]
[RenderIgnore]
IShadowBool IShadowTcoToggleTask._isServiceable { get; }
Returns
Type Description
Vortex.Connector.ValueTypes.Shadows.IShadowBool
| Improve this Doc View Source

IShadowTcoToggleTask._state

Declaration
[ReadOnly]
IShadowBool IShadowTcoToggleTask._state { get; }
Returns
Type Description
Vortex.Connector.ValueTypes.Shadows.IShadowBool
| Improve this Doc View Source

IShadowTcoToggleTask._toggleRequest

Declaration
IShadowBool IShadowTcoToggleTask._toggleRequest { get; }
Returns
Type Description
Vortex.Connector.ValueTypes.Shadows.IShadowBool
| Improve this Doc View Source

ITcoToggleTask._enabled

Declaration
[ReadOnly]
IOnlineBool ITcoToggleTask._enabled { get; }
Returns
Type Description
Vortex.Connector.ValueTypes.Online.IOnlineBool
| Improve this Doc View Source

ITcoToggleTask._isServiceable

Declaration
[ReadOnly]
[RenderIgnore]
IOnlineBool ITcoToggleTask._isServiceable { get; }
Returns
Type Description
Vortex.Connector.ValueTypes.Online.IOnlineBool
| Improve this Doc View Source

ITcoToggleTask._state

Declaration
[ReadOnly]
IOnlineBool ITcoToggleTask._state { get; }
Returns
Type Description
Vortex.Connector.ValueTypes.Online.IOnlineBool
| Improve this Doc View Source

ITcoToggleTask._toggleRequest

Declaration
IOnlineBool ITcoToggleTask._toggleRequest { get; }
Returns
Type Description
Vortex.Connector.ValueTypes.Online.IOnlineBool

Implements

Vortex.Connector.Identity.IVortexIdentity
System.Windows.Input.ICommand
Vortex.Connector.IVortexObject
Vortex.Connector.ITwinObject
Vortex.Connector.IVortexElement
Vortex.Connector.IVortexOnlineObject
Vortex.Connector.IVortexShadowObject

See Also