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

The Definition class is a smart pointer to a database object. It is the base class for all definition objects. 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

override void Dispose ()
 
 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...
 
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 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 that)
 
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...
 

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
HandleRef cptr
 
HandleRef scptr
 
bool cMemOwn
 

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

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

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

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

Parameters
in_thatThe source Definition to copy.

Member Function Documentation

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

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

Parameters
in_thatThe source Definition for the assignment.
bool HPS.Definition.Equals ( HPS.Definition  in_that)
inline

Check if the source Definition is equivalent to this Definition.

Parameters
in_thatThe source Definition to compare to this Definition.
Returns
true if the objects are equivalent, false otherwise.
string HPS.Definition.Name ( )
inline

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

Returns
UTF8-encoded name of this Definition.
override HPS.Type HPS.Definition.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.Object.

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

HPS.PortfolioKey HPS.Definition.Owner ( )
inline

Get the portfolio that owns this Definition.

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

Removes this definition from the owning portfolio.


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