view scripts/control/system/sysgettype.m @ 5307:4c8a2e4e0717

[project @ 2005-04-26 19:24:27 by jwe]
author jwe
date Tue, 26 Apr 2005 19:24:47 +0000
parents bdbee5282954
children 93c65f2a5668
line wrap: on
line source

## Copyright (C) 1998 Auburn University.  All rights reserved.
##
## This file is part of Octave.
##
## Octave 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 2, or (at your option) any
## later version.
##
## Octave 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 Octave; see the file COPYING.  If not, write to the Free
## Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
## 02110-1301 USA.

## -*- texinfo -*-
## @deftypefn {Function File} {} sysgettype (@var{sys})
## return the initial system type of the system
##
## @strong{Input}
## @table @var
## @item sys
## System data structure.
## @end table
##
## @strong{Output}
## @table @var
## @item systype
## String indicating how the structure was initially
## constructed. Values: @code{"ss"}, @code{"zp"}, or @code{"tf"}.
## @end table
##
## @acronym{FIR} initialized systems return @code{systype="tf"}.
## @end deftypefn

function systype = sysgettype (sys)

  if (! isstruct (sys))
    error ("sysgettype: input sys is not a structure");
  endif

  typestr = {"tf", "zp", "ss"};
  systype = typestr{ sys.sys(1) + 1};

endfunction