More...

Inheritance diagram for HPS.TreeContext:
HPS.Object

Public Member Functions

override void Dispose ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.TreeContext in_that)
 Check if the source TreeContext is the same as this TreeContext. More...
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 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). More...
 
 TreeContext (bool in_create)
 The default constructor creates a new TreeContext object. More...
 
 TreeContext ()
 The default constructor creates a new TreeContext object. More...
 
 TreeContext (HPS.TreeContext in_that)
 The copy constructor shares a TreeContext object. 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 the object's database handle, which can be used to determine which instance of a class the object is. For example, controls are simply aliases for segment keys that group related functions. Therefore, a SegmentKey and all of its controls would return the same instance id. Different keys and controls will return the same value if they are backed by the same database resource. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object that)
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
virtual 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...
 

Static Public Member Functions

static bool operator!= (HPS.TreeContext a, HPS.TreeContext b)
 
static bool operator== (HPS.TreeContext a, HPS.TreeContext 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
 

Detailed Description

The TreeContext class is a user space object. It contains a spatial partition used for shell selection and shell relation computations. If many such operations will be performed without modifying the segment tree, using the same TreeContext for all of them can be a significant optimization. If a TreeContext is not specified, a new one is computed internally each time.

Constructor & Destructor Documentation

◆ TreeContext() [1/3]

HPS.TreeContext.TreeContext ( bool  in_create)
inline

The default constructor creates a new TreeContext object.

Parameters
in_createwhether to create the underlying spatial tree context.

◆ TreeContext() [2/3]

HPS.TreeContext.TreeContext ( )
inline

The default constructor creates a new TreeContext object.

◆ TreeContext() [3/3]

HPS.TreeContext.TreeContext ( HPS.TreeContext  in_that)
inline

The copy constructor shares a TreeContext object.

Parameters
in_thatThe source TreeContext to share.

Member Function Documentation

◆ Equals()

bool HPS.TreeContext.Equals ( HPS.TreeContext  in_that)
inline

Check if the source TreeContext is the same as this TreeContext.

Returns
true if the objects are identical, false otherwise.

◆ ObjectType()

override HPS.Type HPS.TreeContext.ObjectType ( )
inlinevirtual

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.

Reimplemented from HPS.Object.


The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.TreeContext.cs