#include <hps.h>

Public Member Functions | |
ImageDefinition () | |
ImageDefinition (Definition const &in_that) | |
ImageDefinition (ImageDefinition const &in_that) | |
ImageDefinition (ImageDefinition &&in_that) | |
HPS::Type | ObjectType () const |
ImageDefinition & | operator= (ImageDefinition const &in_that) |
ImageDefinition & | operator= (ImageDefinition &&in_that) |
void | Set (ImageKit const &in_kit) |
void | Show (ImageKit &out_kit) const |
![]() | |
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 |
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 |
Static Public Attributes | |
static const HPS::Type | staticType = HPS::Type::ImageDefinition |
![]() | |
static const HPS::Type | staticType = HPS::Type::Definition |
![]() | |
static const HPS::Type | staticType = HPS::Type::None |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Detailed Description
The ImageDefinition class is a smart pointer to a database object. It is a handle to an image defined within a portolfio.
Constructor & Destructor Documentation
HPS::ImageDefinition::ImageDefinition | ( | ) |
The default constructor creates an uninitialized ImageDefinition object. The Type() function will return Type::None.
HPS::ImageDefinition::ImageDefinition | ( | Definition const & | in_that | ) |
This constructor creates an ImageDefinition object that shares the underlying smart-pointer of the source Definition. The copy will only be successful if the source definition is really an upcast of an image definition. Otherwise the copy will fail and the resulting ImageDefinition will be invalid.
- Parameters
-
in_that The source Definition to copy.
HPS::ImageDefinition::ImageDefinition | ( | ImageDefinition const & | in_that | ) |
The copy constructor creates an ImageDefinition object that shares the underlying smart-pointer of the source ImageDefinition.
- Parameters
-
in_that The source ImageDefinition to copy.
HPS::ImageDefinition::ImageDefinition | ( | ImageDefinition && | in_that | ) |
The move constructor creates an ImageDefinition by transferring the underlying impl of the rvalue reference to this ImageDefinition thereby avoiding a copy and allocation.
- Parameters
-
in_that An rvalue reference to an ImageDefinition to take the impl from.
Member Function Documentation
|
inlinevirtual |
This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS::Definition.
ImageDefinition& HPS::ImageDefinition::operator= | ( | ImageDefinition const & | in_that | ) |
Associate this ImageDefinition with the same underlying impl as the source ImageDefinition.
- Parameters
-
in_that The source ImageDefinition for the assignment.
- Returns
- A reference to this ImageDefinition.
ImageDefinition& HPS::ImageDefinition::operator= | ( | ImageDefinition && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this ImageDefinition thereby avoiding a copy.
- Parameters
-
in_that An rvalue reference to an ImageDefinition to take the impl from.
- Returns
- A reference to this ImageDefinition.
void HPS::ImageDefinition::Set | ( | ImageKit const & | in_kit | ) |
Redefine the image for this ImageDefinition.
- Parameters
-
in_kit The new image for this ImageDefinition.
void HPS::ImageDefinition::Show | ( | ImageKit & | out_kit | ) | const |
Shows the image for this ImageDefinition.
- Parameters
-
out_kit The image for this ImageDefinition.
The documentation for this class was generated from the following file:
- include/hps.h