Public Member Functions | Protected Member Functions | List of all members
HPS.ImageDefinition Class Reference

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

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

Public Member Functions

override void Dispose ()
 
 ImageDefinition ()
 The default constructor creates an uninitialized ImageDefinition object. The Type() function will return Type::None. More...
 
 ImageDefinition (HPS.Definition 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. More...
 
 ImageDefinition (HPS.ImageDefinition 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. More...
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More...
 
void Set (HPS.ImageKit in_kit)
 Redefine the image for this ImageDefinition. More...
 
void Show (out HPS.ImageKit out_kit)
 Shows the image for this ImageDefinition. More...
 
- Public Member Functions inherited from HPS.Definition
 Definition ()
 The default constructor creates an uninitialized Definition object. The Type() function will return Type::None. More...
 
 Definition (HPS.Definition in_that)
 The copy constructor creates a Definition object that shares the underlying smart-pointer of the source Definition. More...
 
void Undefine ()
 Removes this definition from the owning portfolio. More...
 
HPS.PortfolioKey Owner ()
 Get the portfolio that owns this Definition. More...
 
string Name ()
 Get the name given to this Definition when it was defined. More...
 
virtual void Assign (HPS.Definition in_that)
 Associate this Definition with the same underlying impl as the source Definition. More...
 
override bool Equals (System.Object obj)
 
override int GetHashCode ()
 
bool Equals (HPS.Definition in_that)
 Check if the source Definition is equivalent to this Definition. More...
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
 Object (HPS.Object in_that)
 The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More...
 
HPS.Type Type ()
 This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More...
 
virtual bool Empty ()
 Indicates whether this object has any values set on it. More...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More...
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS.Definition
static bool operator== (HPS.Definition a, HPS.Definition b)
 
static bool operator!= (HPS.Definition a, HPS.Definition b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
HandleRef cptr
 
HandleRef scptr
 
bool cMemOwn
 

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 ( )
inline

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

HPS.ImageDefinition.ImageDefinition ( HPS.Definition  in_that)
inline

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 <ref refid="class_h_p_s_1_1_definition" kindref="compound">Definition</ref> to copy.
HPS.ImageDefinition.ImageDefinition ( HPS.ImageDefinition  in_that)
inline

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 <ref refid="class_h_p_s_1_1_definition" kindref="compound">Definition</ref> to copy.

Member Function Documentation

override HPS.Type HPS.ImageDefinition.ObjectType ( )
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.Definition.

void HPS.ImageDefinition.Set ( HPS.ImageKit  in_kit)
inline

Redefine the image for this ImageDefinition.

Parameters
in_kitThe new image for this <ref refid="class_h_p_s_1_1_image_definition" kindref="compound">ImageDefinition</ref>.
void HPS.ImageDefinition.Show ( out HPS.ImageKit  out_kit)
inline

Shows the image for this ImageDefinition.

Parameters
out_kitThe image for this <ref refid="class_h_p_s_1_1_image_definition" kindref="compound">ImageDefinition</ref>.

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