HPS::Stream::ImportOptionsKit

class HPS::Stream::ImportOptionsKit : public HPS::Kit

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

Public Functions

virtual bool Empty() const

Indicates whether this ImportOptionsKit has any values set on it.

Returns

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

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

ImportOptionsKit()

The default constructor creates an empty ImportOptionsKit object.

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

inline virtual HPS::Type ObjectType() const

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.

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

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.

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.

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

void Set(ImportOptionsKit const &in_kit)

Copies the source ImportOptionsKit into this ImportOptionsKit.

Parameters

in_kit – The source ImportOptionsKit to copy.

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.

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.

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.

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.

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.

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

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.

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.

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

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

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

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.

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.

ImportOptionsKit &UnsetEventHandlers()

Unsets the ImportEventHandler for all ImportEvent types.

Returns

A reference to this ImportOptionsKit.

ImportOptionsKit &UnsetEverything()

Removes all settings from this ImportOptionsKit.

Returns

A reference to this ImportOptionsKit.

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.

ImportOptionsKit &UnsetSegment()

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

Returns

A reference to this ImportOptionsKit.

ImportOptionsKit &UnsetToolkit()

Removes the toolkit used for the import process.

Returns

A reference to this ImportOptionsKit.