Command Class

Represents a command to execute a symbol of the TwinCAT HMI server or a TwinCAT HMI server extension.

Inheritance Hierarchy

System.Object
  TcHmiSrv.Core.Command
Namespace:  TcHmiSrv.Core
Assembly:  TcHmiSrvExtNet.Core (in TcHmiSrvExtNet.Core.dll) Version: 1.3.0.0

Syntax

C#

public sealed class Command : ICopyable<Command>, 
    IDeepCopyable<Command>, IShallowCopyable<Command>, IEquatable<Command>, 
    IExchangeable<Command>, ICommandMapper

The Command type exposes the following members.

Constructors

 

Name

Description

Command Class 1:

Command.

Initializes a new instance of the Command class.

Command Class 2:

Command(String)

Initializes a new instance of the Command class with the specified name.

Properties

 

Name

Description

Command Class 3:

Changed

Contains a value that indicates whether the Command has changed.

Command Class 4:

CustomerData

Contains the customer data associated with this Command. This can be used to identify multiple calls to the same symbol in one request.

Command Class 5:

Domain

Gets the domain of the symbol.

Command Class 6:

ExtensionResult

Contains the extension result of the Command.

Command Class 7:

HasPaging

Gets a value that indicates whether the result will be filtered.

Command Class 8:

HasSymbolOptions

Gets a value that indicates whether the Command has symbol options.

Command Class 9:

IsSet

Gets a value that indicates whether the Command is set.

Command Class 10:

Mapping

Gets the mapping of the symbol.

Command Class 11:

Name

Contains the name of the symbol.

Command Class 12:

Options

Contains the CommandOptions of the symbol.

Command Class 13:

Paging

Gets the filter of the symbol used by this Command. Filters can be used to set rules for reducing the size of returned Values of type Vector or Map. If your TwinCAT HMI server extension handles the filtering or paging itself set PagingHandled.

Command Class 14:

Path

Gets the path of the Mapping.

Command Class 15:

ProcessedEnd

Contains the DateTime that indicates when processing the data in this Command ended.

Command Class 16:

ProcessedStart

Contains the DateTime that indicates when processing the data in this Command started.

Command Class 17:

ReadValue

Contains the read value of the Command.

Command Class 18:

Result

Gets the result of the symbol.

Command Class 19:

ResultString

Contains the result String of the Command.

Command Class 20:

SymbolOptions

Gets the options of the symbol.

Command Class 21:

WriteValue

Contains the write value of the Command.

Methods

 

Name

Description

Command Class 22:

DeepCopy

Creates a new object that is a deep copy of the current Command.

Command Class 23:

Equals(Object)

Determines whether the specified Object is equal to the current Command. (Overrides Object.Equals(Object).)

Command Class 24:

Equals(Command)

Indicates whether the current Command is equal to another Command.

Command Class 25:

GetHashCode

Serves as the default hash function. (Overrides Object.GetHashCode..)

Command Class 26:

GetType

Gets the Type of the current instance. (Inherited from Object.)

Command Class 27:

ShallowCopy

Creates a new Command that is a shallow copy of the current Command.

Command Class 28:

ToString

Returns a String that represents the Name of the current Command. (Overrides Object.ToString..)

Operators

 

Name

Description

Command Class 29:

Command Class 30:

Equality

Determines whether two instances of the Command class are equal.

Command Class 31:

Command Class 32:

Inequality

Determines whether two instances of the Command class are not equal.

Extension Methods

 

Name

Description

Command Class 33:

ToJson.

Overloaded.

Returns an unformatted JSON String that represents the current Command. (Defined by CommandExtensions.)

Command Class 34:

ToJson(Boolean)

Overloaded.

Returns an unformatted JSON String that represents the current Command. (Defined by CommandExtensions.)

Command Class 35:

ToJson(Boolean, Boolean)

Overloaded.

Returns a JSON String that represents the current Command. (Defined by CommandExtensions.)

Reference

TcHmiSrv.Core Namespace