% AO_MODEL_SINEWAVE constructs a sine-wave time-series
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% DESCRIPTION: AO_MODEL_SINEWAVE constructs a sine-wave time-series
%
% CALL:        a = ao(plist('built-in', 'sinewave'), pl);
%
% INPUTS:
%           pl - a parameter list of additional parameters (see below)
%
% OUTPUTS:
%           mdl - an AO object representing the time-series of the signal
%
%
% INFO:
%   <a href="matlab:utils.models.displayModelOverview('ao_model_sinewave')">Model Information</a>
%
%
% REFERENCES:
%
%
% VERSION:     $Id: ao_model_sinewave.m,v 1.4 2011/04/29 08:04:07 hewitson Exp $
%
% HISTORY:
%
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

function varargout = ao_model_sinewave(varargin)
  
  varargout = utils.models.mainFnc(varargin(:), ...
    mfilename, ...
    @getModelDescription, ...
    @getModelDocumentation, ...
    @getVersion, ...
    @versionTable);
  
end

%--------------------------------------------------------------------------
% AUTHORS EDIT THIS PART
%--------------------------------------------------------------------------

function desc = getModelDescription
  desc = 'Constructs a sine-wave time-series';
end

function doc = getModelDocumentation
  doc = sprintf([...
    'No documentation at the moment' ...
    ]);
end

% default version is always the first one
function vt = versionTable()
  
  vt = {...
    'Initial version', @version01, ...
    };
  
end

  
% This version is the initial one
%
function varargout = version01(varargin)

  if nargin == 1 && ischar(varargin{1})
    switch varargin{1}
      case 'plist'
        
        % The plist for this version of this model
        pl = plist();
        
        % parameters 'Fs', 'Nsecs', 'Xunits'
        pl.append(plist.TSDATA_PLIST);
        
        % parameter 'A'
        p = param({'A','Amplitude of the signal.'}, {1, {1}, paramValue.OPTIONAL});
        pl.append(p);
        
        % parameter 'F'
        p = param({'f', 'Frequency of the signal.'}, ...
          {1, {1}, paramValue.OPTIONAL});
        pl.append(p);
        
        % parameter 'Phi'
        p = param({'phi','Phase of the signal.'}, {1, {0}, paramValue.OPTIONAL});
        pl.append(p);
        
        % parameter 'Toff'
        p = param({'Toff', ['Offset of the sine wave, as a number of seconds']}, {1, {0}, paramValue.OPTIONAL});
        pl.append(p);
        
        % parameter 'Yunits'
        p = param({'yunits','Unit on Y axis.'},  paramValue.STRING_VALUE(''));
        pl.append(p);
        
        % set output
        varargout{1} = pl;
        
      case 'description'
        varargout{1} = 'This version is the initial one';
      case 'info'
        varargout{1} = [];
      otherwise
        error('unknown inputs');
    end
    return;
  end
  
  % build model
  pl = varargin{1};
  fs     = find(pl, 'fs');
  nsecs  = find(pl, 'nsecs');
  A      = find(pl, 'A');
  f      = find(pl, 'f');
  phi    = find(pl, 'phi');
  toff   = find(pl, 'toff');
  xunits = find(pl, 'xunits');
  yunits = find(pl, 'yunits');
  
  % build data vectors
  t = 0 : 1/fs : nsecs - 1/fs;
  y = A*sin(2*pi*f*t + phi).*(t >= toff);
  
  % Build a time-series AO and set its name, X-units, Y-units
  spl = plist(...
    'xvals', t, ...
    'yvals', y, ...
    'type', 'tsdata', ...
    'fs', fs, ...
    'xunits', xunits, ...
    'yunits', yunits, ...
    'name', 'Sine wave' ...
    );
  
  a = ao(spl);
  a.setProcinfo(spl);
  
  varargout{1} = a;
  
end


%--------------------------------------------------------------------------
% AUTHORS SHOULD NOT NEED TO EDIT BELOW HERE
%--------------------------------------------------------------------------


%--------------------------------------------------------------------------
% Get Version
%--------------------------------------------------------------------------
function v = getVersion
  
  v = '$Id: ao_model_sinewave.m,v 1.4 2011/04/29 08:04:07 hewitson Exp $';
  
end