#include <hps.h>

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 |
ImportResultsKit & | operator= (ImportResultsKit &&in_that) |
ImportResultsKit & | operator= (ImportResultsKit const &in_kit) |
bool | operator== (ImportResultsKit const &in_kit) const |
void | Set (ImportResultsKit const &in_kit) |
ImportResultsKit & | SetSegment (SegmentKey const &in_segment) |
void | Show (ImportResultsKit &out_kit) const |
bool | ShowSegment (SegmentKey &out_segment) const |
ImportResultsKit & | UnsetEverything () |
ImportResultsKit & | UnsetSegment () |
![]() | |
virtual HPS::Type | Type () const |
![]() | |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
bool | HasType (HPS::Type in_mask) const |
Object (Object const &that) | |
Object (Object &&in_that) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual void | Reset () |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
![]() | |
Kit (Kit &&in_that) | |
Kit & | operator= (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_kit The 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_that An rvalue reference to an ImportResultsKit to take the impl from.
Member Function Documentation
|
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_kit The source ImportResultsKit to compare to this ImportResultsKit.
- Returns
- true if the objects are equivalent, false otherwise.
|
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::Kit.
bool HPS::STL::ImportResultsKit::operator!= | ( | ImportResultsKit const & | in_kit | ) | const |
Check if the source ImportResultsKit is not equivalent to this ImportResultsKit.
- Parameters
-
in_kit The 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_that An 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_kit The 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_kit The 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_kit The 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_segment Segment 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_kit The 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_segment Segment 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:
- include/hps.h