getNumInputs

Number of inputs required to call the System object

Syntax

num = getNumInputs(obj)

Description

num = getNumInputs(obj) returns an integer, num, representing the number of inputs (not counting the object itself) that you must use when calling the object. This value changes when you alter properties that turn inputs on or off.

If the object is a source object, num equals zero.

Examples

Get Number of Inputs for an Object

Create a Counter object and set a property.

obj = Counter;
obj.UseIncrement = false

obj = 
  Counter with properties:

    UseIncrement: false
    UseWrapValue: true
      StartValue: 1
       Increment: 1
       WrapValue: 10

Query the number of inputs and outputs needed to call the object.

in = getNumInputs(obj)

in = 1

out = getNumOutputs(obj)

out = 1

Input Arguments

obj — System object™ to query

System object

System object to query for the number of inputs.

Output Arguments

num — Number of inputs

nonnegative integer

The number of inputs required to call the object, returned as an integer.

Extended Capabilities

C/C++ Code Generation

Generate C and C++ code using MATLAB® Coder™.

For details, see System Objects in MATLAB Code Generation (MATLAB Coder).

Version History

Introduced in R2010a