Command Class

Inheritance Hierarchy

SystemObject
TcHmiSrv.CoreCommand

Namespace: TcHmiSrv.Core
Assembly: TcHmiSrvExtNet.Core (in TcHmiSrvExtNet.Core.dll) Version: 3.1.7447.0+85f9b473a1dd11b8f3e5c9a182fd1901975e46f9

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	Initializes a new instance of the Command class.
	Command(String)	Initializes a new instance of the Command class with the specified name.

Properties

	Name	Description
	Changed	Contains a value that indicates whether the Command has changed.
	CustomerData	Contains the customer data associated with this Command. This can be used to identify multiple calls to the same symbol in one request.
	Domain	Gets the domain of the symbol.
	ExtensionData	Contains optional extension data associated with this Command. This can be used to add additional information to the Command.
	ExtensionResult	Contains the extension result of the Command.
	HasPaging	Gets a value that indicates whether the result will be filtered.
	HasSymbolOptions	Gets a value that indicates whether the Command has symbol options.
	IsSet	Gets a value that indicates whether the Command is set.
	Mapping	Gets the mapping of the symbol.
	Name	Contains the name of the symbol.
	Options	Contains the CommandOptions of the symbol.
	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.
	Path	Gets the path of the Mapping.
	ProcessedEnd	Contains the DateTime that indicates when processing the data in this Command ended.
	ProcessedStart	Contains the DateTime that indicates when processing the data in this Command started.
	ReadValue	Contains the read value of the Command.
	Result	Gets the result of the symbol.
	ResultString	Contains the result String of the Command.
	SubsymbolHandled	Contains a value that indicates whether the resolution of a subsymbol is handled by the TwinCAT HMI server extension. The default value is false.
	SymbolOptions	Gets the options of the symbol.
	WriteValue	Contains the write value of the Command.

Methods

	Name	Description
	DeepCopy	Creates a new object that is a deep copy of the current Command.
	Equals(Command)	Indicates whether the current Command is equal to another Command.
	Equals(Object)	Determines whether the specified Object is equal to the current Command. (Overrides ObjectEquals(Object))
	GetHashCode	Serves as the default hash function. (Overrides ObjectGetHashCode)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	SetProcessedEnd	Sets the DateTime that indicates when processing the data in this Command ended to SteadyTime.Now.
	SetProcessedStart	Sets the DateTime that indicates when processing the data in this Command started to SteadyTime.Now.
	ShallowCopy	Creates a new Command that is a shallow copy of the current Command.
	ToString	Returns a String that represents the Name of the current Command. (Overrides ObjectToString)

Operators

	Name	Description
	Equality(Command, Command)	Determines whether two instances of the Command class are equal.
	Inequality(Command, Command)	Determines whether two instances of the Command class are not equal.

Name

Description

Command Class 33:

Command Class 34:

Equality(Command, Command)

Determines whether two instances of the Command class are equal.

Command Class 35:

Command Class 36:

Inequality(Command, Command)

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

Extension Methods

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

Version Information

Supported in: 3.1.7447.0, 2.3.7447.0, 1.10.7447.0

Reference

TcHmiSrv.Core Namespace