vtkPVStandardPaths Namespace Reference

Functions
VTK_ABI_NAMESPACE_BEGIN VTKREMOTINGAPPLICATION_EXPORT std::vector< std::string >	GetSystemDirectories ()
	Return system data directories, depending on operating system: More...
VTKREMOTINGAPPLICATION_EXPORT std::vector< std::string >	GetInstallDirectories ()
	Returns paths relative to install directory. More...
VTKREMOTINGAPPLICATION_EXPORT std::string	GetUserSettingsDirectory ()
	Get directory for user settings file. More...
VTKREMOTINGAPPLICATION_EXPORT std::string	GetUserSettingsFilePath ()
	Get file path for the user settings file. More...

Function Documentation

GetSystemDirectories()

VTK_ABI_NAMESPACE_BEGIN VTKREMOTINGAPPLICATION_EXPORT std::vector<std::string> vtkPVStandardPaths::GetSystemDirectories

(

)

Return system data directories, depending on operating system:

• Windows: Uses COMMON_APPDATA:
• MacOS - linux: Honorates XDG_DATA_DIRS, falling back to /usr/share and /usr/local/share. https://specifications.freedesktop.org/basedir-spec/0.8/

GetInstallDirectories()

VTKREMOTINGAPPLICATION_EXPORT std::vector<std::string> vtkPVStandardPaths::GetInstallDirectories

(

)

Returns paths relative to install directory.

• the exectutable dir
• the <install> dir: the executable dir or its parent if executable is under a "bin" dir.
• <install>/lib <install>/share/paraview-<version>
• MacOs specific:
  • package <root>: <install>/../../..
  • lib, lib-paraview-<version>, Support as <root> subdirs.

GetUserSettingsDirectory()

VTKREMOTINGAPPLICATION_EXPORT std::string vtkPVStandardPaths::GetUserSettingsDirectory

(

)

Get directory for user settings file.

The last character is always the file path separator appropriate for the system.

• Windows: honors APPDATA environment variable
• linux/MacOs: honors xdg convention:
  • $XDG_DATA_HOME environment first
  • $HOME/.config/<organization-name> then see: https://specifications.freedesktop.org/basedir-spec/0.8/

GetUserSettingsFilePath()

VTKREMOTINGAPPLICATION_EXPORT std::string vtkPVStandardPaths::GetUserSettingsFilePath

(

)

Get file path for the user settings file.

Construct server settings file path: <GetUserSettingsDirectory()>/<GetApplicationName()>-UserSettings.json

See also

vtkInitializationHelper::GetApplicationName()