%SOCFILEREADER File reader
%
% The socFileReader object is a file reader that reads data from a
% specified TGZ-compressed file and stores the data sets in the object. The
% data set contains information about the source objects that represent
% recorded data sources from the specified TGZ-compressed file.
%
% Creation:
% 
%   fr = socFileReader(filename) creates an socFileReader object, fr, from
%   the specified file. The socFileReader object is a file reader that reads
%   data from a specified TGZ-compressed file and stores the data sets in the
%   object. The filename must be a file saved using the save object function.
%
%   Input Arguments:
%     filename - File from previous data recording session
%                character vector
%
% Properties:
%       Description - User metadata describing data set
%                     character vector
%     HardwareBoard - Name of SoC hardware board
%                     character vector
%              Tags - User tags 
%                     cell array
%          Filename - Name of recorded data file
%                     character vector
%           Sources - List of sources in data set
%                     cell array
%              Date - Date of data set creation
%                     character vector
%
% Object Functions:
%    getData - Get data from file reader
%
%
% Examples: 
%
%   % Create File Reader Object
%   fr = socFileReader('UDPDataReceived.tgz')
%   fr = 
%      socFileReader with properties:
% 
%         Description: ''
%       HardwareBoard: 'Xilinx Zynq ZC706 evaluation kit'
%                Tags: {}
%            Filename: 'H:\UDPDataReceived.tgz'
%             Sources: {'UDPDataOnPort25000'}
%                Date: 28-Dec-2018 15:17:08
%
%   % Get the data of a specified source from the file using the getData function.
%   rd = getData(fr,'UDPDataReceived-Port25000');
%

% Copyright 2019 The MathWorks, Inc.
  