#include <hps.h>

Public Member Functions | |
virtual void | Assign (Definition const &in_that) |
Definition () | |
Definition (Definition const &in_that) | |
Definition (Definition &&in_that) | |
bool | Equals (Definition const &in_that) const |
UTF8 | Name () const |
HPS::Type | ObjectType () const |
bool | operator!= (Definition const &in_that) const |
Definition & | operator= (Definition const &in_that) |
Definition & | operator= (Definition &&in_that) |
bool | operator== (Definition const &in_that) const |
PortfolioKey | Owner () const |
void | Undefine () |
![]() | |
virtual bool | Empty () const |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
bool | HasType (HPS::Type in_mask) const |
Object (Object const &that) | |
Object (Object &&in_that) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual void | Reset () |
virtual HPS::Type | Type () const |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Detailed Description
The Definition class is a smart pointer to a database object. It is the base class for all definition objects.
Constructor & Destructor Documentation
HPS::Definition::Definition | ( | ) |
The default constructor creates an uninitialized Definition object. The Type() function will return Type::None.
HPS::Definition::Definition | ( | Definition const & | in_that | ) |
The copy constructor creates a Definition object that shares the underlying smart-pointer of the source Definition.
- Parameters
-
in_that The source Definition to copy.
HPS::Definition::Definition | ( | Definition && | in_that | ) |
The move constructor creates a Definition by transferring the underlying impl of the rvalue reference to this Definition thereby avoiding a copy and allocation.
- Parameters
-
in_that An rvalue reference to a Definition to take the impl from.
Member Function Documentation
|
virtual |
Associate this Definition with the same underlying impl as the source Definition.
- Parameters
-
in_that The source Definition for the assignment.
bool HPS::Definition::Equals | ( | Definition const & | in_that | ) | const |
Check if the source Definition is equivalent to this Definition.
- Parameters
-
in_that The source Definition to compare to this Definition.
- Returns
- true if the objects are equivalent, false otherwise.
UTF8 HPS::Definition::Name | ( | ) | const |
Get the name given to this Definition when it was defined.
- Returns
- UTF8-encoded name of this Definition.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS::Object.
Reimplemented in HPS::ShapeDefinition, HPS::LinePatternDefinition, HPS::MaterialPaletteDefinition, HPS::NamedStyleDefinition, HPS::CubeMapDefinition, HPS::ImageDefinition, HPS::TextureDefinition, and HPS::GlyphDefinition.
bool HPS::Definition::operator!= | ( | Definition const & | in_that | ) | const |
Check if the source Definition is not equivalent to this Definition.
- Parameters
-
in_that The source Definition to compare to this Definition.
- Returns
- true if the objects are not equivalent, false otherwise.
Definition& HPS::Definition::operator= | ( | Definition const & | in_that | ) |
Associate this Definition with the same underlying impl as the source Definition.
- Parameters
-
in_that The source Definition for the assignment.
- Returns
- A reference to this Definition.
Definition& HPS::Definition::operator= | ( | Definition && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this Definition thereby avoiding a copy.
- Parameters
-
in_that An rvalue reference to a Definition to take the impl from.
- Returns
- A reference to this Definition.
bool HPS::Definition::operator== | ( | Definition const & | in_that | ) | const |
Check if the source Definition is equivalent to this Definition.
- Parameters
-
in_that The source Definition to compare to this Definition.
- Returns
- true if the objects are equivalent, false otherwise.
PortfolioKey HPS::Definition::Owner | ( | ) | const |
Get the portfolio that owns this Definition.
- Returns
- The portfolio that owns this Definition.
void HPS::Definition::Undefine | ( | ) |
Removes this definition from the owning portfolio.
The documentation for this class was generated from the following file:
- include/hps.h