#include <hps.h>

Inheritance diagram for HPS::Stream::ImportOptionsKit:

Public Member Functions
bool	Empty () const

bool	Equals (ImportOptionsKit const &in_kit) const

	ImportOptionsKit ()

	ImportOptionsKit (ImportOptionsKit const &in_kit)

	ImportOptionsKit (ImportOptionsKit &&in_that)

HPS::Type	ObjectType () const

bool	operator!= (ImportOptionsKit const &in_kit) const

ImportOptionsKit &	operator= (ImportOptionsKit &&in_that)

ImportOptionsKit &	operator= (ImportOptionsKit const &in_kit)

bool	operator== (ImportOptionsKit const &in_kit) const

void	Set (ImportOptionsKit const &in_kit)

ImportOptionsKit &	SetAlternateRoot (SegmentKey const &in_segment)

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

ImportOptionsKit &	SetPortfolio (PortfolioKey const &in_portfolio)

ImportOptionsKit &	SetSegment (SegmentKey const &in_segment)

ImportOptionsKit &	SetToolkit (Toolkit const &in_toolkit)

void	Show (ImportOptionsKit &out_kit) const

bool	ShowAlternateRoot (SegmentKey &out_segment) const

bool	ShowPortfolio (PortfolioKey &out_portfolio) const

bool	ShowSegment (SegmentKey &out_segment) const

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

ImportOptionsKit &	UnsetAlternateRoot ()

ImportOptionsKit &	UnsetEventHandler (intptr_t in_type)

ImportOptionsKit &	UnsetEventHandlers ()

ImportOptionsKit &	UnsetEverything ()

ImportOptionsKit &	UnsetPortfolio ()

ImportOptionsKit &	UnsetSegment ()

ImportOptionsKit &	UnsetToolkit ()

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)

Object &	operator= (Object const &other_object)

Object &	operator= (Object &&in_that)

virtual void	Reset ()

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

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)

Kit &	operator= (Kit &&in_that)

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.

Member Function Documentation

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

◆ ObjectType()

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

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

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

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

include/hps.h

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ImportOptionsKit() [1/3]

◆ ImportOptionsKit() [2/3]

◆ ImportOptionsKit() [3/3]

Member Function Documentation

◆ Empty()

◆ Equals()

◆ ObjectType()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ Set()

◆ SetAlternateRoot()

◆ SetEventHandler()

◆ SetPortfolio()

◆ SetSegment()

◆ SetToolkit()

◆ Show()

◆ ShowAlternateRoot()

◆ ShowPortfolio()

◆ ShowSegment()

◆ ShowToolkit()

◆ UnsetAlternateRoot()

◆ UnsetEventHandler()

◆ UnsetEventHandlers()

◆ UnsetEverything()

◆ UnsetPortfolio()

◆ UnsetSegment()

◆ UnsetToolkit()