OpenAssetIO
An abstract API for generalising interactions between a host application and an asset management system
Public Types | Public Member Functions | List of all members
CppPluginSystemPlugin Class Referenceabstract

The base class that defines a plugin of the C++ plugin system. More...

#include <CppPluginSystemPlugin.hpp>

Inheritance diagram for CppPluginSystemPlugin:
Inheritance graph
[legend]

Public Types

using Ptr = CppPluginSystemPluginPtr
 
using ConstPtr = CppPluginSystemPluginConstPtr
 

Public Member Functions

virtual ~CppPluginSystemPlugin ()
 Defaulted virtual destructor. More...
 
virtual openassetio::Identifier identifier () const =0
 Get the unique identifier of the plugin. More...
 

Detailed Description

The base class that defines a plugin of the C++ plugin system.

See also
CppPluginSystemManagerPlugin for a more concrete use case.

Member Typedef Documentation

using ConstPtr = CppPluginSystemPluginConstPtr
using Ptr = CppPluginSystemPluginPtr

Constructor & Destructor Documentation

virtual ~CppPluginSystemPlugin ( )
virtual

Defaulted virtual destructor.

Member Function Documentation

virtual openassetio::Identifier identifier ( ) const
pure virtual

Get the unique identifier of the plugin.

The identifier should use only alpha-numeric characters and '.', '_' or '-'. For example:

"org.openassetio.test.manager"

Returns
Plugin's unique identifier.
The documentation for this class was generated from the following file:
  • /src/src/openassetio-core/include/openassetio/pluginSystem/CppPluginSystemPlugin.hpp