OpenAssetIO [beta]
An abstract API for generalising interactions between a host application and an asset management system
|
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. More...
#include <EntityReference.hpp>
Public Member Functions | |
EntityReference (Str entityReferenceString) | |
Constructs an EntityReference around the supplied string. More... | |
bool | operator== (const EntityReference &other) const |
Compare the contents of this reference with another for equality. More... | |
const Str & | toString () const |
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.
It can be assumed that if isEntityReferenceString is true for a given string, then an EntityReference can be constructed from that string.
Note that this does not preclude the possibility of a malformed reference. See kInvalidEntityReference.
|
inlineexplicit |
Constructs an EntityReference around the supplied string.
|
inline |
Compare the contents of this reference with another for equality.
other | Entity refernce to compare against. |
true
if contents are equal, false
otherwise.
|
inline |
Copyright 2013-2023 The Foundry Visionmongers Ltd. OpenAssetIO is released under the Apache 2.0 License