HPS::Stream::ImportResultsKit Class Reference

#include <hps.h>

Inheritance diagram for HPS::Stream::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)
 
ImportResultsKitSetAlternateCameras (UTF8Array const &in_names, CameraKitArray &in_cameras)
 
ImportResultsKitSetAlternateRoot (SegmentKey const &in_segment)
 
ImportResultsKitSetDefaultCamera (CameraKit const &in_camera)
 
ImportResultsKitSetPortfolio (PortfolioKey const &in_portfolio)
 
ImportResultsKitSetSegment (SegmentKey const &in_segment)
 
void Show (ImportResultsKit &out_kit) const
 
bool ShowAlternateCameras (UTF8Array &out_names, CameraKitArray &out_cameras) const
 
bool ShowAlternateRoot (SegmentKey &out_segment) const
 
bool ShowDefaultCamera (CameraKit &out_camera) const
 
bool ShowPortfolio (PortfolioKey &out_portfolio) const
 
bool ShowSegment (SegmentKey &out_segment) const
 
ImportResultsKitUnsetAlternateCameras ()
 
ImportResultsKitUnsetAlternateRoot ()
 
ImportResultsKitUnsetDefaultCamera ()
 
ImportResultsKitUnsetEverything ()
 
ImportResultsKitUnsetPortfolio ()
 
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::StreamImportResultsKit
 
- 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 HSF import.

Constructor & Destructor Documentation

◆ ImportResultsKit() [1/3]

HPS::Stream::ImportResultsKit::ImportResultsKit ( )

The default constructor creates an empty ImportResultsKit object.

◆ ImportResultsKit() [2/3]

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_kitThe source ImportResultsKit to copy.

◆ ImportResultsKit() [3/3]

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_thatAn rvalue reference to an ImportResultsKit to take the impl from.

Member Function Documentation

◆ Empty()

bool HPS::Stream::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.

◆ Equals()

bool HPS::Stream::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.

◆ ObjectType()

HPS::Type HPS::Stream::ImportResultsKit::ObjectType ( ) const
inlinevirtual

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS::Kit.

◆ operator!=()

bool HPS::Stream::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.

◆ operator=() [1/2]

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_thatAn rvalue reference to an ImportResultsKit to take the impl from.
Returns
A reference to this ImportResultsKit.

◆ operator=() [2/2]

ImportResultsKit& HPS::Stream::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.

◆ operator==()

bool HPS::Stream::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.

◆ Set()

void HPS::Stream::ImportResultsKit::Set ( ImportResultsKit const &  in_kit)

Copies the source ImportResultsKit into this ImportResultsKit.

Parameters
in_kitThe source ImportResultsKit to copy.

◆ SetAlternateCameras()

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_namesThe names of the cameras in the HSF file.
in_camerasThe cameras in the HSF file.
Returns
A reference to this ImportResultsKit.

◆ SetAlternateRoot()

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_segmentSegment that was used when the import file tried to access segments above the root segment during import.
Returns
A reference to this ImportResultsKit.

◆ SetDefaultCamera()

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_cameraThe "default" named camera from the HSF file.
Returns
A reference to this ImportResultsKit.

◆ SetPortfolio()

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_portfolioPortfolio that was used for any definitions that had to be created during import.
Returns
A reference to this ImportResultsKit.

◆ SetSegment()

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_segmentSegment the HSF data was imported into.
Returns
A reference to this ImportResultsKit.

◆ Show()

void HPS::Stream::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.

◆ ShowAlternateCameras()

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_namesThe names of the cameras in the HSF file.
out_camerasThe cameras in the HSF file.
Returns
true if alternate cameras were specified, false otherwise.

◆ ShowAlternateRoot()

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_segmentSegment 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.

◆ ShowDefaultCamera()

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_cameraThe "default" camera from the Stream file.
Returns
true if a default camera was specified, false otherwise.

◆ ShowPortfolio()

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_portfolioPortfolio that was used for any definitions that had to be created during import.
Returns
true if a portfolio was specified, false otherwise.

◆ ShowSegment()

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_segmentSegment the HSF data was imported into.
Returns
true if a root segment was specified, false otherwise.

◆ UnsetAlternateCameras()

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.

◆ UnsetAlternateRoot()

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.

◆ UnsetDefaultCamera()

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.

◆ UnsetEverything()

ImportResultsKit& HPS::Stream::ImportResultsKit::UnsetEverything ( )

Removes all settings from this ImportResultsKit.

Returns
A reference to this ImportResultsKit.

◆ UnsetPortfolio()

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.

◆ UnsetSegment()

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: