Введение

Системные объекты являются классами MATLAB, производными от matlab.System. В результате все объекты системы наследуют общий открытый интерфейс, который включает стандартные методы:

При создании новых видов системных объектов предоставляются специальные реализации для всех предшествующих методов, чтобы определить их поведение.

В этом примере рассматривается внутренняя структура и использование следующих двух системных объектов:

Для создания этих системных объектов для потоковой передачи данных в MATLAB и из MATLAB в этом примере используются стандартные низкоуровневые файловые функции ввода-вывода, доступные в MATLAB (например, fscanf, fread, fprintf, и fwrite). Абстрагируя большинство деталей использования этих функций, они стремятся сделать задачу чтения и записи потоковых данных более простой и эффективной.

Этот пример включает использование ряда расширенных конструкций для создания системных объектов. Более общие сведения о разработке системных объектов см. в разделе Создание системных объектов.

Определение класса TextFileReader

TextFileReader класс включает определение класса, общие и частные свойства, конструктор, защищенные методы, переопределенные из matlab.System базовый класс и частные методы. TextFileWriter класс имеет аналогичную структуру.

Определение класса

Определение класса указывает, что TextFileReader класс является производным от обоих matlab.System и matlab.system.mixin.FiniteSource.

   classdef (StrictDefaults)TextFileReader < matlab.System & matlab.system.mixin.FiniteSource

Общедоступные свойства

Общие свойства могут быть изменены пользователем для настройки поведения объекта в соответствии с его конкретным приложением. TextFileReader имеет два неперестраиваемых общих свойства (их можно изменить только перед первым вызовом объекта) и четыре настраиваемых общих свойства. Все общие свойства имеют значение по умолчанию. Значения по умолчанию присваиваются соответствующим свойствам, когда пользователь больше ничего не указывает.

   properties (Nontunable)
       Filename   = 'tempfile.txt' 
       HeaderLines = 4
   end

   properties
       DataFormat = '%g' 
       Delimiter = ',' 
       SamplesPerFrame = 1024
       PlayCount = 1
   end

Частные свойства

Частные свойства не видны пользователю и могут служить ряду целей, в том числе

   properties(Access = private)
       pFID = -1 
       pNumChannels 
       pLineFormat 
       pNumEofReached = 0
   end

Конструктор

Конструктор определен таким образом, что можно создать TextFileReader с использованием пар имя-значение. Конструктор вызывается при создании нового экземпляра TextDataReader создается. Вызов setProperties в конструкторе позволяет задавать свойства с парами имя-значение при построении. В конструкторе не следует указывать другие задачи инициализации. Вместо этого используйте setupImpl способ.

   methods
       function obj = TextFileReader(varargin)
           setProperties(obj, nargin, varargin{:});
       end
   end

Отвержение matlab.System Методы, защищенные базовым классом

Общие методы, общие для всех объектов системы, имеют соответствующие защищенные методы, которые они вызывают внутри системы. Все названия этих защищенных методов включают в себя Impl постфикс. Они могут быть реализованы при определении класса для программирования поведения объекта System.

Для получения дополнительной информации о соответствии между стандартными общедоступными методами и их внутренними реализациями см. раздел Сводка последовательности вызовов.

Например, TextFileReader переопределяет эти Impl методы:

Частные методы

Частные методы доступны только из других методов того же класса. Их можно использовать, чтобы сделать остальную часть кода более читаемой. Они также могут улучшить возможность многократного использования кода путем группирования в рамках отдельного кода подпрограммы, который используется несколько раз в различных частях класса. Для TextFileReader, частные методы создаются для:

Запись и чтение данных

В этом примере показано, как можно использовать TextFileReader и TextFileWriter около:

Создание простого текстового файла

Создайте новый файл для хранения двух синусоидальных сигналов с частотами 50 Гц и 60 Гц. Для каждого сигнала сохраненные данные состоят из 800 выборок с частотой дискретизации 8 кГц.

Создание образцов данных:

fs = 8000;
tmax = 0.1;
t = (0:1/fs:tmax-1/fs)';
N = length(t);
f = [50,60];
data = sin(2*pi*t*f);

Сформируйте строку заголовка, чтобы описать данные читаемым способом для будущего использования (необязательный шаг):

fileheader = sprintf(['The following contains %d samples of two ',...
    'sinusoids,\nwith frequencies %d Hz and %d Hz and a sample rate of',...
    ' %d kHz\n\n'], N, f(1),f(2),fs/1000);

Чтобы сохранить сигнал в текстовом файле, создайте TextFileWriter объект. Конструктор TextFileWriter требуется имя целевого файла и некоторые необязательные параметры, которые могут быть переданы как пары имя-значение.

TxtWriter = TextFileWriter('Filename','sinewaves.txt','Header',fileheader)

TxtWriter = 
  TextFileWriter with properties:

      Filename: 'sinewaves.txt'
        Header: 'The following contains 800 samples of two sinusoids,...'
    DataFormat: '%.18g'
     Delimiter: ','

TextFileWriter записывает данные в ASCII-файлы, разделенные разделителями. К его общественным свойствам относятся:

Для записи всех доступных данных в файл можно использовать один вызов.

TxtWriter(data)

Деблокирование управления файлом путем вызова release функция.

release(TxtWriter)

Теперь данные хранятся в новом файле. Для визуальной проверки файла введите:

edit('sinewaves.txt')

Поскольку заголовок занимает три строки, данные начинаются в строке 4.

В этом простом случае длина всего сигнала невелика, и он удобно укладывается в системную память. Поэтому все данные могут быть созданы одновременно и записаны в файл за один шаг.

Бывают случаи, когда такой подход невозможен или практичен. Например, данные могут быть слишком большими для размещения в одной переменной MATLAB (слишком большими для размещения в системной памяти). Альтернативно, данные могут создаваться циклически в цикле или поступать в MATLAB из внешнего источника. Во всех этих случаях потоковая передача данных в файл может быть выполнена с использованием подхода, аналогичного следующему примеру.

Используйте генератор потоковых синусоидальных волн для создания кадра данных на цикл. Выполните необходимое количество итераций, чтобы создать данные и сохранить их в файле:

frameLength = 32;
tmax = 10; 
t = (0:1/fs:tmax-1/fs)';
N = length(t);
data = sin(2*pi*t*f);
numCycles = N/frameLength;

for k = 1:10 % Long running loop when you replace 10 with numCycles. 
    dataFrame = sin(2*pi*t*f);
    TxtWriter(dataFrame)
end

release(TxtWriter)

Чтение из существующего текстового файла

Для чтения из текстового файла создайте экземпляр TextFileReader.

TxtReader = TextFileReader('Filename','sinewaves.txt','HeaderLines',3,'SamplesPerFrame',frameLength)

TxtReader = 
  TextFileReader with properties:

           Filename: 'sinewaves.txt'
        HeaderLines: 3
         DataFormat: '%g'
          Delimiter: ','
    SamplesPerFrame: 32
          PlayCount: 1

TextFileReader считывает числовые данные из ASCII-файлов, разделенных разделителями. Его свойства аналогичны свойствам TextFileWriter. Некоторые различия следуют

Для считывания данных из текстового файла используется более общий потоковый подход. Этот способ считывания данных также имеет отношение к работе с очень большими файлами данных. Предварительное выделение кадра данных с помощью frameLength строки и 2 столбца.

dataFrame = zeros(frameLength,2,'single');

Чтение из текстового файла и запись в двоичный файл при наличии данных в исходном текстовом файле. Обратите внимание на способ isDone используется для управления выполнением цикла while.

while(~isDone(TxtReader))
    dataFrame(:) = TxtReader();
end

release(TxtReader)

Резюме

В этом примере показано, как создавать и использовать системные объекты для чтения и записи в числовые файлы данных. TextFileReader и TextFileWriter может редактироваться для выполнения специальных операций чтения и записи файлов. Можно также объединить эти пользовательские системные объекты со встроенными системными объектами, такими как dsp.BinaryFileWriter и dsp.BinaryFileReader.

Дополнительные сведения о создании системных объектов для пользовательских алгоритмов см. в разделе Создание системных объектов.