Signal__set_unit.m

Go to the documentation of this file.

%This file is part of TEAP.
%
%TEAP 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.
%
%TEAP 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 TEAP.  If not, see <http://www.gnu.org/licenses/>.
% 
%> @file Signal__set_unit.m
%> @brief Sets the unit of a signal
% 
%> @param Signal the signal you want to add the unit to
%> @param unitStr the unit name (ex: 'Ohm');
% 
%> @retval Signal the newly modified signal
% 
%> @author Copyright Frank Villaro-Dixon, 2014
function Signal = Signal__set_unit(Signal, unitStr)
 
if(nargin ~= 2)
    error('Usage: Signal = Signal__set_unit(Signal, unitStr)');
end
 
if(nargout ~= 1)
    error('You need to retrieve the function''s result. Else, it''s useless !');
end
 
Signal__assert_mine(Signal);
 
Signal.unit = unitStr;
 
%!error(Signal__set_unit())
%!error(Signal__set_unit(42))
%!error(Signal__set_unit(42, 43))
%!error(Signal__set_unit(Signal__new_empty(), 'ohm')) %result not retrieved
%!assert(Signal__get_unit(Signal__set_unit(Signal__new_empty(), 'ohm')), 'ohm')