nargin

System object の入力引数の数

構文

numInputs = nargin(obj)

nargin

説明

numInputs = nargin(obj) は、obj アルゴリズム定義に必要な入力引数の数を返します。この関数は、一般の nargin 関数の System object™ 拡張です。

nargin は、現在実行中の System object の呼び出し時に指定された入力引数の数を返します。この構文は、System object の本体にだけ使用してください。

例

可変サイズの入力での System object に対する nargin の使用

この例では、System object の AddUp が可変サイズの入力である場合の nargin からの出力を説明します。

marker System object は次のように定義されます。

classdef AddUp < matlab.System
   methods(Access = protected)
        function y = stepImpl(obj,u,varargin)
            % Implement algorithm.
            y = u + sum([varargin{:}]);
        end     
    end
end

オブジェクトを作成し nargin を呼び出します。

total = AddUp();
nargin(total)

ans = 
    -2

入力引数

obj — System object

System object

クエリする System object。

出力引数

numInputs — 入力数

整数

この引数は、System object の呼び出しに必要な入力の数を表します。

出力が非負である場合、入力の数は、オブジェクトが使用中の間は変更できません。

出力が負である場合、入力の数は呼び出しごとに変更できます。この状況は、System object が getNumInputsImpl をオーバーライドせず、stepImpl のシグネチャに varargin が含まれている場合に発生します。

バージョン履歴

R2018a で導入

参考

nargin | nargout | getNumInputsImpl | getNumInputs

トピック

• 入力数の変更