openslide_get_property_value.m

function [propertyValue] = ...
    openslide_get_property_value(openslidePointer, propertyName)
% OPENSLIDE_GET_PROPERTY_VALUE Returns the value of a single property from the openslide object
%
% [propertyValue] = openslide_get_property_value(openslidePointer, propertyName)
%
% INPUT ARGUMENTS
% openslidePointer          - Pointer to the openslide object to read properties from
% propertyName              - Property to retrieve value for
%
% OPTIONAL INPUT ARGUMENTS
% N/A
%
% OUTPUT
% propertyValue             - Value of specified property name. Note that
%                             this value might have to be type casted 
%                             before it can be used.

% Copyright (c) 2016 Daniel Forsberg
% danne.forsberg@outlook.com
%
% This program is free software: you can redistribute it and/or modify
% it under the terms of the GNU General Public License as published by
% the Free Software Foundation, either version 3 of the License, or
% (at your option) any later version.
%
% This program is distributed in the hope that it will be useful,
% but WITHOUT ANY WARRANTY; without even the implied warranty of
% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
% GNU General Public License for more details.
%
% You should have received a copy of the GNU General Public License
% along with this program.  If not, see <http://www.gnu.org/licenses/>.

%%

% Make sure library for openslide is loaded
if ~libisloaded('openslidelib')
    warning('OpenSlide library has not been loaded, attempting to load')
    openslide_load_library();
end

% Check property name
if iscell(propertyName)
    warning(['Provided propertyName argument is a cell object. ',...
        'Attempts to use data from the first cell as propertyName argument']);
    propertyName = propertyName{1};
end
if ~ischar(propertyName)
    error('openslide:openslide_get_property_value',...
        'Provided propertyName argument is not a valid char array.\n')
end

% See if provided property name is in the list of available properties
propertyNames = openslide_get_property_names(openslidePointer);
if sum(strcmpi(propertyName,propertyNames)) == 0
    error('openslide:openslide_get_property_value',...
        'Provided propertyName argument is not a valid property name for this openslide object.\n')
end

% Read property value
[propertyValue, ~] = calllib('openslidelib','openslide_get_property_value',...
    openslidePointer,propertyName);

% Check for errors
[errorMessage] = openslide_get_error(openslidePointer);

% Terminate if an error was returned
if ~isempty(errorMessage)
    error('openslide:openslide_get_property_value',errorMessage)
end