Function input argument block - defining multiple valid classes for input data.

Question

John 2024-7-2，19:31

0
链接

此问题的直接链接

https://ww2.mathworks.cn/matlabcentral/answers/2133911-function-input-argument-block-defining-multiple-valid-classes-for-input-data

评论： John 2024-7-3，11:58

Hello,

I am attempting to create a function which will accept multiple different object classes as input. I want to accept: char, string, and datetime using the arguments block. Currently I only have it accepting the input data as char and string, for example:

function [datetimeout, datetimeopt, errortype] = DateTimeCheck(data, type, output)
arguments
    data {mustBeText}
    type {mustBeText}
    output {mustBeText} = 'datetime'
end
%rest of the function%%
end

I was able to find a workaround by creating and calling another function. In the main function the syntax would be as follows:

function [datetimeout, datetimeopt, errortype] = DateTimeCheck(data, type, output)
arguments
    data {mustbedatetimecheck}
    type {mustBeText}
    output {mustBeText} = 'datetime'
end
%%rest of the function%%
end

Then in the second function:

function mustbedatetimecheck(a)
    if ~(isa(a,'datetime') || isa(a,'char') || isa(a, 'string'))
        eidType = 'mustbedatetimecheck:nottextordatetime';
        msgType = 'Input must be either a text input or datetime.';
        error(eidType,msgType)
    end
end

I'd like to consolidate these two functions into one function so I do not have the need for multiple files. I understand it's possible to complete this using isa statements after the arguments block, however this is not as concice as having the statement within the arguments block.

Thank you in advance for your time and help.

0 个评论
显示 -2更早的评论隐藏 -2更早的评论

请先登录，再进行评论。

请先登录，再回答此问题。

Answer 1

Stephen23 2024-7-2，20:29

1
链接

此回答的直接链接

https://ww2.mathworks.cn/matlabcentral/answers/2133911-function-input-argument-block-defining-multiple-valid-classes-for-input-data#answer_1480141

移动：Stephen23 2024-7-2，20:35

在 MATLAB Online 中打开

"I'd like to consolidate these two functions into one function so I do not have the need for multiple files."

You do not need multiple files: simply define mustbedatetimecheck as a local function in the same file:

https://www.mathworks.com/help/matlab/matlab_prog/local-functions.html

DateTimeCheck(datetime('now'), 'hello','world') % ok
DateTimeCheck("String input",  'hello','world') % ok
DateTimeCheck(cell(1,2),       'hello','world') % error!
Error using solution>DateTimeCheck (line 7)
Invalid argument at position 1. Input must be either a text input or datetime.
function DateTimeCheck(data, type, output)
arguments
    data {mustbedatetimecheck}
    type {mustBeText}
    output {mustBeText} = 'datetime'
end
%%rest of the function%%
end
function mustbedatetimecheck(a)
assert(isa(a,'datetime') || isa(a,'char') || isa(a,'string'),...
    'mustbedatetimecheck:nottextordatetime',...
    'Input must be either a text input or datetime.')
end

1 个评论
显示 -1更早的评论隐藏 -1更早的评论

John 2024-7-3，11:58

Thank you so much, I had already nested functions but got the error "Calling nested functions is not supported in arguments block." I didn't realize local functions were a thing/different than nested functions. Thanks and have a good day

请先登录，再进行评论。