The ImportOptionsKit class contains any settings controlling the import of HSF files. More...

#include <hps.h>

Inheritance diagram for HPS::Stream::ImportOptionsKit:

Collaboration diagram for HPS::Stream::ImportOptionsKit:

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

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

	ImportOptionsKit (ImportOptionsKit &&in_that)
	The move constructor creates an ImportOptionsKit by transferring the underlying impl of the rvalue reference to this ImportOptionsKit thereby avoiding a copy and allocation. More...

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

virtual	~ImportOptionsKit ()

HPS::Type	ObjectType () const

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

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

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

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

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

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

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

ImportOptionsKit &	SetToolkit (Toolkit const &in_toolkit)
	Sets the toolkit used for the import process. More...

ImportOptionsKit &	UnsetToolkit ()
	Removes the toolkit used for the import process. More...

bool	ShowToolkit (HPS::Stream::Toolkit &out_toolkit) const
	Shows the root toolkit used for the import process. More...

ImportOptionsKit &	SetSegment (SegmentKey const &in_segment)
	Sets the root segment where the HSF data will be imported into. More...

ImportOptionsKit &	UnsetSegment ()
	Removes the root segment speciyfing where the HSF data will be imported into. More...

bool	ShowSegment (SegmentKey &out_segment) const
	Shows the root segment where the HSF data will be imported into. More...

ImportOptionsKit &	SetAlternateRoot (SegmentKey const &in_segment)
	Sets the segment which will be used when the import file tries to access segments above the root segment. More...

ImportOptionsKit &	UnsetAlternateRoot ()
	Removes the segment which will be used when the import file tries to access segments above the root segment. More...

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

ImportOptionsKit &	SetPortfolio (PortfolioKey const &in_portfolio)
	Sets the portfolio which will be used for any definitions that need to be created during import. More...

ImportOptionsKit &	UnsetPortfolio ()
	Removes the portfolio which will be used for any definitions that need to be created during import. More...

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

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

ImportOptionsKit &	SetEventHandler (HPS::Stream::ImportEventHandler &in_handler, intptr_t in_type)
	Sets the specified ImportEventHandler for the indicated ImportEvent type. More...

ImportOptionsKit &	UnsetEventHandler (intptr_t in_type)
	Unsets the ImportEventHandler for the indicated ImportEvent type. More...

ImportOptionsKit &	UnsetEventHandlers ()
	Unsets the ImportEventHandler for all ImportEvent types. 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::StreamImportOptionsKit

Detailed Description

The ImportOptionsKit class contains any settings controlling the import of HSF files.

Constructor & Destructor Documentation

◆ ImportOptionsKit() [1/3]

HPS::Stream::ImportOptionsKit::ImportOptionsKit ( )

The default constructor creates an empty ImportOptionsKit object.

◆ ImportOptionsKit() [2/3]

HPS::Stream::ImportOptionsKit::ImportOptionsKit ( ImportOptionsKit const & in_kit )

The copy constructor creates a new ImportOptionsKit object that contains the same settings as the source ImportOptionsKit.

Parameters

in_kit The source ImportOptionsKit to copy.

◆ ImportOptionsKit() [3/3]

HPS::Stream::ImportOptionsKit::ImportOptionsKit ( ImportOptionsKit && in_that )

The move constructor creates an ImportOptionsKit by transferring the underlying impl of the rvalue reference to this ImportOptionsKit thereby avoiding a copy and allocation.

Parameters

in_that An rvalue reference to an ImportOptionsKit to take the impl from.

◆ ~ImportOptionsKit()

virtual HPS::Stream::ImportOptionsKit::~ImportOptionsKit ( )

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::ImportOptionsKit::Empty ( ) const

virtual

Indicates whether this ImportOptionsKit has any values set on it.

Returns: true if no values are set on this ImportOptionsKit, false otherwise.

Reimplemented from HPS::Object.

◆ Equals()

bool HPS::Stream::ImportOptionsKit::Equals ( ImportOptionsKit const & in_kit ) const

Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit.

Parameters

in_kit The source ImportOptionsKit to compare to this ImportOptionsKit.

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::ImportOptionsKit::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::Kit.

Here is the call graph for this function:

◆ operator!=()

bool HPS::Stream::ImportOptionsKit::operator!= ( ImportOptionsKit const & in_kit ) const

Check if the source ImportOptionsKit is not equivalent to this ImportOptionsKit.

Parameters

in_kit The source ImportOptionsKit to compare to this ImportOptionsKit.

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

◆ operator=() [1/2]

ImportOptionsKit& HPS::Stream::ImportOptionsKit::operator= ( ImportOptionsKit && in_that )

The move assignment operator transfers the underlying impl of the rvalue reference to this ImportOptionsKit thereby avoiding a copy.

Parameters

in_that An rvalue reference to an ImportOptionsKit to take the impl from.

Returns: A reference to this ImportOptionsKit.

◆ operator=() [2/2]

ImportOptionsKit& HPS::Stream::ImportOptionsKit::operator= ( ImportOptionsKit const & in_kit )

Copies the source ImportOptionsKit into this ImportOptionsKit.

Parameters

in_kit The source ImportOptionsKit to copy.

Returns: A reference to this ImportOptionsKit.

◆ operator==()

bool HPS::Stream::ImportOptionsKit::operator== ( ImportOptionsKit const & in_kit ) const

Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit.

Parameters

in_kit The source ImportOptionsKit to compare to this ImportOptionsKit.

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::ImportOptionsKit::Set ( ImportOptionsKit const & in_kit )

Copies the source ImportOptionsKit into this ImportOptionsKit.

Parameters

in_kit The source ImportOptionsKit to copy.

◆ SetAlternateRoot()

ImportOptionsKit& HPS::Stream::ImportOptionsKit::SetAlternateRoot ( SegmentKey const & in_segment )

Sets the segment which will be used when the import file tries to access segments above the root segment.

If no segment is specified, a root segment will be created for this purpose during import.

Parameters

in_segment Segment that will be used when the import file tries to access segments above the root segment.

Returns: A reference to this ImportOptionsKit.

◆ SetEventHandler()

ImportOptionsKit& HPS::Stream::ImportOptionsKit::SetEventHandler	(	HPS::Stream::ImportEventHandler &	in_handler,
		intptr_t	in_type
	)

Sets the specified ImportEventHandler for the indicated ImportEvent type.

Parameters

in_handler	An ImportEventHandler to be set.
in_type	The type of the Stream ImportEvent for which the given event handler will be used.

Returns: A reference to this ImportOptionsKit.

◆ SetPortfolio()

ImportOptionsKit& HPS::Stream::ImportOptionsKit::SetPortfolio ( PortfolioKey const & in_portfolio )

Sets the portfolio which will be used for any definitions that need to be created during import.

If no portfolio is specified, a portfolio will be created for this purpose during import.

Parameters

in_portfolio Portfolio that will be used for any definitions that need to be created during import.

Returns: A reference to this ImportOptionsKit.

◆ SetSegment()

ImportOptionsKit& HPS::Stream::ImportOptionsKit::SetSegment ( SegmentKey const & in_segment )

Sets the root segment where the HSF data will be imported into.

If no segment is specified, a root segment will be created for this purpose during import.

Parameters

in_segment Segment the HSF data will be imported into.

Returns: A reference to this ImportOptionsKit.

◆ SetToolkit()

ImportOptionsKit& HPS::Stream::ImportOptionsKit::SetToolkit ( Toolkit const & in_toolkit )

Sets the toolkit used for the import process.

If no tooklkit is specified, a default tookit will be used during import.

Returns: A reference to this ImportOptionsKit.

◆ Show()

void HPS::Stream::ImportOptionsKit::Show ( ImportOptionsKit & out_kit ) const

Copies this ImportOptionsKit into the given ImportOptionsKit.

Parameters

out_kit The ImportOptionsKit to populate with the contents of this ImportOptionsKit.

◆ ShowAlternateRoot()

bool HPS::Stream::ImportOptionsKit::ShowAlternateRoot ( SegmentKey & out_segment ) const

Shows the segment which will be used when the import file tries to access segments above the root segment.

Parameters

out_segment Segment that will be used when the import file tries to access segments above the root segment.

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

◆ ShowPortfolio()

bool HPS::Stream::ImportOptionsKit::ShowPortfolio ( PortfolioKey & out_portfolio ) const

Shows the portfolio which will be used for any definitions that need to be created during import.

Parameters

out_portfolio Portfolio that will be used for any definitions that need to be created during import.

Returns: true if a portfolio was specified, false otherwise.

◆ ShowSegment()

bool HPS::Stream::ImportOptionsKit::ShowSegment ( SegmentKey & out_segment ) const

Shows the root segment where the HSF data will be imported into.

Parameters

out_segment Segment the HSF data will be imported into.

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

◆ ShowToolkit()

bool HPS::Stream::ImportOptionsKit::ShowToolkit ( HPS::Stream::Toolkit & out_toolkit ) const

Shows the root toolkit used for the import process.

Parameters

out_toolkit The Toolkit used for the import process.

Returns: true if a toolkit 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.

◆ UnsetAlternateRoot()

ImportOptionsKit& HPS::Stream::ImportOptionsKit::UnsetAlternateRoot ( )

Removes the segment which will be used when the import file tries to access segments above the root segment.

Returns: A reference to this ImportOptionsKit.

◆ UnsetEventHandler()

ImportOptionsKit& HPS::Stream::ImportOptionsKit::UnsetEventHandler ( intptr_t in_type )

Unsets the ImportEventHandler for the indicated ImportEvent type.

Parameters

in_type The type of the Stream ImportEvent to unset.

Returns: A reference to this ImportOptionsKit.

◆ UnsetEventHandlers()

ImportOptionsKit& HPS::Stream::ImportOptionsKit::UnsetEventHandlers ( )

Unsets the ImportEventHandler for all ImportEvent types.

Returns: A reference to this ImportOptionsKit.

◆ UnsetEverything()

ImportOptionsKit& HPS::Stream::ImportOptionsKit::UnsetEverything ( )

Removes all settings from this ImportOptionsKit.

Returns: A reference to this ImportOptionsKit.

◆ UnsetPortfolio()

ImportOptionsKit& HPS::Stream::ImportOptionsKit::UnsetPortfolio ( )

Removes the portfolio which will be used for any definitions that need to be created during import.

Returns: A reference to this ImportOptionsKit.

◆ UnsetSegment()

ImportOptionsKit& HPS::Stream::ImportOptionsKit::UnsetSegment ( )

Removes the root segment speciyfing where the HSF data will be imported into.

Returns: A reference to this ImportOptionsKit.

◆ UnsetToolkit()

ImportOptionsKit& HPS::Stream::ImportOptionsKit::UnsetToolkit ( )

Removes the toolkit used for the import process.

Returns: A reference to this ImportOptionsKit.

Member Data Documentation

◆ staticType

const HPS::Type HPS::Stream::ImportOptionsKit::staticType = HPS::Type::StreamImportOptionsKit

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

◆ ImportOptionsKit() [1/3]

◆ ImportOptionsKit() [2/3]

◆ ImportOptionsKit() [3/3]

◆ ~ImportOptionsKit()

Member Function Documentation

◆ ClassID()

◆ Empty()

◆ Equals()

◆ GetClassID()

◆ GetInstanceID()

◆ HasType()

◆ ObjectType()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ Reset()

◆ Set()

◆ SetAlternateRoot()

◆ SetEventHandler()

◆ SetPortfolio()

◆ SetSegment()

◆ SetToolkit()

◆ Show()

◆ ShowAlternateRoot()

◆ ShowPortfolio()

◆ ShowSegment()

◆ ShowToolkit()

◆ Type()

◆ UnsetAlternateRoot()

◆ UnsetEventHandler()

◆ UnsetEventHandlers()

◆ UnsetEverything()

◆ UnsetPortfolio()

◆ UnsetSegment()

◆ UnsetToolkit()

Member Data Documentation

◆ staticType