#include <hps.h>

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 HSF import.
Constructor & Destructor Documentation
HPS::Stream::ImportResultsKit::ImportResultsKit | ( | ) |
The default constructor creates an empty ImportResultsKit object.
HPS::Stream::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::Stream::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::Stream::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::Stream::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::Stream::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::Stream::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::Stream::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::Stream::ImportResultsKit::Set | ( | ImportResultsKit const & | in_kit | ) |
Copies the source ImportResultsKit into this ImportResultsKit.
- Parameters
-
in_kit The source ImportResultsKit to copy.
ImportResultsKit& HPS::Stream::ImportResultsKit::SetAlternateCameras | ( | UTF8Array const & | in_names, |
CameraKitArray & | in_cameras | ||
) |
Sets the alternate named cameras that were present in the HSF file. This is really only used when generating an ImportResultsKit which is being returned to a user following an HSF import.
- Parameters
-
in_names The names of the cameras in the HSF file. in_cameras The cameras in the HSF file.
- Returns
- A reference to this ImportResultsKit.
ImportResultsKit& HPS::Stream::ImportResultsKit::SetAlternateRoot | ( | SegmentKey const & | in_segment | ) |
Sets the segment which was used when the import file tried to access segments above the root segment. This is really only used when generating an ImportResultsKit which is being returned to a user following an HSF import.
- Parameters
-
in_segment Segment that was used when the import file tried to access segments above the root segment during import.
- Returns
- A reference to this ImportResultsKit.
ImportResultsKit& HPS::Stream::ImportResultsKit::SetDefaultCamera | ( | CameraKit const & | in_camera | ) |
Sets the "default" camera for this ImportResultsKit. This is generally only used during a Stream Import to record the default camera read from the Stream file.
- Parameters
-
in_camera The "default" named camera from the HSF file.
- Returns
- A reference to this ImportResultsKit.
ImportResultsKit& HPS::Stream::ImportResultsKit::SetPortfolio | ( | PortfolioKey const & | in_portfolio | ) |
Sets the portfolio which was used for any definitions that had to be created during import. This is really only used when generating an ImportResultsKit which is being returned to a user following an HSF import.
- Parameters
-
in_portfolio Portfolio that was used for any definitions that had to be created during import.
- Returns
- A reference to this ImportResultsKit.
ImportResultsKit& HPS::Stream::ImportResultsKit::SetSegment | ( | SegmentKey const & | in_segment | ) |
Sets the root segment which the HSF data was imported into. This is really only used when generating an ImportResultsKit which is being returned to a user following an HSF import.
- Parameters
-
in_segment Segment the HSF data was imported into.
- Returns
- A reference to this ImportResultsKit.
void HPS::Stream::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::Stream::ImportResultsKit::ShowAlternateCameras | ( | UTF8Array & | out_names, |
CameraKitArray & | out_cameras | ||
) | const |
Shows the alternate named cameras that were present in the HSF file. This includes all cameras other than "default".
- Parameters
-
out_names The names of the cameras in the HSF file. out_cameras The cameras in the HSF file.
- Returns
- true if alternate cameras were specified, false otherwise.
bool HPS::Stream::ImportResultsKit::ShowAlternateRoot | ( | SegmentKey & | out_segment | ) | const |
Shows the segment which was used when the import file tried to access segments above the root segment. This was either the alternate root specified by the user in the ImportOptionsKit passed to Stream::File::Import, or the root segment that was created for this purpose during import.
- Parameters
-
out_segment Segment that was used when the import file tried to access segments above the root segment.
- Returns
- true if an alternate root segment was specified, false otherwise.
bool HPS::Stream::ImportResultsKit::ShowDefaultCamera | ( | CameraKit & | out_camera | ) | const |
Shows the "default" camera for this ImportOptionsKit. The "default" camera is set during a Stream Import. There can only be a single default camera in a Stream file.
- Parameters
-
out_camera The "default" camera from the Stream file.
- Returns
- true if a default camera was specified, false otherwise.
bool HPS::Stream::ImportResultsKit::ShowPortfolio | ( | PortfolioKey & | out_portfolio | ) | const |
Shows the portfolio which was used for any definitions that had to be created during import. This was either the portfolio specified by the user in the ImportOptionsKit passed to Stream::File::Import, or the portfolio that was created for this purpose during import.
- Parameters
-
out_portfolio Portfolio that was used for any definitions that had to be created during import.
- Returns
- true if a portfolio was specified, false otherwise.
bool HPS::Stream::ImportResultsKit::ShowSegment | ( | SegmentKey & | out_segment | ) | const |
Shows the root segment which the HSF data was imported into. This was either the root segment specified by the user in the ImportOptionsKit passed to Stream::File::Import, or the root segment that was created for this purpose during import.
- Parameters
-
out_segment Segment the HSF data was imported into.
- Returns
- true if a root segment was specified, false otherwise.
ImportResultsKit& HPS::Stream::ImportResultsKit::UnsetAlternateCameras | ( | ) |
Removes the alternate named cameras that were present in the HSF file. This is really only used when generating an ImportResultsKit which is being returned to a user following an HSF import.
- Returns
- A reference to this ImportResultsKit.
ImportResultsKit& HPS::Stream::ImportResultsKit::UnsetAlternateRoot | ( | ) |
Removes the segment which was used when the import file tried to access segments above the root segment. This is really only used when generating an ImportResultsKit which is being returned to a user following an HSF import.
- Returns
- A reference to this ImportResultsKit.
ImportResultsKit& HPS::Stream::ImportResultsKit::UnsetDefaultCamera | ( | ) |
Removes the "default" camera from this ImportResultsKit. This is generally only used for ImportResultsKits that are generated from a Stream import.
- Returns
- A reference to this ImportResultsKit.
ImportResultsKit& HPS::Stream::ImportResultsKit::UnsetEverything | ( | ) |
Removes all settings from this ImportResultsKit.
- Returns
- A reference to this ImportResultsKit.
ImportResultsKit& HPS::Stream::ImportResultsKit::UnsetPortfolio | ( | ) |
Removes the portfolio which was used for any definitions that had to be created during import. This is really only used when generating an ImportResultsKit which is being returned to a user following an HSF import.
- Returns
- A reference to this ImportResultsKit.
ImportResultsKit& HPS::Stream::ImportResultsKit::UnsetSegment | ( | ) |
Removes the root segment which the HSF data was imported into. This is really only used when generating an ImportResultsKit which is being returned to a user following an HSF import.
- Returns
- A reference to this ImportResultsKit.
The documentation for this class was generated from the following file:
- include/hps.h