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 |
---|---|---|
|
Initializes a new instance of the Command class. | |
|
Initializes a new instance of the Command class with the specified name. |
Properties
|
Name |
Description |
---|---|---|
|
Contains a value that indicates whether the Command has changed. | |
|
Contains the customer data associated with this Command. This can be used to identify multiple calls to the same symbol in one request. | |
|
Gets the domain of the symbol. | |
|
Contains the extension result of the Command. | |
|
Gets a value that indicates whether the result will be filtered. | |
|
Gets a value that indicates whether the Command has symbol options. | |
|
Gets a value that indicates whether the Command is set. | |
|
Gets the mapping of the symbol. | |
|
Contains the name of the symbol. | |
|
Contains the CommandOptions of the symbol. | |
|
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. | |
|
Gets the path of the Mapping. | |
|
Contains the DateTime that indicates when processing the data in this Command ended. | |
|
Contains the DateTime that indicates when processing the data in this Command started. | |
|
Contains the read value of the Command. | |
|
Gets the result of the symbol. | |
|
Contains the result String of the Command. | |
|
Gets the options of the symbol. | |
|
Contains the write value of the Command. |
Methods
|
Name |
Description |
---|---|---|
|
Creates a new object that is a deep copy of the current Command. | |
|
Determines whether the specified Object is equal to the current Command. (Overrides Object.Equals(Object).) | |
|
Indicates whether the current Command is equal to another Command. | |
|
Serves as the default hash function. (Overrides Object.GetHashCode..) | |
|
Gets the Type of the current instance. (Inherited from Object.) | |
|
Creates a new Command that is a shallow copy of the current Command. | |
|
Returns a String that represents the Name of the current Command. (Overrides Object.ToString..) |
Operators
|
Name |
Description |
---|---|---|
|
Determines whether two instances of the Command class are equal. | |
|
Determines whether two instances of the Command class are not equal. |
Extension Methods
|
Name |
Description |
---|---|---|
|
Overloaded. Returns an unformatted JSON String that represents the current Command. (Defined by CommandExtensions.) | |
|
Overloaded. Returns an unformatted JSON String that represents the current Command. (Defined by CommandExtensions.) | |
|
Overloaded. Returns a JSON String that represents the current Command. (Defined by CommandExtensions.) |