Modelica.Utilities.System

Information

This package contains functions to interact with the environment.

Extends from Modelica.Icons.Package (Icon for standard packages).

Package Content

Name	Description
getWorkDirectory	Get full path name of work directory
setWorkDirectory	Set work directory
getEnvironmentVariable	Get content of environment variable
setEnvironmentVariable	Set content of local environment variable
command	Execute command in default shell
exit	Terminate execution of Modelica environment

Modelica.Utilities.System.getWorkDirectory

Information

Extends from Modelica.Icons.Function (Icon for functions).

Outputs

Type	Name	Description
String	directory	Full path name of work directory

Modelica definition

function getWorkDirectory "Get full path name of work directory"
  extends Modelica.Icons.Function;
  output String directory "Full path name of work directory";
// POSIX function "getcwd"
  external "C" directory = ModelicaInternal_getcwd(0);
end getWorkDirectory;

Modelica.Utilities.System.setWorkDirectory

Information

Extends from Modelica.Icons.Function (Icon for functions).

Inputs

Type	Name	Default	Description
String	directory		New work directory

Modelica definition

function setWorkDirectory "Set work directory"
  extends Modelica.Icons.Function;
  input String directory "New work directory";
// POSIX function "chdir"
external "C" ModelicaInternal_chdir(directory);
end setWorkDirectory;

Modelica.Utilities.System.getEnvironmentVariable

Information

Extends from Modelica.Icons.Function (Icon for functions).

Inputs

Type	Name	Default	Description
String	name		Name of environment variable
Boolean	convertToSlash	false	True, if native directory separators in 'result' shall be changed to '/'

Outputs

Type	Name	Description
String	content	Content of environment variable (empty, if not existent)
Boolean	exist	= true, if environment variable exists; = false, if it does not exist

Modelica definition

function getEnvironmentVariable "Get content of environment variable"
  extends Modelica.Icons.Function;
  input String name "Name of environment variable";
  input Boolean convertToSlash =  false 
    "True, if native directory separators in 'result' shall be changed to '/'";
  output String content 
    "Content of environment variable (empty, if not existent)";
  output Boolean exist 
    "= true, if environment variable exists; = false, if it does not exist";
  external "C" ModelicaInternal_getenv(name, convertToSlash, content, exist);
end getEnvironmentVariable;

Modelica.Utilities.System.setEnvironmentVariable

Information

Extends from Modelica.Icons.Function (Icon for functions).

Inputs

Type	Name	Default	Description
String	name		Name of environment variable
String	content		Value of the environment variable
Boolean	convertFromSlash	false	True, if '/' in content shall be changed to the native directory separator

Modelica definition

function setEnvironmentVariable 
  "Set content of local environment variable"
  extends Modelica.Icons.Function;
  input String name "Name of environment variable";
  input String content "Value of the environment variable";
  input Boolean convertFromSlash =  false 
    "True, if '/' in content shall be changed to the native directory separator";
external "C" ModelicaInternal_setenv(name, content, convertFromSlash);
end setEnvironmentVariable;

Modelica.Utilities.System.command

Information

Extends from Modelica.Icons.Function (Icon for functions).

Inputs

Type	Name	Default	Description
String	string		String to be passed to shell

Outputs

Type	Name	Description
Integer	result	Return value from command (depends on environment)

Modelica definition

function command "Execute command in default shell"
  extends Modelica.Icons.Function;
  input String string "String to be passed to shell";
  output Integer result "Return value from command (depends on environment)";
  external "C" result = system(string);
end command;

Modelica.Utilities.System.exit

Information

Inputs

Type	Name	Default	Description
Integer	status	0	Result to be returned by environment (0 means success)

Modelica definition

function exit "Terminate execution of Modelica environment"
  extends Modelica.Icons.Function;
  input Integer status=0 
    "Result to be returned by environment (0 means success)";
  external "C" ModelicaInternal_exit(status);

end exit;