dynare/matlab/reports/@report/report.m

76 lines
2.2 KiB
Matlab
Raw Normal View History

2013-02-15 16:52:35 +01:00
function o = report(varargin)
%function o = report(varargin)
2013-02-12 14:23:41 +01:00
% Report Class Constructor
%
% INPUTS
2013-03-13 18:02:29 +01:00
% varargin 0 args : empty report object
% 1 arg : must be report object (return a copy of arg)
% > 1 args: option/value pairs (see structure below for options)
2013-02-12 14:23:41 +01:00
%
% OUTPUTS
2013-03-13 18:02:29 +01:00
% o [report] report object
2013-02-12 14:23:41 +01:00
%
% SPECIAL REQUIREMENTS
% none
% Copyright (C) 2013 Dynare Team
%
% This file is part of Dynare.
%
% Dynare is free software: you can redistribute it and/or modify
% it under the terms of the GNU General Public License as published by
% the Free Software Foundation, either version 3 of the License, or
% (at your option) any later version.
%
% Dynare is distributed in the hope that it will be useful,
% but WITHOUT ANY WARRANTY; without even the implied warranty of
% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
% GNU General Public License for more details.
%
% You should have received a copy of the GNU General Public License
% along with Dynare. If not, see <http://www.gnu.org/licenses/>.
% default values
2013-02-15 16:52:35 +01:00
o = struct;
o.title = '';
o.orientation = 'portrait';
o.paper = 'a4';
2013-03-07 15:45:53 +01:00
o.margin = '2.5cm';
2013-02-15 16:52:35 +01:00
o.pages = pages();
o.filename = 'report.tex';
o.config = '';
2013-03-07 15:45:53 +01:00
o.showdate = true;
2013-02-12 14:23:41 +01:00
if nargin == 1
2013-03-08 19:25:24 +01:00
assert(isa(varargin{1}, 'report'), ['@report.report: with one arg, ' ...
2013-02-15 16:52:35 +01:00
'you must pass a report object']);
r = varargin{1};
return;
elseif nargin > 1
if round(nargin/2) ~= nargin/2
2013-03-08 19:25:24 +01:00
error(['@report.report: options must be supplied in name/value ' ...
'pairs']);
2013-02-12 14:23:41 +01:00
end
2013-02-15 16:52:35 +01:00
optNames = lower(fieldnames(o));
% overwrite default values
for pair = reshape(varargin, 2, [])
field = lower(pair{1});
if any(strmatch(field, optNames, 'exact'))
if strcmp(field, 'orientation')
validateOrientation(pair{2});
elseif strcmp(field, 'paper')
validatePaper(pair{2});
end
o.(field) = pair{2};
2013-02-12 14:23:41 +01:00
else
2013-03-08 19:25:24 +01:00
error('@report.report: %s is not a recognized option.', ...
2013-02-15 16:52:35 +01:00
field);
2013-02-12 14:23:41 +01:00
end
2013-02-15 16:52:35 +01:00
end
2013-02-12 14:23:41 +01:00
end
% Create report object
2013-02-15 16:52:35 +01:00
o = class(o, 'report');
2013-02-12 14:23:41 +01:00
end