< Home

< Table of Contents

REFERENCE MANUAL

ImageDefinition Class Reference

#include <hps.h>

Inheritance diagram for ImageDefinition:
Definition Object

Public Member Functions

 ImageDefinition ()
 
 ImageDefinition (Definition const &in_that)
 
 ImageDefinition (ImageDefinition const &in_that)
 
 ImageDefinition (ImageDefinition &&in_that)
 
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 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 Object
virtual bool Empty () const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (Type in_mask) const
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
Type Type () const
 

Additional Inherited Members

- Static Public Member Functions inherited from 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::ImageDefinition ( )

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

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::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::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

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

ImageDefinition& 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.
ImageDefinition& 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.
void ImageDefinition::Set ( ImageKit const &  in_kit)

Redefine the image for this ImageDefinition.

Parameters
in_kitThe new image for this ImageDefinition.
void 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: