Class Channel
This class holds the information about periodic channel. The parameter that will log data at the given interval.
Inheritance
System.Object
Channel
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: MAT.AtlasSessionApi
Assembly: MAT.AtlasSessionApi.dll
Syntax
public sealed class ChannelConstructors
Channel(UInt32, Int64, DataSource, DataType)
Create new channel for given channel id, interval, data source and it's type.
Declaration
public Channel(uint id, long interval, DataSource dataSource, DataType dataType = DataType.FloatingPoint32Bit)Parameters
| Type | Name | Description |
|---|---|---|
| System.UInt32 | id | |
| System.Int64 | interval | |
| DataSource | dataSource | |
| DataType | dataType |
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentException |
Fields
DefaultDataType
The default data type used for a channel unless otherwise specified.
Declaration
public const DataType DefaultDataType = DataType.FloatingPoint32BitField Value
| Type | Description |
|---|---|
| DataType |
Properties
DataSource
Gets the data source; Periodic or Row Data.
Declaration
public DataSource DataSource { get; }Property Value
| Type | Description |
|---|---|
| DataSource | Data source. |
DataType
Gets the data type.
Declaration
public DataType DataType { get; }Property Value
| Type | Description |
|---|---|
| DataType | The data type. |
Frequency
Gets the sample frequency.
Declaration
public double Frequency { get; }Property Value
| Type | Description |
|---|---|
| System.Double | The sample frequency (Hz). |
See Also
Id
Gets the channel id id.
Declaration
public uint Id { get; }Property Value
| Type | Description |
|---|---|
| System.UInt32 | Channel id id. |
Interval
Gets the interval between samples (ns).
Declaration
public long Interval { get; }Property Value
| Type | Description |
|---|---|
| System.Int64 | The sample interval (ns); zero for Row Data channels. |
Methods
Equals(Object)
Declaration
public override bool Equals(object obj)Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | obj |
Returns
| Type | Description |
|---|---|
| System.Boolean |
Overrides
System.Object.Equals(System.Object)
GetHashCode()
Declaration
public override int GetHashCode()Returns
| Type | Description |
|---|---|
| System.Int32 |
Overrides
System.Object.GetHashCode()
ToString()
Declaration
public override string ToString()Returns
| Type | Description |
|---|---|
| System.String |
Overrides
System.Object.ToString()
Operators
Equality(Channel, Channel)
Are two channels equal?
Declaration
public static bool operator ==(Channel left, Channel right)Parameters
| Type | Name | Description |
|---|---|---|
| Channel | left | |
| Channel | right |
Returns
| Type | Description |
|---|---|
| System.Boolean |
Inequality(Channel, Channel)
Are two channels unequal?
Declaration
public static bool operator !=(Channel left, Channel right)Parameters
| Type | Name | Description |
|---|---|---|
| Channel | left | |
| Channel | right |
Returns
| Type | Description |
|---|---|
| System.Boolean |