source: Roms_tools/mexcdf/mexnc/tests/test_inq.m @ 1

function test_inq ( ncfile )
% TEST_INQ
%
% Tests number of dimensions, variables, global attributes, record dimension for
% foo.nc.  Also tests helper routines, "nc_inq_ndims", "nc_inq_nvars", "nc_inq_ncatts".
%
% Tests bad ncid as well.
%
% Test 1:  Normal retrieval
% Test 2:  Bad ncid.
% Test 3:  Empty set ncid.
% Test 4:  Non numeric ncid
% Test 5:  INQ_NDIMS normal retrieval
% Test 6:  INQ_NDIMS Bad ncid.
% Test 7:  INQ_NDIMS Empty set ncid.
% Test 8:  INQ_NDIMS Non numeric ncid
% Test 9:  INQ_NVARS normal retrieval
% Test 10:  INQ_NVARS Bad ncid.
% Test 11:  INQ_NVARS Empty set ncid.
% Test 12:  INQ_NVARS Non numeric ncid
% Test 13:  INQ_NATTS normal retrieval
% Test 14:  INQ_NATTS Bad ncid.
% Test 15:  INQ_NATTS Empty set ncid.
% Test 16:  INQ_NATTS Non numeric ncid

if nargin == 0
        ncfile = 'foo.nc';
end
create_testfile ( ncfile );

test_001 ( ncfile );
test_002 ( ncfile );
test_003 ( ncfile );
test_004 ( ncfile );
test_005 ( ncfile );
test_006 ( ncfile );
test_007 ( ncfile );
test_008 ( ncfile );
test_009 ( ncfile );
test_010 ( ncfile );
test_011 ( ncfile );
test_012 ( ncfile );
test_013 ( ncfile );
test_014 ( ncfile );
test_015 ( ncfile );
test_016 ( ncfile );

fprintf ( 1, 'INQ succeeded\n' );
fprintf ( 1, 'INQ_NDIMS succeeded\n' );
fprintf ( 1, 'INQ_NVARS succeeded\n' );
fprintf ( 1, 'INQ_NATTS succeeded\n' );


function create_testfile ( ncfile )

%
% Create a netcdf file with
[ncid, status] = mexnc ( 'create', ncfile, nc_clobber_mode );
if status, error ( mexnc(strerror,status) ), end


%
% DIMDEF
[xdimid, status] = mexnc ( 'def_dim', ncid, 'x', 20 );
if status, error ( mexnc(strerror,status) ), end

[ydimid, status] = mexnc ( 'def_dim', ncid, 'y', 24 );
if status, error ( mexnc(strerror,status) ), end

[zdimid, status] = mexnc ( 'def_dim', ncid, 'z', 32 );
if status, error ( mexnc(strerror,status) ), end


%
% VARDEF
[xdvarid, status] = mexnc ( 'def_var', ncid, 'x_double', 'double', 1, xdimid );
if status, error ( mexnc(strerror,status) ), end

[xmvarid, status] = mexnc ( 'def_var', ncid, 'xm_double', 'double', 3, [zdimid ydimid xdimid] );
if status, error ( mexnc(strerror,status) ), end

[xfvarid, status] = mexnc ( 'def_var', ncid, 'x_float', 'float', 1, xdimid );
if status, error ( mexnc(strerror,status) ), end

[xmvarid, status] = mexnc ( 'def_var', ncid, 'xm_float', 'float', 3, [zdimid ydimid xdimid] );
if status, error ( mexnc(strerror,status) ), end

[xlvarid, status] = mexnc ( 'def_var', ncid, 'x_long', 'long', 1, xdimid );
if status, error ( mexnc(strerror,status) ), end

[xmvarid, status] = mexnc ( 'def_var', ncid, 'xm_int', 'long', 3, [zdimid ydimid xdimid] );
if status, error ( mexnc(strerror,status) ), end

[x_short_varid, status] = mexnc ( 'def_var', ncid, 'x_short', 'short', 1, xdimid );
if status, error ( mexnc(strerror,status) ), end

[xmvarid, status] = mexnc ( 'def_var', ncid, 'xm_short', 'short', 3, [zdimid ydimid xdimid] );
if status, error ( mexnc(strerror,status) ), end

[x_byte_varid, status] = mexnc ( 'def_var', ncid, 'x_byte', 'byte', 1, xdimid );
if status, error ( mexnc(strerror,status) ), end

[xmvarid, status] = mexnc ( 'def_var', ncid, 'xm_byte', 'byte', 3, [zdimid ydimid xdimid] );
if status, error ( mexnc(strerror,status) ), end

[x_char_varid, status] = mexnc ( 'def_var', ncid, 'x_char', 'char', 1, xdimid );
if status, error ( mexnc(strerror,status) ), end

[xmvarid, status] = mexnc ( 'def_var', ncid, 'xm_char', 'char', 3, [zdimid ydimid xdimid] );
if status, error ( mexnc(strerror,status) ), end



%
% Define some attributes
attvalue = 'this is a test';
attlen = length(attvalue);
status = mexnc ( 'put_att_text', ncid, -1, 'test_global_attributes', 'char', attlen, attvalue );
if status, error ( mexnc(strerror,status) ), end


[status] = mexnc ( 'enddef', ncid );
if status, error ( mexnc(strerror,status) ), end

return









function test_001 ( ncfile )

[ncid, status] = mexnc('open', ncfile, nc_nowrite_mode );
if status, error ( mexnc(strerror,status) ), end

[ndims, nvars, natts, recdim, status] = mexnc('INQ', ncid);
if status, error ( mexnc(strerror,status) ), end

if ndims ~= 3
        msg = sprintf ( 'INQ returned %d dimensions when there should only have been 1\n', ndims );
        error ( msg );
end

if nvars ~= 12 
        msg = sprintf ( 'INQ returned %d variables when there should have been 12\n', nvars );
        error ( msg );
end

if natts ~= 1
        msg = sprintf ( 'INQ returned %d attributes when there should have been 1\n', natts );
        error ( msg );
end

if recdim ~= -1
        msg = sprintf ( 'INQ returned an unlimited dimension when there should not have been one\n' );
        error ( msg );
end

mexnc ( 'close', ncid );

return







function test_002 ( ncfile )

[ncid, status] = mexnc('open', ncfile, nc_nowrite_mode );
if status, error ( mexnc(strerror,status) ), end


% Test 2:  Bad ncid.
testid = 'Test 2';
[ndims, nvars, natts, recdim, status] = mexnc('INQ', -2000);
if ( status == 0 )
        err_msg = sprintf ( '%s:  %s:  Succeeded when it should have failed\n', mfilename, testid );
        error ( err_msg );
end

mexnc ( 'close', ncid );

return








function test_003 ( ncfile )

[ncid, status] = mexnc('open', ncfile, nc_nowrite_mode );
if status, error ( mexnc(strerror,status) ), end

% Test 3:  Empty set ncid.
testid = 'Test 3';
try
        [ndims, nvars, natts, recdim, status] = mexnc('INQ', [] );
        err_msg = sprintf ( '%s:  %s:  Succeeded when it should have failed\n', mfilename, testid );
        error ( err_msg );
end

mexnc ( 'close', ncid );

return





function test_004 ( ncfile )

[ncid, status] = mexnc('open', ncfile, nc_nowrite_mode );
if status, error ( mexnc(strerror,status) ), end

% Test 4:  Non numeric ncid
testid = 'Test 4';
try
        [ndims, nvars, natts, recdim, status] = mexnc('INQ', 'blah' );
        err_msg = sprintf ( '%s:  %s:  Succeeded when it should have failed\n', mfilename, testid );
        error ( err_msg );
end

mexnc ( 'close', ncid );

return






function test_005 ( ncfile )

[ncid, status] = mexnc('open', ncfile, nc_nowrite_mode );
if status, error ( mexnc(strerror,status) ), end

[ndims, status] = mexnc('INQ_NDIMS', ncid);
if ( status ~= 0 )
        msg = sprintf ( '%s:  %s:  ''%s''', mfilename, testid, mexnc ( 'strerror', status ) );
        error ( msg );
end

if ndims ~= 3
        msg = sprintf ( 'INQ_NDIMS returned %d dimensions when there should only have been 1\n', ndims );
        error ( msg );
end

mexnc ( 'close', ncid );

return







function test_006 ( ncfile )

[ncid, status] = mexnc('open', ncfile, nc_nowrite_mode );
if status, error ( mexnc(strerror,status) ), end


testid = 'Test 6';
[ndims, status] = mexnc('INQ_NDIMS', -2000);
if ( status == 0 )
        msg = sprintf ( '%s:  %s:  ''%s''', mfilename, testid, mexnc ( 'strerror', status ) );
        error ( msg );
end

mexnc ( 'close', ncid );

return













function test_007 ( ncfile )

[ncid, status] = mexnc('open', ncfile, nc_nowrite_mode );
if status, error ( mexnc(strerror,status) ), end

testid = 'Test 7';
try
        [ndims, status] = mexnc('INQ_NDIMS', [] );
        err_msg = sprintf ( '%s:  %s:  Succeeded when it should have failed\n', mfilename, testid );
        error ( err_msg );
end

mexnc ( 'close', ncid );

return










function test_008 ( ncfile )

[ncid, status] = mexnc('open', ncfile, nc_nowrite_mode );
if status, error ( mexnc(strerror,status) ), end

testid = 'Test 8';
try
        [ndims, status] = mexnc('INQ_NDIMS', 'blah' );
        err_msg = sprintf ( '%s:  %s:  Succeeded when it should have failed\n', mfilename, testid );
        error ( err_msg );
end

mexnc ( 'close', ncid );

return









function test_009 ( ncfile )

[ncid, status] = mexnc('open', ncfile, nc_nowrite_mode );
if status, error ( mexnc(strerror,status) ), end

% Test 9:  INQ_NVARS Normal retrieval
testid = 'Test 9';
[nvars, status] = mexnc('INQ_NVARS', ncid);
if ( status ~= 0 )
        msg = sprintf ( '%s:  %s:  ''%s''', mfilename, testid, mexnc ( 'strerror', status ) );
        error ( msg );
end

if nvars ~= 12 
        msg = sprintf ( 'INQ_NVARS returned %d dimensions when there should have been 12\n', nvars );
        error ( msg );
end

mexnc ( 'close', ncid );

return







function test_010 ( ncfile )

[ncid, status] = mexnc('open', ncfile, nc_nowrite_mode );
if status, error ( mexnc(strerror,status) ), end

% Test 10:  INQ_NVARS Bad ncid.
testid = 'Test 10';
[nvars, status] = mexnc('INQ_NVARS', -2000);
if ( status == 0 )
        msg = sprintf ( '%s:  %s:  ''%s''', mfilename, testid, mexnc ( 'strerror', status ) );
        error ( msg );
end

mexnc ( 'close', ncid );

return













function test_011 ( ncfile )

[ncid, status] = mexnc('open', ncfile, nc_nowrite_mode );
if status, error ( mexnc(strerror,status) ), end

% Test 11:  INQ_NVARS Empty set ncid.
testid = 'Test 11';
try
        [nvars, status] = mexnc('INQ_NVARS', [] );
        err_msg = sprintf ( '%s:  %s:  Succeeded when it should have failed\n', mfilename, testid );
        error ( err_msg );
end

mexnc ( 'close', ncid );

return





function test_012 ( ncfile )

[ncid, status] = mexnc('open', ncfile, nc_nowrite_mode );
if status, error ( mexnc(strerror,status) ), end

% Test 12:  Non numeric ncid
testid = 'Test 12';
try
        [nvars, status] = mexnc('INQ_NVARS', 'blah' );
        err_msg = sprintf ( '%s:  %s:  Succeeded when it should have failed\n', mfilename, testid );
        error ( err_msg );
end

mexnc ( 'close', ncid );

return











function test_013 ( ncfile )

[ncid, status] = mexnc('open', ncfile, nc_nowrite_mode );
if status, error ( mexnc(strerror,status) ), end

% Test 13:  INQ_NATTS Normal retrieval
testid = 'Test 13';
[natts, status] = mexnc('INQ_NATTS', ncid);
if ( status ~= 0 )
        msg = sprintf ( '%s:  %s:  ''%s''', mfilename, testid, mexnc ( 'strerror', status ) );
        error ( msg );
end

if natts ~= 1 
        msg = sprintf ( 'INQ_NATTS returned %d attributes when there should have been 1\n', natts );
        error ( msg );
end

mexnc ( 'close', ncid );

return








function test_014 ( ncfile )

[ncid, status] = mexnc('open', ncfile, nc_nowrite_mode );
if status, error ( mexnc(strerror,status) ), end

% Test 14:  INQ_NATTS Bad ncid.
testid = 'Test 14';
[natts, status] = mexnc('INQ_NATTS', -2000);
if ( status == 0 )
        msg = sprintf ( '%s:  %s:  ''%s''', mfilename, testid, mexnc ( 'strerror', status ) );
        error ( msg );
end

mexnc ( 'close', ncid );

return









function test_015 ( ncfile )

[ncid, status] = mexnc('open', ncfile, nc_nowrite_mode );
if status, error ( mexnc(strerror,status) ), end

% Test 15:  INQ_NATTS Empty set ncid.
testid = 'Test 15';
try
        [natts, status] = mexnc('INQ_NATTS', [] );
        err_msg = sprintf ( '%s:  %s:  Succeeded when it should have failed\n', mfilename, testid );
        error ( err_msg );
end

mexnc ( 'close', ncid );

return






function test_016 ( ncfile )

[ncid, status] = mexnc('open', ncfile, nc_nowrite_mode );
if status, error ( mexnc(strerror,status) ), end


testid = 'Test 16';
try
        [natts, status] = mexnc('INQ_NATTS', 'blah' );
        err_msg = sprintf ( '%s:  %s:  Succeeded when it should have failed\n', mfilename, testid );
        error ( err_msg );
end

mexnc ( 'close', ncid );

return