OpenAssetIO
An abstract API for generalising interactions between a host application and an asset management system
|
CBatchElementError | Structure representing per-element batch operation errors |
CManager::BatchElementErrorPolicyTag | Tag dispatching structure intended for use selecting appropriate overloads for various error-handling modes |
CContext | The Context object is used to convey information about the calling environment to a manager |
CCppPluginSystem | Generic plugin system for C++ plugins |
▼CCppPluginSystemPlugin | The base class that defines a plugin of the C++ plugin system |
CCppPluginSystemManagerPlugin | Base class to be subclassed by plugins binding a host to an Asset Management System |
CEntityReference | EntityReference forms a strongly typed wrapper around arbitrary strings to ensure they have been validated by the target manager before being used as an Entity Reference in the various entity related API calls |
CEntityReferencePager | The EntityReferencePager allows for the retrieval and traversal of large datasets in a paginated manner |
CEntityReferencePagerInterface | Deals with the retrieval of paginated data from the backend at the behest of the host |
CManager::BatchElementErrorPolicyTag::Exception | Exception policy overloads, when used in a batch context, will emit an exception at the first encountered errors::BatchElementError provided by the ManagerInterface |
CFileUrlPathConverter | Utility class for converting between file system paths and file URLs |
Chash< openassetio::EntityReference > | |
CHost | The Host object represents the tool or application that created a session with OpenAssetIO, and wants to query or store information within a manager |
CHostInterface | The HostInterface provides an abstraction of the 'caller of the API' |
CHostSession | The HostSession is a manager-facing class that represents a discrete API session started by a host in order to communicate with a manager |
▼Clist | |
CTest_getWithRelationship_All.weaklist | Built-in list type does not support weakref, so create this shim |
▼CLoggerInterface | An abstract base class that defines the receiving interface for log messages generated a manager or the API middleware |
CConsoleLogger | A logger that sends messages to the console (stderr) |
CSeverityFilter | The SeverityFilter is a wrapper for a logger that drops messages below a requested severity |
CManager | The Manager is the Host facing representation of an Asset Management System |
CManagerFactory::ManagerDetail | Simple struct containing the default configuration details of a potential manager implementation |
CManagerFactory | The ManagerFactory is the primary mechanism for querying for available managers and constructing a Manager |
▼CManagerImplementationFactoryInterface | Manager Factories are responsible for instantiating classes that derive from openassetio::v1::managerApi::ManagerInterface for use within a host |
CCppPluginSystemManagerImplementationFactory | A factory to manage CppPluginSystemManagerPlugin derived plugins |
CHybridPluginSystemManagerImplementationFactory | The hybrid plugin system composes one or more child plugin systems, and abstracts away routing API calls based on priority and capability |
CManagerInterface | This Interface binds a Asset Management System into OpenAssetIO |
CManagerStateBase | An abstract base for all Manager State objects |
CMapper | String substitution methods and lookups to determine the correct terminology for the supplied manager |
▼Cobject | |
CPythonPluginSystem | Loads Python Packages, using entry point discovery or from a custom search path |
CPythonPluginSystemPlugin | The base class that defines a plugin of the plugin system |
▼Cruntime_error | |
▼COpenAssetIOException | Exception base for all OpenAssetIO exceptions |
CBatchElementException | Exception thrown when a BatchElementError is converted |
▼CInputValidationException | Thrown whenever the input to a public API function is invalid for the requested operation |
CConfigurationException | A special case of InputValidationException for cases where the input comes from external config, rather than function arguments |
CNotImplementedException | Thrown whenever a procedure must abort due to not being implemented |
CUnhandledException | Exceptions emitted from manager plugins that are not handled will be converted to this type and re-thrown when the exception passes through the OpenAssetIO middleware |
▼CTestCase | |
CFixtureAugmentedTestCase | Base test case class that all test classes must inherit from |
CTraitsData | A transport-level container for data exchange between a host and a manager |
CManager::BatchElementErrorPolicyTag::Variant | Variant policy overloads, when used in a batch context, will be exhaustive for all elements in the batch, a variant result containing either a trait::TraitsData or errors::BatchElementError will be provided for each EntityReference provided as an argument to the operation |
▼CFixtureAugmentedTestCase | |
CTest_createChildState | Tests that the createChildState method is implemented if createState has been implemented to return a custom state object |
CTest_displayName | Check plugin's implementation of managerApi.ManagerInterface.displayName |
CTest_entityExists | Check plugin's implementation of managerApi.ManagerInterface.entityExists |
CTest_entityTraits | Check plugin's implementation of managerApi.ManagerInterface.entityTraits |
CTest_getWithRelationship_All | Check plugin's implementation of managerApi.ManagerInterface.getWithRelationship[s] |
CTest_identifier | Check plugin's implementation of managerApi.ManagerInterface.identifier |
CTest_info | Check plugin's implementation of managerApi.ManagerInterface.info |
CTest_initialize | Check plugin's implementation of managerApi.ManagerInterface.initialize |
CTest_isEntityReferenceString | Check plugin's implementation of managerApi.ManagerInterface.isEntityReferenceString |
CTest_managementPolicy | Check plugin's implementation of managerApi.ManagerInterface.managementPolicy |
CTest_persistenceTokenForState | Tests that the persistenceTokenForState method is implemented if createState has been implemented to return a custom state object |
CTest_preflight | Check a plugin's implementation of managerApi.ManagerInterface.preflight |
CTest_register | Check a plugin's implementation of managerApi.ManagerInterface.register |
CTest_resolve | Check plugin's implementation of managerApi.ManagerInterface.resolve |
CTest_settings | Check plugin's implementation of managerApi.ManagerInterface.settings |
CTest_stateFromPersistenceToken | Tests that the persistenceTokenForState method is implemented if createState has been implemented to return a custom state object |
CTest_updateTerminology | Check plugin's implementation of managerApi.ManagerInterface.updateTerminology |
▼CManagerImplementationFactoryInterface | |
CPythonPluginSystemManagerImplementationFactory | A Factory to manage openassetio.pluginSystem.PythonPluginSystemManagerPlugin derived plugins |
▼CPythonPluginSystemPlugin | |
CPythonPluginSystemManagerPlugin | This class represents the various derived classes that make up the binding to a Asset Management System |
Copyright 2013-2023 The Foundry Visionmongers Ltd. OpenAssetIO is released under the Apache 2.0 License