Interface IChannel
Describes a channel.
Namespace: MESL.SqlRace.Domain
Assembly: MESL.SqlRace.Domain.dll
Syntax
public interface IChannelProperties
DataSource
Gets or sets the type of source that is providing the data that the channel holds.
Declaration
ChannelDataSourceType DataSource { get; }Property Value
| Type | Description |
|---|---|
| ChannelDataSourceType |
DataType
Gets or sets the DataType representing the type and size of the data that the channel samples will be.
Declaration
DataType DataType { get; }Property Value
| Type | Description |
|---|---|
| DataType |
Id
Gets or sets the channel Id.
Declaration
uint Id { get; }Property Value
| Type | Description |
|---|---|
| System.UInt32 |
InMemory
Gets a value indicating whether [in memory].
Declaration
bool InMemory { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
|
Interval
Gets or sets the frequency period of the channel samples (in nanoseconds).
Declaration
long Interval { get; }Property Value
| Type | Description |
|---|---|
| System.Int64 |
Remarks
For non-periodic RowDataChannels this may be set to zero.
Name
Gets or sets the channel Name.
Declaration
string Name { get; }Property Value
| Type | Description |
|---|---|
| System.String |
ParameterChannelKey
Gets or sets the parameter channel key, used to identify channels to which this channel should be associated.
Declaration
string ParameterChannelKey { get; }Property Value
| Type | Description |
|---|---|
| System.String | The parameter channel key. |
ReadOnly
Gets or sets a value indicating whether this IChannel is read-only.
Declaration
bool ReadOnly { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
|
SampleSizeInBytes
Gets the size in bytes of a sample for this channel.
Declaration
int SampleSizeInBytes { get; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
Methods
CreateCopy(UInt32)
Creates a copy of this Channel with the channelIdOffset applied.
Declaration
IChannel CreateCopy(uint channelIdOffset)Parameters
| Type | Name | Description |
|---|---|---|
| System.UInt32 | channelIdOffset | The channel id offset to apply. |
Returns
| Type | Description |
|---|---|
| IChannel |