< Home

< Table of Contents

REFERENCE MANUAL

HPS.STL.ImportResultsKit Class Reference

The ImportResultsKit class contains the results of a successful STL import. More...

Inheritance diagram for HPS.STL.ImportResultsKit:
HPS.Object

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 Indicates whether this ImportResultsKit has any values set on it. More...
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.STL.ImportResultsKit in_kit)
 Check if the source ImportResultsKit is equivalent to this ImportResultsKit. More...
 
override int GetHashCode ()
 
 ImportResultsKit ()
 The default constructor creates an empty ImportResultsKit object. More...
 
 ImportResultsKit (HPS.STL.ImportResultsKit in_kit)
 The copy constructor creates a new ImportResultsKit object that contains the same settings as the source ImportResultsKit. More...
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. More...
 
void Set (HPS.STL.ImportResultsKit in_kit)
 Copies the source ImportResultsKit into this ImportResultsKit. More...
 
HPS.STL.ImportResultsKit SetSegment (HPS.SegmentKey in_segment)
 Sets the root segment which the OBJ data was imported into. More...
 
void Show (out HPS.STL.ImportResultsKit out_kit)
 Copies this ImportResultsKit into the given ImportResultsKit. More...
 
bool ShowSegment (out HPS.SegmentKey out_segment)
 Shows the root segment which the OBJ data was imported into. More...
 
HPS.STL.ImportResultsKit UnsetEverything ()
 Removes all settings from this ImportResultsKit. More...
 
HPS.STL.ImportResultsKit UnsetSegment ()
 Removes the root segment which the OBJ data was imported into. More...
 
- Public Member Functions inherited from HPS.Object
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.STL.ImportResultsKit a, HPS.STL.ImportResultsKit b)
 
static bool operator== (HPS.STL.ImportResultsKit a, HPS.STL.ImportResultsKit 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 ImportResultsKit class contains the results of a successful STL import.

Constructor & Destructor Documentation

HPS.STL.ImportResultsKit.ImportResultsKit ( )

The default constructor creates an empty ImportResultsKit object.

HPS.STL.ImportResultsKit.ImportResultsKit ( HPS.STL.ImportResultsKit  in_kit)

The copy constructor creates a new ImportResultsKit object that contains the same settings as the source ImportResultsKit.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_s_t_l_1_1_import_results_kit" kindref="compound">ImportResultsKit</ref> to copy.

Member Function Documentation

override bool HPS.STL.ImportResultsKit.Empty ( )
virtual

Indicates whether this ImportResultsKit has any values set on it.

Returns
true if no values are set on this ImportResultsKit, false otherwise.

Reimplemented from HPS.Object.

bool HPS.STL.ImportResultsKit.Equals ( HPS.STL.ImportResultsKit  in_kit)

Check if the source ImportResultsKit is equivalent to this ImportResultsKit.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_s_t_l_1_1_import_results_kit" kindref="compound">ImportResultsKit</ref> to compare to this <ref refid="class_h_p_s_1_1_s_t_l_1_1_import_results_kit" kindref="compound">ImportResultsKit</ref>.
Returns
true if the objects are equivalent, false otherwise.
override HPS.Type HPS.STL.ImportResultsKit.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.

void HPS.STL.ImportResultsKit.Set ( HPS.STL.ImportResultsKit  in_kit)

Copies the source ImportResultsKit into this ImportResultsKit.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_s_t_l_1_1_import_results_kit" kindref="compound">ImportResultsKit</ref> to copy.
HPS.STL.ImportResultsKit HPS.STL.ImportResultsKit.SetSegment ( HPS.SegmentKey  in_segment)

Sets the root segment which the OBJ data was imported into.

This is really only used when generating an ImportResultsKit which is being returned to a user following an OBJ import.

Parameters
in_segmentSegment the <ref refid="class_h_p_s_1_1_o_b_j" kindref="compound">OBJ</ref> data was imported into.
Returns
A reference to this ImportResultsKit.
void HPS.STL.ImportResultsKit.Show ( out HPS.STL.ImportResultsKit  out_kit)

Copies this ImportResultsKit into the given ImportResultsKit.

Parameters
out_kitThe <ref refid="class_h_p_s_1_1_s_t_l_1_1_import_results_kit" kindref="compound">ImportResultsKit</ref> to populate with the contents of this <ref refid="class_h_p_s_1_1_s_t_l_1_1_import_results_kit" kindref="compound">ImportResultsKit</ref>.
bool HPS.STL.ImportResultsKit.ShowSegment ( out HPS.SegmentKey  out_segment)

Shows the root segment which the OBJ data was imported into.

This was either the root segment specified by the user in the ImportOptionsKit passed to OBJ::File::Import, or the root segment that was created for this purpose during import.

Parameters
out_segmentSegment the <ref refid="class_h_p_s_1_1_o_b_j" kindref="compound">OBJ</ref> data was imported into.
Returns
true if a root segment was specified, false otherwise.
HPS.STL.ImportResultsKit HPS.STL.ImportResultsKit.UnsetEverything ( )

Removes all settings from this ImportResultsKit.

Returns
A reference to this ImportResultsKit.
HPS.STL.ImportResultsKit HPS.STL.ImportResultsKit.UnsetSegment ( )

Removes the root segment which the OBJ data was imported into.

This is really only used when generating an ImportResultsKit which is being returned to a user following an OBJ import.

Returns
A reference to this ImportResultsKit.

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