ImageDefinition

class HPS::ImageDefinition : public HPS::Definition 

The ImageDefinition class is a smart pointer to a database object. It is a handle to an image defined within a portolfio.

Public Functions

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

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.

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.

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.

inline virtual HPS::Type ObjectType() const

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.

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.

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.

void Set(ImageKit const &in_kit)

Redefine the image for this ImageDefinition.

Parameters: in_kit – The new image for this ImageDefinition.

void Show(ImageKit &out_kit) const

Shows the image for this ImageDefinition.

Parameters: out_kit – The image for this ImageDefinition.

~ImageDefinition()

Public Static Attributes

static const HPS::Type staticType = HPS::Type::ImageDefinition