#include <hps.h>
|
template<typename T > |
static intptr_t | ClassID () |
|
The ImportResultsKit class contains the results of a successful HSF import.
HPS::Stream::ImportResultsKit::ImportResultsKit |
( |
| ) |
|
HPS::Stream::ImportResultsKit::ImportResultsKit |
( |
ImportResultsKit const & |
in_kit | ) |
|
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
-
bool HPS::Stream::ImportResultsKit::Empty |
( |
| ) |
const |
|
virtual |
bool HPS::Stream::ImportResultsKit::Equals |
( |
ImportResultsKit const & |
in_kit | ) |
const |
HPS::Type HPS::Stream::ImportResultsKit::ObjectType |
( |
| ) |
const |
|
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::Object.
bool HPS::Stream::ImportResultsKit::operator!= |
( |
ImportResultsKit const & |
in_kit | ) |
const |
The move assignment operator transfers the underlying impl of the rvalue reference to this ImportResultsKit thereby avoiding a copy.
- Parameters
-
- Returns
- A reference to this ImportResultsKit.
bool HPS::Stream::ImportResultsKit::operator== |
( |
ImportResultsKit const & |
in_kit | ) |
const |
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.
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.
Sets the "default" named camera that was 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_camera | The "default" named camera from the HSF file. |
- Returns
- A reference to this ImportResultsKit.
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.
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.
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" named camera that was present in the HSF file. There can only have been a single default camera in an HSF.
- Parameters
-
out_camera | The "default" named camera from the HSF 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.
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.
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.
Removes the "default" named camera that was 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.
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.
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:
- C:/git/visualize/hps/include/hps.h