Class Channel

Namespace

Kepware.Api.Model

Assembly

Kepware.Api.dll

Represents a channel in the project.

[Endpoint("/config/v1/project/channels/{name}", null)]
public class Channel : NamedUidEntity, IEquatable<BaseEntity>, IHaveOwner, IHaveName

Inheritance

object

BaseEntity

DefaultEntity

NamedEntity

NamedUidEntity

Channel

Implements

IEquatable<BaseEntity>

IHaveOwner

IHaveName

Inherited Members

NamedUidEntity.UniqueId

NamedUidEntity.RemoveUniqueId()

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.ConditionalNonSerialized()

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)

Constructors

Channel()

Initializes a new instance of the Channel class.

Channel(string)

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

Properties

DeviceDriver

Gets or sets the driver used by this channel.

Devices

Gets or sets the devices in the channel.

DiagnosticsCapture

Gets or sets a value indicating whether communication diagnostics is enabled for the channel.

EthernetNetworkAdapter

Gets or sets the network adapter used for Ethernet-based communication.

NonNormalizedFloatHandling

Gets or sets how non-normalized IEEE-754 floating point values are handled.

UniqueIdKey

Gets the unique ID key for the channel.

WriteOptimizationsDutyCycle

Gets or sets the write optimization duty cycle.

WriteOptimizationsMethod

Gets or sets the write optimization method used for the channel.

Methods

Cleanup(IKepwareDefaultValueProvider, bool, CancellationToken)

Recursively cleans up the channel and all devices.