The ImportResultsKit class contains the results of a successful HSF import. More...

#include <hps.h>

Inheritance diagram for HPS::Stream::ImportResultsKit:

Collaboration diagram for HPS::Stream::ImportResultsKit:

Public Member Functions
	ImportResultsKit ()
	The default constructor creates an empty ImportResultsKit object. More...

	ImportResultsKit (ImportResultsKit const &in_kit)
	The copy constructor creates a new ImportResultsKit object that contains the same settings as the source ImportResultsKit. More...

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

ImportResultsKit &	operator= (ImportResultsKit &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this ImportResultsKit thereby avoiding a copy. More...

virtual	~ImportResultsKit ()

HPS::Type	ObjectType () const

void	Set (ImportResultsKit const &in_kit)
	Copies the source ImportResultsKit into this ImportResultsKit. More...

void	Show (ImportResultsKit &out_kit) const
	Copies this ImportResultsKit into the given ImportResultsKit. More...

ImportResultsKit &	operator= (ImportResultsKit const &in_kit)
	Copies the source ImportResultsKit into this ImportResultsKit. More...

bool	Empty () const
	Indicates whether this ImportResultsKit has any values set on it. More...

bool	Equals (ImportResultsKit const &in_kit) const
	Check if the source ImportResultsKit is equivalent to this ImportResultsKit. More...

bool	operator== (ImportResultsKit const &in_kit) const
	Check if the source ImportResultsKit is equivalent to this ImportResultsKit. More...

bool	operator!= (ImportResultsKit const &in_kit) const
	Check if the source ImportResultsKit is not equivalent to this ImportResultsKit. More...

ImportResultsKit &	SetSegment (SegmentKey const &in_segment)
	Sets the root segment which the HSF data was imported into. More...

ImportResultsKit &	UnsetSegment ()
	Removes the root segment which the HSF data was imported into. More...

bool	ShowSegment (SegmentKey &out_segment) const
	Shows the root segment which the HSF data was imported into. More...

ImportResultsKit &	SetAlternateRoot (SegmentKey const &in_segment)
	Sets the segment which was used when the import file tried to access segments above the root segment. More...

ImportResultsKit &	UnsetAlternateRoot ()
	Removes the segment which was used when the import file tried to access segments above the root segment. More...

bool	ShowAlternateRoot (SegmentKey &out_segment) const
	Shows the segment which was used when the import file tried to access segments above the root segment. More...

ImportResultsKit &	SetPortfolio (PortfolioKey const &in_portfolio)
	Sets the portfolio which was used for any definitions that had to be created during import. More...

ImportResultsKit &	UnsetPortfolio ()
	Removes the portfolio which was used for any definitions that had to be created during import. More...

bool	ShowPortfolio (PortfolioKey &out_portfolio) const
	Shows the portfolio which was used for any definitions that had to be created during import. More...

ImportResultsKit &	SetDefaultCamera (CameraKit const &in_camera)
	Sets the "default" camera for this ImportResultsKit. More...

ImportResultsKit &	UnsetDefaultCamera ()
	Removes the "default" camera from this ImportResultsKit. More...

bool	ShowDefaultCamera (CameraKit &out_camera) const
	Shows the "default" camera for this ImportOptionsKit. More...

ImportResultsKit &	SetAlternateCameras (UTF8Array const &in_names, CameraKitArray &in_cameras)
	Sets the alternate named cameras that were present in the HSF file. More...

ImportResultsKit &	UnsetAlternateCameras ()
	Removes the alternate named cameras that were present in the HSF file. More...

bool	ShowAlternateCameras (UTF8Array &out_names, CameraKitArray &out_cameras) const
	Shows the alternate named cameras that were present in the HSF file. More...

ImportResultsKit &	UnsetEverything ()
	Removes all settings from this ImportResultsKit. More...

virtual HPS::Type	Type () const
	This function returns the true type of the underlying object. More...

virtual void	Reset ()
	Resets this object to its initial, uninitialized state. More...

bool	HasType (HPS::Type in_mask) const
	This function indicates whether this Object has the given Type mask. More...

intptr_t	GetClassID () const
	Returns a unique identifier that is shared by all objects of the same class. More...

intptr_t	GetInstanceID () const
	Returns an identifier that can be used to identify which instance of a class an object is. More...

Static Public Member Functions
template<typename T >
static intptr_t	ClassID ()
	Unique identifier for this class. More...

Static Public Attributes
static const HPS::Type	staticType = HPS::Type::StreamImportResultsKit

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_kit The 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_that An rvalue reference to an ImportResultsKit to take the impl from.

◆ ~ImportResultsKit()

virtual HPS::Stream::ImportResultsKit::~ImportResultsKit ( )

virtual

Member Function Documentation

◆ ClassID()

template<typename T >

static intptr_t HPS::Object::ClassID ( )

inlinestaticinherited

Unique identifier for this class.

Note: this method uses construction of static objects. If used in a constructor, it should be used in the body not the initializer list.

◆ 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_kit The source ImportResultsKit to compare to this ImportResultsKit.

Returns: true if the objects are equivalent, false otherwise.

◆ GetClassID()

intptr_t HPS::Object::GetClassID ( ) const

inherited

Returns a unique identifier that is shared by all objects of the same class.

Returns: A unique value shared by all objects of the same class.

◆ GetInstanceID()

intptr_t HPS::Object::GetInstanceID ( ) const

inherited

Returns an identifier that can be used to identify which instance of a class an object is.

Different keys and controls will return the same value if they are backed by the same database resource.

Returns: A value unique to an instance of an object and all objects that are backed by the same database resource.

◆ HasType()

bool HPS::Object::HasType ( HPS::Type in_mask ) const

inherited

This function indicates whether this Object has the given Type mask.

Parameters

in_mask The Type mask to check against this Object.

Returns: true if this Object has the given Type mask, false otherwise.

◆ ObjectType()

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

inlinevirtual

Reimplemented from HPS::Kit.

Here is the call graph for this function:

◆ operator!=()

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.

◆ 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_that An 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_kit The 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_kit The source ImportResultsKit to compare to this ImportResultsKit.

Returns: true if the objects are equivalent, false otherwise.

◆ Reset()

virtual void HPS::Object::Reset ( )

virtualinherited

Resets this object to its initial, uninitialized state.

Reimplemented in HPS::EventHandler, HPS::EventDispatcher, HPS::World, HPS::HighlightSearchResults, HPS::HighlightSearchResultsIterator, HPS::SelectionResults, HPS::SelectionResultsIterator, HPS::FontSearchResults, HPS::FontSearchResultsIterator, HPS::SearchResults, and HPS::SearchResultsIterator.

◆ Set()

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

Copies the source ImportResultsKit into this ImportResultsKit.

Parameters

in_kit The 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_names	The names of the cameras in the HSF file.
in_cameras	The 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_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.

◆ 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_camera The "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_portfolio Portfolio 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_segment Segment 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_kit The 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_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.

◆ 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_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.

◆ 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_camera The "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_portfolio Portfolio 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_segment Segment the HSF data was imported into.

Returns: true if a root segment was specified, false otherwise.

◆ Type()

virtual HPS::Type HPS::Kit::Type ( ) const

inlinevirtualinherited

This function returns the true type of the underlying object.

This function is useful for finding the type of smart pointer objects that have been cast to more generic types.

Returns: The true type of the object in question.

Reimplemented from HPS::Object.

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

Member Data Documentation

◆ staticType

const HPS::Type HPS::Stream::ImportResultsKit::staticType = HPS::Type::StreamImportResultsKit

static

The documentation for this class was generated from the following file:

hps.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ImportResultsKit() [1/3]

◆ ImportResultsKit() [2/3]

◆ ImportResultsKit() [3/3]

◆ ~ImportResultsKit()

Member Function Documentation

◆ ClassID()

◆ Empty()

◆ Equals()

◆ GetClassID()

◆ GetInstanceID()

◆ HasType()

◆ ObjectType()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ Reset()

◆ Set()

◆ SetAlternateCameras()

◆ SetAlternateRoot()

◆ SetDefaultCamera()

◆ SetPortfolio()

◆ SetSegment()

◆ Show()

◆ ShowAlternateCameras()

◆ ShowAlternateRoot()

◆ ShowDefaultCamera()

◆ ShowPortfolio()

◆ ShowSegment()

◆ Type()

◆ UnsetAlternateCameras()

◆ UnsetAlternateRoot()

◆ UnsetDefaultCamera()

◆ UnsetEverything()

◆ UnsetPortfolio()

◆ UnsetSegment()

Member Data Documentation

◆ staticType