HPS::ImageDefinition Class Reference

#include <hps.h>

Inheritance diagram for HPS::ImageDefinition:
HPS::Definition HPS::Object

Public Member Functions

 ImageDefinition ()
 
 ImageDefinition (Definition const &in_that)
 
 ImageDefinition (ImageDefinition const &in_that)
 
 ImageDefinition (ImageDefinition &&in_that)
 
HPS::Type ObjectType () const
 
ImageDefinitionoperator= (ImageDefinition const &in_that)
 
ImageDefinitionoperator= (ImageDefinition &&in_that)
 
void Set (ImageKit const &in_kit)
 
void Show (ImageKit &out_kit) const
 
- Public Member Functions inherited from HPS::Definition
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
 
Definitionoperator= (Definition const &in_that)
 
Definitionoperator= (Definition &&in_that)
 
bool operator== (Definition const &in_that) const
 
PortfolioKey Owner () const
 
void Undefine ()
 
- Public Member Functions inherited from HPS::Object
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)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
virtual HPS::Type Type () const
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::ImageDefinition
 
- Static Public Attributes inherited from HPS::Definition
static const HPS::Type staticType = HPS::Type::Definition
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS::Object
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

◆ ImageDefinition() [1/4]

HPS::ImageDefinition::ImageDefinition ( )

The default constructor creates an uninitialized ImageDefinition object. The Type() function will return Type::None.

◆ ImageDefinition() [2/4]

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_thatThe source Definition to copy.

◆ ImageDefinition() [3/4]

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_thatThe source ImageDefinition to copy.

◆ ImageDefinition() [4/4]

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_thatAn rvalue reference to an ImageDefinition to take the impl from.

Member Function Documentation

◆ ObjectType()

HPS::Type HPS::ImageDefinition::ObjectType ( ) const
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.

◆ operator=() [1/2]

ImageDefinition& HPS::ImageDefinition::operator= ( ImageDefinition const &  in_that)

Associate this ImageDefinition with the same underlying impl as the source ImageDefinition.

Parameters
in_thatThe source ImageDefinition for the assignment.
Returns
A reference to this ImageDefinition.

◆ operator=() [2/2]

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_thatAn rvalue reference to an ImageDefinition to take the impl from.
Returns
A reference to this ImageDefinition.

◆ Set()

void HPS::ImageDefinition::Set ( ImageKit const &  in_kit)

Redefine the image for this ImageDefinition.

Parameters
in_kitThe new image for this ImageDefinition.

◆ Show()

void HPS::ImageDefinition::Show ( ImageKit out_kit) const

Shows the image for this ImageDefinition.

Parameters
out_kitThe image for this ImageDefinition.

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