matRad_getEnvironment

Purpose ^

matRad function to get the software environment matRad is running on

Synopsis ^

function [env, versionString] = matRad_getEnvironment()

Description ^

 matRad function to get the software environment matRad is running on
 
 call
   [env, versionString] = matRad_getEnvironment()

 input
   -
   
 output
   env:            outputs either 'MATLAB' or 'OCTAVE' as string
   versionString:  returns the version number as string

 References
   -

 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

 Copyright 2017 the matRad development team. 
 
 This file is part of the matRad project. It is subject to the license 
 terms in the LICENSE file found in the top-level directory of this 
 distribution and at https://github.com/e0404/matRad/LICENSES.txt. No part 
 of the matRad project, including this file, may be copied, modified, 
 propagated, or distributed except according to the terms contained in the 
 LICENSE file.

 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

Cross-reference information ^

This function calls: This function is called by:

Source code ^

0001 function [env, versionString] = matRad_getEnvironment()
0002 % matRad function to get the software environment matRad is running on
0003 %
0004 % call
0005 %   [env, versionString] = matRad_getEnvironment()
0006 %
0007 % input
0008 %   -
0009 %
0010 % output
0011 %   env:            outputs either 'MATLAB' or 'OCTAVE' as string
0012 %   versionString:  returns the version number as string
0013 %
0014 % References
0015 %   -
0016 %
0017 % %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0018 %
0019 % Copyright 2017 the matRad development team.
0020 %
0021 % This file is part of the matRad project. It is subject to the license
0022 % terms in the LICENSE file found in the top-level directory of this
0023 % distribution and at https://github.com/e0404/matRad/LICENSES.txt. No part
0024 % of the matRad project, including this file, may be copied, modified,
0025 % propagated, or distributed except according to the terms contained in the
0026 % LICENSE file.
0027 %
0028 % %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0029 
0030 % reduce runtime if function is called multiple times
0031 
0032 matRad_cfg = MatRad_Config.instance();
0033 
0034 env = matRad_cfg.env;
0035 versionString = matRad_cfg.envVersion;
0036 
0037 end
0038 
0039

| Generated by m2html © 2005