OpenTAP 9.25
API Reference
Public Member Functions | Properties | List of all members
OpenTap.Package.Installation Class Reference

Represents an OpenTAP installation in a specific directory. More...

Public Member Functions

 Installation (string directory)
 Initialize an instance of a OpenTAP installation. More...
 
void Invalidate ()
 Invalidate cached package list. This should only be called if changes have been made to the installation by circumventing OpenTAP APIs.
 
PackageDef FindPackageContainingFile (string file)
 Get the installed package which provides the file specified by the string. If multiple packages provide the file the package is chosen arbitrarily. More...
 
PackageDef FindPackageContainingType (ITypeData pluginType)
 Get the installed package which provides the type specified by pluginType. If multiple packages provide the type the package is chosen arbitrarily. More...
 
List< PackageDefGetPackages ()
 Returns package definition list of installed packages in the TAP installation defined in the constructor, and system-wide packages. Results are cached, and Invalidate must be called if changes to the installation are made by circumventing OpenTAP APIs.
 
PackageDef FindPackage (string name)
 Finds an installed package by name. Returns null if the package was not found.
 
PackageDef GetOpenTapPackage ()
 Get a package definition of OpenTAP engine. More...
 

Properties

string Directory [get]
 Path to the installation
 
string Id [get]
 Get a unique identifier for this OpenTAP installation. The identifier is computed from hashing a uniquely generated machine ID combined with the hash of the installation directory.
 
bool IsInstallationFolder [get]
 Check if it is an installation folder that contains packages other than system-wide packages
 
static Installation Current [get]
 Get the installation of the currently running tap process
 
Action PackageChangedEvent
 Event invoked when a package is installed/uninstalled from this installation.
 

Detailed Description

Represents an OpenTAP installation in a specific directory.

Constructor & Destructor Documentation

◆ Installation()

OpenTap.Package.Installation.Installation ( string  directory)
inline

Initialize an instance of a OpenTAP installation.

Parameters
directory

Member Function Documentation

◆ FindPackageContainingFile()

PackageDef OpenTap.Package.Installation.FindPackageContainingFile ( string  file)
inline

Get the installed package which provides the file specified by the string. If multiple packages provide the file the package is chosen arbitrarily.

Parameters
fileAn absolute or relative path to the file
Returns

◆ FindPackageContainingType()

PackageDef OpenTap.Package.Installation.FindPackageContainingType ( ITypeData  pluginType)
inline

Get the installed package which provides the type specified by pluginType. If multiple packages provide the type the package is chosen arbitrarily.

Parameters
pluginType
Returns

◆ GetOpenTapPackage()

PackageDef OpenTap.Package.Installation.GetOpenTapPackage ( )
inline

Get a package definition of OpenTAP engine.

Returns

OpenTAP 9.25 API built Tue Aug 6 2024 07:49:25