getNumOutputsImpl

Class: matlab.System

Number of outputs from System object

Syntax

num = getNumOutputsImpl(obj)


Description

num = getNumOutputsImpl(obj) returns the number of outputs expected from the System object™.

If the signature of stepImpl or outputImpl does not include varargout, the System object can determine the number of outputs from the method signature. In this case, you do not need to implement the getNumOutputsImpl method.

If the signature of stepImpl or outputImpl does include varargout, you can implement the getNumOutputsImpl method in your class definition file to determine the number of outputs. You can use nargout in the stepImpl method to get the number of outputs the object was called with.

Method Authoring Tips

• You must set Access = protected for this method.

• You cannot modify any properties in this method.

• If you set the return argument, num, from an object property, that object property must have the Nontunable attribute.

Input Arguments

obj — System object

System object

System object handle used to access properties, states, and methods specific to the object. If your getNumOutputsImpl method does not use the object, you can replace this input with ~.

Output Arguments

num — Number of outputs

integer

Number of outputs from the specified object, returned as an integer.

Examples

Set Number of Outputs

Specify the number of outputs (2, in this case) returned from the object.

methods (Access = protected)
   function num = getNumOutputsImpl(~)
      num = 2;
   end
end

Set Number of Outputs to Zero

Specify that the object does not return any outputs.

methods (Access = protected)
   function num = getNumOutputsImpl(~)
      num = 0;
   end
end

Use nargout for Variable Number of Outputs

Use nargout in the stepImpl method when you have a variable number of outputs and want to generate code.

methods (Access = protected)
   function varargout = stepImpl(~,varargin)
      for i = 1:nargout
         varargout{i} = varargin{i}+1;
      end
   end
end

Version History

Introduced in R2011b