API Search || Global Search
HPS::STL::ImportResultsKit Class Reference

#include <hps.h>

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

Public Member Functions

bool Empty () const
 
bool Equals (ImportResultsKit const &in_kit) const
 
 ImportResultsKit ()
 
 ImportResultsKit (ImportResultsKit const &in_kit)
 
 ImportResultsKit (ImportResultsKit &&in_that)
 
HPS::Type ObjectType () const
 
bool operator!= (ImportResultsKit const &in_kit) const
 
ImportResultsKitoperator= (ImportResultsKit &&in_that)
 
ImportResultsKitoperator= (ImportResultsKit const &in_kit)
 
bool operator== (ImportResultsKit const &in_kit) const
 
void Set (ImportResultsKit const &in_kit)
 
ImportResultsKitSetSegment (SegmentKey const &in_segment)
 
void Show (ImportResultsKit &out_kit) const
 
bool ShowSegment (SegmentKey &out_segment) const
 
ImportResultsKitUnsetEverything ()
 
ImportResultsKitUnsetSegment ()
 
- Public Member Functions inherited from HPS::Kit
virtual HPS::Type Type () const
 
- Public Member Functions inherited from HPS::Object
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
 Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::STLImportResultsKit
 
- Static Public Attributes inherited from HPS::Kit
static const HPS::Type staticType = HPS::Type::Kit
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 
- Protected Member Functions inherited from HPS::Kit
 Kit (Kit &&in_that)
 
Kitoperator= (Kit &&in_that)
 

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 ( ImportResultsKit const &  in_kit)

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

Parameters
in_kitThe source ImportResultsKit to copy.
HPS::STL::ImportResultsKit::ImportResultsKit ( ImportResultsKit &&  in_that)

The move constructor creates an ImportResultsKit by transferring the underlying impl of the rvalue reference to this ImportResultsKit thereby avoiding a copy and allocation.

Parameters
in_thatAn rvalue reference to an ImportResultsKit to take the impl from.

Member Function Documentation

bool HPS::STL::ImportResultsKit::Empty ( ) const
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 ( ImportResultsKit const &  in_kit) const

Check if the source ImportResultsKit is equivalent to this ImportResultsKit.

Parameters
in_kitThe source ImportResultsKit to compare to this ImportResultsKit.
Returns
true if the objects are equivalent, false otherwise.
bool HPS::STL::ImportResultsKit::operator!= ( ImportResultsKit const &  in_kit) const

Check if the source ImportResultsKit is not equivalent to this ImportResultsKit.

Parameters
in_kitThe source ImportResultsKit to compare to this ImportResultsKit.
Returns
true if the objects are not equivalent, false otherwise.
ImportResultsKit& HPS::STL::ImportResultsKit::operator= ( ImportResultsKit &&  in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this ImportResultsKit thereby avoiding a copy.

Parameters
in_thatAn rvalue reference to an ImportResultsKit to take the impl from.
Returns
A reference to this ImportResultsKit.
ImportResultsKit& HPS::STL::ImportResultsKit::operator= ( ImportResultsKit const &  in_kit)

Copies the source ImportResultsKit into this ImportResultsKit.

Parameters
in_kitThe source ImportResultsKit to copy.
Returns
A reference to this ImportResultsKit.
bool HPS::STL::ImportResultsKit::operator== ( ImportResultsKit const &  in_kit) const

Check if the source ImportResultsKit is equivalent to this ImportResultsKit.

Parameters
in_kitThe source ImportResultsKit to compare to this ImportResultsKit.
Returns
true if the objects are equivalent, false otherwise.
void HPS::STL::ImportResultsKit::Set ( ImportResultsKit const &  in_kit)

Copies the source ImportResultsKit into this ImportResultsKit.

Parameters
in_kitThe source ImportResultsKit to copy.
ImportResultsKit& HPS::STL::ImportResultsKit::SetSegment ( SegmentKey const &  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 OBJ data was imported into.
Returns
A reference to this ImportResultsKit.
void HPS::STL::ImportResultsKit::Show ( ImportResultsKit out_kit) const

Copies this ImportResultsKit into the given ImportResultsKit.

Parameters
out_kitThe ImportResultsKit to populate with the contents of this ImportResultsKit.
bool HPS::STL::ImportResultsKit::ShowSegment ( SegmentKey out_segment) const

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 OBJ data was imported into.
Returns
true if a root segment was specified, false otherwise.
ImportResultsKit& HPS::STL::ImportResultsKit::UnsetEverything ( )

Removes all settings from this ImportResultsKit.

Returns
A reference to this ImportResultsKit.
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: