< Home

< Table of Contents

REFERENCE MANUAL

HPS.Definition Class Reference

The Definition class is a smart pointer to a database object. More...

Inheritance diagram for HPS.Definition:
HPS.Object HPS.CubeMapDefinition HPS.GlyphDefinition HPS.ImageDefinition HPS.LinePatternDefinition HPS.MaterialPaletteDefinition HPS.NamedStyleDefinition HPS.ShaderDefinition HPS.TextureDefinition

Public Member Functions

virtual void Assign (HPS.Definition in_that)
 Associate this Definition with the same underlying impl as the source Definition. More...
 
 Definition ()
 The default constructor creates an uninitialized Definition object. More...
 
 Definition (HPS.Definition in_that)
 The copy constructor creates a Definition object that shares the underlying smart-pointer of the source Definition. More...
 
override void Dispose ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Definition in_that)
 Check if the source Definition is equivalent to this Definition. More...
 
override int GetHashCode ()
 
string Name ()
 Get the name given to this Definition when it was defined. More...
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. More...
 
HPS.PortfolioKey Owner ()
 Get the portfolio that owns this Definition. More...
 
void Undefine ()
 Removes this definition from the owning portfolio. More...
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 Indicates whether this object has any values set on it. More...
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 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...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
HPS.Type Type ()
 This function returns the true type of the underlying object. More...
 

Static Public Member Functions

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 Member Functions

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

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 
HandleRef scptr
 

Detailed Description

The Definition class is a smart pointer to a database object.

It is the base class for all definition objects.

Constructor & Destructor Documentation

HPS.Definition.Definition ( )

The default constructor creates an uninitialized Definition object.

The Type() function will return Type::None.

HPS.Definition.Definition ( HPS.Definition  in_that)

The copy constructor creates a Definition object that shares the underlying smart-pointer of the source Definition.

Parameters
in_thatThe source <ref refid="class_h_p_s_1_1_definition" kindref="compound">Definition</ref> to copy.

Member Function Documentation

virtual void HPS.Definition.Assign ( HPS.Definition  in_that)
virtual

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

Parameters
in_thatThe source <ref refid="class_h_p_s_1_1_definition" kindref="compound">Definition</ref> for the assignment.
bool HPS.Definition.Equals ( HPS.Definition  in_that)

Check if the source Definition is equivalent to this Definition.

Parameters
in_thatThe source <ref refid="class_h_p_s_1_1_definition" kindref="compound">Definition</ref> to compare to this <ref refid="class_h_p_s_1_1_definition" kindref="compound">Definition</ref>.
Returns
true if the objects are equivalent, false otherwise.
string HPS.Definition.Name ( )

Get the name given to this Definition when it was defined.

Returns
UTF8-encoded name of this Definition.
override HPS.Type HPS.Definition.ObjectType ( )
virtual

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.Object.

Reimplemented in HPS.GlyphDefinition, HPS.ImageDefinition, HPS.LinePatternDefinition, HPS.MaterialPaletteDefinition, HPS.NamedStyleDefinition, HPS.ShaderDefinition, and HPS.TextureDefinition.

HPS.PortfolioKey HPS.Definition.Owner ( )

Get the portfolio that owns this Definition.

Returns
The portfolio that owns this Definition.
void HPS.Definition.Undefine ( )

Removes this definition from the owning portfolio.


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