OpenMS
Loading...
Searching...
No Matches
System

Very basic functionality like file system or stopwatch. More...

Classes

class  ConsoleUtils
 Singleton helper for terminal-width-aware string wrapping in TOPP-tool console output. More...
 
class  OpenMSOSInfo
 Snapshot of the runtime operating system: name, version, and pointer-width architecture. More...
 
struct  OpenMSBuildInfo
 Build-configuration accessors: build type, OpenMP availability, and OpenMP thread count. More...
 
class  File
 Basic file handling operations. More...
 
class  JavaInfo
 Detect Java and retrieve information. More...
 
class  Network
 Convenience wrapper around NetworkGetRequest for one-shot HTTP/HTTPS downloads. More...
 
class  NetworkGetRequest
 Synchronous HTTP GET request backed by libcurl. More...
 
class  PythonInfo
 Detect Python and retrieve information. More...
 
class  RWrapper
 R-Wrapper Class. More...
 
class  StopWatch
 This class is used to determine the current process' CPU (user and/or kernel) and wall time. More...
 
class  UpdateCheck
 Helper Functions to perform an update query to the OpenMS REST server. More...
 

Typedefs

typedef std::map< std::string, Internal::ToolDescriptionToolListType
 Registry of TOPP tools and their (TOPPAS / KNIME) categories.
 

Detailed Description

Very basic functionality like file system or stopwatch.

Typedef Documentation

◆ ToolListType

typedef std::map<std::string, Internal::ToolDescription> ToolListType

Registry of TOPP tools and their (TOPPAS / KNIME) categories.

Tool descriptions come from two layers:

  1. A hard-coded list of official TOPP tools maintained in ToolHandler::getTOPPToolList (one Internal::ToolDescription per tool, including its KNIME-style category string). This is what ToolHandler::getTOPPToolList, ToolHandler::getTypes and ToolHandler::getCategory consult.
  2. Optional internal-tool .ttd config files loaded lazily by getInternalToolConfigFiles_ from [OpenMS]/share/TOOLS/INTERNAL plus an OS-specific subdirectory (.../LINUX on Mac and Linux, .../WINDOWS on Windows). The search path can be augmented via the OPENMS_TTD_INTERNAL_PATH environment variable.
Note
ToolHandler::getExternalToolsPath returns the [OpenMS]/share/TOOLS/EXTERNAL location, but this directory is not currently scanned for .ttd entries by this class — only the TOOLS/INTERNAL tree is loaded.

Used by TOPPAS for the visual workflow editor's tool palette and by the TOPP runtime to look up tools and their categories.

Note
The hard-coded list (rather than driving it from files at load time) is a deliberate trade-off: adding a tool requires a recompile anyway, and parsing all share files on library load would slow start-up. Map: TOPP tool name -> its Internal::ToolDescription (category + per-type configuration).