home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / octa21eb.zip / octave / SCRIPTS.ZIP / scripts.fat / control / sysgetsg.m < prev    next >
Text File  |  1999-04-29  |  4KB  |  108 lines
  1. # Copyright (C) 1998 A. Scottedward Hodel 
  2. #
  3. # This file is part of Octave. 
  4. #
  5. # Octave is free software; you can redistribute it and/or modify it 
  6. # under the terms of the GNU General Public License as published by the 
  7. # Free Software Foundation; either version 2, or (at your option) any 
  8. # later version. 
  9. # 
  10. # Octave is distributed in the hope that it will be useful, but WITHOUT 
  11. # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 
  12. # FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License 
  13. # for more details.
  14. # 
  15. # You should have received a copy of the GNU General Public License 
  16. # along with Octave; see the file COPYING.  If not, write to the Free 
  17. # Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. 
  18.  
  19. function [stname,inname,outname,yd] = sysgetsg(sys,sigid,signum,strflg)
  20.   # [stname,inname,outname,yd] = sysgetsg(sys)
  21.   # -or- siglist = sysgetsg(sys,sigid)
  22.   # -or- signame = sysgetsg(sys,sigid,signum{,strflg})
  23.   # Get signal names from a system
  24.   # inputs:
  25.   #    sys: system data structure for the state space system
  26.   #    sigid: signal id: string, must be one of:
  27.   #      "in": input signals
  28.   #     "out": output signals
  29.   #      "st": state signals
  30.   #      "yd": value of yd
  31.   #    signum: index of signal  (e.g., out4 = sysgetsg(sys,"out",4)
  32.   #            sets out4 to the name of the 4th output)
  33.   #    strflg: flag to return a string instead of a list;
  34.   #           strflg = 0: (default) return a list
  35.   #           strflg = 1: return a string; exits with an error if 
  36.   #                       length(signum) > 1
  37.   # outputs:
  38.   #   if sigid is not specified:
  39.   #      stname, inname, outname: signal names (lists);  names of states,
  40.   #          inputs, and outputs, respectively
  41.   #      yd: binary vector; yd(ii) is nonzero if output y is discrete.
  42.   #   if sigid is specified but signum is not specified:
  43.   #      stname: 
  44.   #          is the list of state names (sigid = "st")
  45.   #          is the list input names (sigid = "in")
  46.   #          is the list output names (sigid = "out")
  47.   #          is the logical vector indicate discrete outputs (sigid = "yd")
  48.   #   if all three input arguments are specified:
  49.   #          is the list of specified state, input, or output name(s) 
  50.   #          (sigid = "st", "in", or "out").  
  51.   #          is a logical flag indicating if output signum is continous
  52.   #               (sigval=0) or discrete (sigval = 1)
  53.   # 
  54.  
  55.   # Adapted from ss2sys
  56.  
  57.   if(nargin < 1 | nargin > 4 | nargout > 4)
  58.     usage("[stname{,inname,outname,yd}] = sysgetsg(sys{,sigid,signum})")
  59.   elseif(nargin > 1 & nargout > 1)
  60.     usage("sig = sysgetsg(sys,sigid{,signum,strflg})")
  61.   elseif( ! is_struct(sys) )
  62.     error("input argument must be a system data structure");
  63.   endif
  64.   if(nargin < 4)  strflg = 0; endif
  65.   if(nargin == 1)
  66.     sys = sysupdat(sys,"ss");        #make sure ss is up to date
  67.     stname = sysgetsg(sys,"st");
  68.     inname = sysgetsg(sys,"in");
  69.     outname = sysgetsg(sys,"out");
  70.     yd = sysgetsg(sys,"yd");
  71.   elseif(!(isstr(sigid) & min(size(sigid)) == 1))
  72.     error(sprintf("sigid(%dx%d) must be a string)",rows(sigid),columns(sigid)));
  73.   else
  74.     if(strcmp("st",sigid))         stname = sys.stname;
  75.     elseif(strcmp("in",sigid))     stname = sys.inname;
  76.     elseif(strcmp("out",sigid))    stname = sys.outname;
  77.     elseif(strcmp("yd",sigid))     stname = vec(sys.yd)';
  78.     else
  79.       error(sprintf("sigid=%s must be \"st\", \"in\", \"out\", or \"yd\"", ...
  80.     sigid));
  81.     endif
  82.     if(nargin >= 3)
  83.       if(signum > length(stname))
  84.         error(sprintf("sysgetsg(sys,\"%s\",%d):only %d entries.\n", ...
  85.       sigid,signum, rows(stname)));
  86.       else
  87.         if(!is_scal(strflg)) 
  88.           error("strflg must be a scalar");
  89.         endif
  90.         switch(strflg)
  91.         case(0),
  92.           stname = stname(signum);
  93.         case(1),
  94.           if(length(signum) > 1)
  95.             error("strflg=1, length(signum) = %d",length(signum));
  96.           endif
  97.           stname = nth(stname,signum);
  98.         otherwise,
  99.           error("Illegal value of strflg=%e",strflg);
  100.         endswitch
  101.         
  102.       endif
  103.     endif
  104.   endif
  105.  
  106. endfunction
  107.  
  108.