Class Tag

Namespace

Kepware.Api.Model

Assembly

Kepware.Api.dll

Represents a tag in a device or tag group.

[RecursiveEndpoint("/config/v1/project/channels/{channelName}/devices/{deviceName}", "/tag_groups/{groupName}", typeof(DeviceTagGroup), "/tags/{tagName}")]
public class Tag : NamedEntity, IEquatable<BaseEntity>, IHaveOwner, IHaveName

Inheritance

object

BaseEntity

DefaultEntity

NamedEntity

Tag

Implements

IEquatable<BaseEntity>

IHaveOwner

IHaveName

Inherited Members

NamedEntity.Name

NamedEntity.AppendHashSources(CustomHashGenerator.HashSourceBuilder)

NamedEntity.GetUpdateDiff(NamedEntity, bool)

DefaultEntity.Owner

BaseEntity.Hash

BaseEntity.ProjectId

BaseEntity.Description

BaseEntity.TypeName

BaseEntity.DynamicProperties

BaseEntity.Equals(BaseEntity)

BaseEntity.GetDynamicProperty<T>(string)

BaseEntity.SetDynamicProperty<T>(string, T)

BaseEntity.TryGetGetDynamicProperty<T>(string, out T)

BaseEntity.CalculateHash()

BaseEntity.Cleanup(IKepwareDefaultValueProvider, bool, CancellationToken)

BaseEntity.GetUpdateDiff(DefaultEntity)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

HelperExtentions.Flatten(NamedEntity?)

HelperExtentions.Flatten(NamedEntity?, Type)

Properties

DataType

The data type of the tag as found in the physical device. This setting affects how the communication driver reads and writes data.

IsAutogenerated

A flag indicating if the tag is autogenerated.

ReadWriteAccess

Defines the access mode of the tag. Determines if the tag is read-only or read/write.

ScalingClampHigh

Determines whether the scaled value is clamped to the upper boundary.

ScalingClampLow

Determines whether the scaled value is clamped to the lower boundary.

ScalingNegateValue

If enabled, negates the scaled value before passing it to the client.

ScalingRawHigh

Defines the upper boundary of the raw data range before scaling. The value must be greater than ScalingRawLow.

ScalingRawLow

Defines the lower boundary of the raw data range before scaling. The valid range depends on the data type of the tag.

ScalingScaledDataType

Specifies the data type for the scaled value of the tag.

ScalingScaledHigh

Defines the upper boundary of the scaled data range after applying scaling.

ScalingScaledLow

Defines the lower boundary of the scaled data range after applying scaling.

ScalingType

Specifies the method of scaling raw values: None, Linear, or Square Root.

ScalingUnits

The engineering units associated with the scaled data.

ScanRateMilliseconds

The frequency, in milliseconds, at which the tag value is updated. This rate is only used under certain conditions. See the Kepware server manuals for more information. The default is 100 milliseconds.

TagAddress

The address of the tag within the device. The format depends on the driver type configured.

Methods

ConditionalNonSerialized()

If the tag has no scaling, the scaling properties are not serialized.