API Search || Global Search
HPS::Stream::ImportOptionsKit Class Reference

#include <hps.h>

Inheritance diagram for HPS::Stream::ImportOptionsKit:
HPS::Kit HPS::Object

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
 
ImportOptionsKitoperator= (ImportOptionsKit &&in_that)
 
ImportOptionsKitoperator= (ImportOptionsKit const &in_kit)
 
bool operator== (ImportOptionsKit const &in_kit) const
 
void Set (ImportOptionsKit const &in_kit)
 
ImportOptionsKitSetAlternateRoot (SegmentKey const &in_segment)
 
ImportOptionsKitSetEventHandler (HPS::Stream::ImportEventHandler &in_handler, intptr_t in_type)
 
ImportOptionsKitSetPortfolio (PortfolioKey const &in_portfolio)
 
ImportOptionsKitSetSegment (SegmentKey const &in_segment)
 
ImportOptionsKitSetToolkit (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
 
ImportOptionsKitUnsetAlternateRoot ()
 
ImportOptionsKitUnsetEventHandler (intptr_t in_type)
 
ImportOptionsKitUnsetEventHandlers ()
 
ImportOptionsKitUnsetEverything ()
 
ImportOptionsKitUnsetPortfolio ()
 
ImportOptionsKitUnsetSegment ()
 
ImportOptionsKitUnsetToolkit ()
 
- 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::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)
 
Kitoperator= (Kit &&in_that)
 

Detailed Description

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

Constructor & Destructor Documentation

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

The default constructor creates an empty ImportOptionsKit object.

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_kitThe source ImportOptionsKit to copy.
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_thatAn rvalue reference to an ImportOptionsKit to take the impl from.

Member Function Documentation

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.

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

Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit.

Parameters
in_kitThe source ImportOptionsKit to compare to this ImportOptionsKit.
Returns
true if the objects are equivalent, false otherwise.
bool HPS::Stream::ImportOptionsKit::operator!= ( ImportOptionsKit const &  in_kit) const

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

Parameters
in_kitThe source ImportOptionsKit to compare to this ImportOptionsKit.
Returns
true if the objects are not equivalent, false otherwise.
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_thatAn rvalue reference to an ImportOptionsKit to take the impl from.
Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& HPS::Stream::ImportOptionsKit::operator= ( ImportOptionsKit const &  in_kit)

Copies the source ImportOptionsKit into this ImportOptionsKit.

Parameters
in_kitThe source ImportOptionsKit to copy.
Returns
A reference to this ImportOptionsKit.
bool HPS::Stream::ImportOptionsKit::operator== ( ImportOptionsKit const &  in_kit) const

Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit.

Parameters
in_kitThe source ImportOptionsKit to compare to this ImportOptionsKit.
Returns
true if the objects are equivalent, false otherwise.
void HPS::Stream::ImportOptionsKit::Set ( ImportOptionsKit const &  in_kit)

Copies the source ImportOptionsKit into this ImportOptionsKit.

Parameters
in_kitThe source ImportOptionsKit to copy.
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_segmentSegment that will be used when the import file tries to access segments above the root segment.
Returns
A reference to this ImportOptionsKit.
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_handlerAn ImportEventHandler to be set.
in_typeThe type of the Stream ImportEvent for which the given event handler will be used.
Returns
A reference to this ImportOptionsKit.
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_portfolioPortfolio that will be used for any definitions that need to be created during import.
Returns
A reference to this ImportOptionsKit.
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_segmentSegment the HSF data will be imported into.
Returns
A reference to this ImportOptionsKit.
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.
void HPS::Stream::ImportOptionsKit::Show ( ImportOptionsKit out_kit) const

Copies this ImportOptionsKit into the given ImportOptionsKit.

Parameters
out_kitThe ImportOptionsKit to populate with the contents of this ImportOptionsKit.
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_segmentSegment 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 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_portfolioPortfolio that will be used for any definitions that need to be created during import.
Returns
true if a portfolio was specified, false otherwise.
bool HPS::Stream::ImportOptionsKit::ShowSegment ( SegmentKey out_segment) const

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

Parameters
out_segmentSegment the HSF data will be imported into.
Returns
true if a root segment was specified, false otherwise.
bool HPS::Stream::ImportOptionsKit::ShowToolkit ( HPS::Stream::Toolkit out_toolkit) const

Shows the root toolkit used for the import process.

Parameters
out_toolkitThe Toolkit used for the import process.
Returns
true if a toolkit was specified, false otherwise.
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.
ImportOptionsKit& HPS::Stream::ImportOptionsKit::UnsetEventHandler ( intptr_t  in_type)

Unsets the ImportEventHandler for the indicated ImportEvent type.

Parameters
in_typeThe type of the Stream ImportEvent to unset.
Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& HPS::Stream::ImportOptionsKit::UnsetEventHandlers ( )

Unsets the ImportEventHandler for all ImportEvent types.

Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& HPS::Stream::ImportOptionsKit::UnsetEverything ( )

Removes all settings from this ImportOptionsKit.

Returns
A reference to this ImportOptionsKit.
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.
ImportOptionsKit& HPS::Stream::ImportOptionsKit::UnsetSegment ( )

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

Returns
A reference to this ImportOptionsKit.
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: