EntityReference Class Reference

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 this reference with another lexicographically. More...
bool	operator!= (const EntityReference &other) const
	Compare this reference with another lexicographically. More...
bool	operator< (const EntityReference &other) const
	Compare this reference with another lexicographically. More...
bool	operator<= (const EntityReference &other) const
	Compare this reference with another lexicographically. More...
bool	operator> (const EntityReference &other) const
	Compare this reference with another lexicographically. More...
bool	operator>= (const EntityReference &other) const
	Compare this reference with another lexicographically. More...
const Str &	toString () const

Detailed Description

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.

Warning

EntityReferences should not be constructed directly by the host, use the creation methods of the manager instead, createEntityReference and createEntityReferenceIfValid.

Note that this does not preclude the possibility of a malformed reference. See kInvalidEntityReference.

Constructor & Destructor Documentation

EntityReference ( Str  entityReferenceString )

inlineexplicit

Constructs an EntityReference around the supplied string.

Member Function Documentation

bool operator!= ( const EntityReference &  other ) const

inline

Compare this reference with another lexicographically.

Parameters

other

Entity reference to compare against.

Returns

true if contents are not equal, false otherwise.

bool operator< ( const EntityReference &  other ) const

inline

Compare this reference with another lexicographically.

Parameters

other

Entity reference to compare against.

Returns

true if this reference is less than other, false otherwise.

bool operator<= ( const EntityReference &  other ) const

inline

Compare this reference with another lexicographically.

Parameters

other

Entity reference to compare against.

Returns

true if this reference is less or equal than other, false otherwise.

bool operator== ( const EntityReference &  other ) const

inline

Compare this reference with another lexicographically.

Parameters

other

Entity reference to compare against.

Returns

true if contents are equal, false otherwise.

bool operator> ( const EntityReference &  other ) const

inline

Compare this reference with another lexicographically.

Parameters

other

Entity reference to compare against.

Returns

true if this reference is greater than other, false otherwise.

bool operator>= ( const EntityReference &  other ) const

inline

Compare this reference with another lexicographically.

Parameters

other

Entity reference to compare against.

Returns

true if this reference is greater or equal than other, false otherwise.

const Str& toString ( ) const

inline

Returns

The string representation of this entity reference.

---

The documentation for this class was generated from the following file:

• /src/src/openassetio-core/include/openassetio/EntityReference.hpp