Class TcoInspector

Base block for signal and data inspectors. This block is abstract and must be inherited in derived block. Inspector provide a mechanism for detection and evaluation of various signals. The inspection is settable by a series of settings, like stabilisation times, timeouts, repeats counts, etc.

Inheritance
System.Object
TcoObject
TcoInspector
TcoAnalogueInspector
TcoDataInspector
TcoDigitalInspector
TcoInspectionGroup
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.TcoInspectors
Assembly: TcoInspectorsConnector.dll
Syntax
public abstract class TcoInspector : TcoObject

Constructors

| Improve this Doc View Source

TcoInspector()

Prevents creating instance of this class via public constructor

Declaration
public TcoInspector()

Fields

| Improve this Doc View Source

_coordinator

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

_inspectorTask

Declaration
public TcoInspectorTask _inspectorTask
Field Value
Type Description
TcoInspectorTask
| Improve this Doc View Source

_tcoInspectorDialogue

Declaration
public TcoInspectorDialog _tcoInspectorDialogue
Field Value
Type Description
TcoInspectorDialog

Properties

| Improve this Doc View Source

Busy

Gets true while the inspection is running.

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

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

CommonData

Gets common data settings of inspectors.

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

Plc type TcoInspectorData; Twin type: TcoInspectorData
| Improve this Doc View Source

Coordinator

Gets the coordinator assotiated with this inspector.

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

Plc type ITcoCoordinator; Twin type:

| Improve this Doc View Source

Done

Gets true when the inspection is done.

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

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

OverInspected

Gets true when the number of inspections excceds NumberOfAllowedRetries.

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

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

Result

Gets the inspection result of this inspector.

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

Plc type eInspectorResult; Twin type:

Methods

| Improve this Doc View Source

CarryOn()

Upon failure continues in the execution of coordinator. The overall results is marked as failed.

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

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

Dialog(Object)

Upon failure displays dialogue for the user to take decision about the fate of the inspection.

Declaration
[IgnoreReflection]
public dynamic Dialog(dynamic inRetryStep)
Parameters
Type Name Description
System.Object inRetryStep

Plc type : INT [VAR_INPUT]; Twin type : Vortex.Connector.ValueTypes.OnlinerInt
Returns
Type Description
System.Object

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

IsOverinspected()

Gets true when this inspection overruns max number of inspection.

Declaration
[IgnoreReflection]
protected dynamic IsOverinspected()
Returns
Type Description
System.Object

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

OnEnterInspection()

Executes each time the Inspect method is called.

Declaration
[IgnoreReflection]
protected dynamic OnEnterInspection()
Returns
Type Description
System.Object

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

Retry(Object)

Upon failure the inspection retries given number of time.

Declaration
[IgnoreReflection]
public dynamic Retry(dynamic inFromState)
Parameters
Type Name Description
System.Object inFromState

Plc type : INT [VAR_INPUT]; Twin type : Vortex.Connector.ValueTypes.OnlinerInt

State from which the inspection will restart.

Returns
Type Description
System.Object

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

Terminate()

Upon failure the inspection terminates the run of the coordinator.

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

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

UpdateComprehensiveResult(Object)

Updates comprehensive result. The comprehensive result is set to Failed when any inspection fails or is inconclusive. Any bypassed or excluded inspection are not taken in the account.

Declaration
[IgnoreReflection]
public dynamic UpdateComprehensiveResult(dynamic inoResult)
Parameters
Type Name Description
System.Object inoResult

Plc type : TcoComprehensiveResult [VAR_IN_OUT]; Twin type : TcoComprehensiveResult

Comprehensive result data structure to be updated.

Returns
Type Description
System.Object

Plc type IInspector; Twin type:

| Improve this Doc View Source

UpdateDescriptions(Object)

Updates failure description. Adding FailureDescription do the overall result structure.

Declaration
[IgnoreReflection]
protected void UpdateDescriptions(dynamic inoResult)
Parameters
Type Name Description
System.Object inoResult

Plc type : TcoComprehensiveResult [VAR_IN_OUT]; Twin type : TcoComprehensiveResult