Main Content

isOutputFixedSize

Check if outputs of a System object are fixed size

collapse all in page

    Syntax

    [flag_1, flag_2, ..., flag_n] = isOutputFixedSize(obj)

    Description

    [flag_1, flag_2, ..., flag_n] = isOutputFixedSize(obj) returns whether each output of a System object™ is fixed size.

    example

    Examples

    collapse all

    Call isOutputFixedSize to check if the outputs of a System object are fixed size.

    Consider a System object object defined as,

    classdef UnitDelay < matlab.System
% UnitDelayNondirect Delay input by one time step

properties(DiscreteState)
        State
        Step
end

    methods(Access = protected)
        function resetImpl(obj)
            obj.State = 0; % Initialize states
            obj.Step = 1;
        end
       
        function [y1, y2] = stepImpl(obj,u)
            y1 = obj.State; % Output current state
            y2 = obj.Step; 
            
            obj.State = u;
            obj.Step = obj.Step + 1; 
        end

        function [sz1, sz2] = getOutputSizeImpl(obj)
            sz1 = [1,1]; % Specify size of output port
            sz2 = [1,1]; 
        end

        function [flag1, flag2] = isOutputFixedSizeImpl(obj)
            flag1 = true; % Specify if output is fized size
            flag2 = true;
        end

        function [c1, c2] = getOutputDataTypeImpl(obj)
            c1 = 'double'; % Specify output datatype
            c2 = 'double'; 
        end 

        function [c1, c2] = isOutputComplexImpl(obj)
            c1 = false;   % Specify if output is complex
            c2 = false; 
        end
    end

end

    Create an instance of the System object and provide it with an input.

    a = UnitDelay();
[out, step] = a(1);

    Call isOutputFixedSize to check if the outputs of the System object are fixed size.

    [flag_1, flag_2] = isOutputFixedSize(a);

    Input Arguments

    collapse all

    System object handle used to access properties, states, and methods specific to the object. The number of outputs must match the number of outputs returned by the getNumOutputs method.

    Output Arguments

    collapse all

    Logical, scalar value indicating whether the specific output port is fixed size. true is returned if output is fixed size and false is returned if output is variable sized.

    Version History

    Introduced in R2012a

    See Also