Gemstone COMTRADE Library
Show/Hide TOC

# Schema Class

Represents the schema for a configuration file in the COMTRADE file standard, IEEE Std C37.111-1999/2013.

## Definition

Namespace: Gemstone.COMTRADE
Assembly: Gemstone.COMTRADE (in Gemstone.COMTRADE.dll) Version: 1.0.143 -- Release Build+4c9ab0c0ebde8b15b6e86803fe79dc3c98e684c3
C#
View Source Request Example

    public class Schema

VB
View Source Request Example

    Public Class Schema

C++
View Source Request Example

    public ref class Schema

JavaScript
View Source Request Example

    Gemstone.COMTRADE.Schema = function();

    Type.createClass(
    	'Gemstone.COMTRADE.Schema');

Inheritance
  Object Schema

## Constructors

Schema | Creates a new instance of the Schema.
Schema(String) | Creates a new instance of the Schema from an existing configuration file name.
Schema(String, Boolean) | Creates a new instance of the Schema from an existing configuration file name.

## Properties

AnalogChannels | Gets or sets analog channels of this Schema.
Binary32RecordLength | Calculates the size of a record, in bytes, when the file type is binary32.
BinaryRecordLength | Calculates the size of a record, in bytes, when the file type is binary.
DeviceID | Gets or sets free-form device ID for this Schema.
DigitalChannels | Gets or sets digital channels of this Schema.
DigitalWords | Gets the total digital words for given number of digital values when the file type is binary.
FileImage | Gets the file image of this Schema.
FileName | Gets the file name used to generate this schema when constructed with one; otherwise, null.
FileType | Gets or sets file type of this Schema.
Float32RecordLength | Calculates the size of a record, in bytes, when the file type is float32.
IsCombinedFileFormat | Gets flag that determines if FileName is a Combined File Format (.cff) file.
LeapSecondIndicator | Gets or sets the leap second indicator for the recorded data set.
LocalCode | Gets or sets UTC offset for timezone of recording device, or "x" for not applicable - format HhMM.
NominalFrequency | Gets or sets nominal frequency of this Schema.
SampleRates | Gets or sets sampling rates of this Schema. A file of phasor data will normally be made using a single sampling rate, so this will usually be 1.
StartTime | Gets or sets start timestamp of this Schema.
StationName | Gets or sets free-form station name for this Schema.
TimeCode | Gets or sets UTC offset for channel timestamps - format HhMM.
TimeFactor | Gets or sets the multiplication factor for the time differential (timestamp) field in this Schema.
TimeQualityIndicatorCode | Gets or sets the time quality indicator code for the recorded data set.
TotalAnalogChannels | Gets total number of analog channels of this Schema.
TotalChannels | Gets total number of analog and digital channels of this Schema.
TotalChannelValues | Gets total number of channels values, i.e., TotalChannels * TotalSamples.
TotalDigitalChannels | Gets total number of digital channels of this Schema.
TotalSampleRates | Gets total number of sample rates of this Schema.
TotalSamples | Gets total number of samples, i.e., rows per timestamp, as reported by the sample rates.
TriggerTime | Gets or sets trigger timestamp of this Schema.
Version | Gets or sets version number of the IEEE Std C37.111 used by this Schema.

## Methods

Equals | Determines whether the specified object is equal to the current object. (Inherited from Object)
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
GetHashCode | Serves as the default hash function. (Inherited from Object)
GetType | Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object)
ToString | Returns a string that represents the current object. (Inherited from Object)

## See Also

#### Reference

Gemstone.COMTRADE Namespace