HPS.Stream.ImportOptionsKit

class HPS.Stream.ImportOptionsKit : public HPS.Kit 

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

Public Functions

override bool Empty ()

Indicates whether this ImportOptionsKit has any values set on it.

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

bool Equals (HPS.Stream.ImportOptionsKit in_kit)

Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit.

Param in_kit: The source ImportOptionsKit to compare to this ImportOptionsKit.
Return: true if the objects are equivalent, false otherwise.

ImportOptionsKit (): The default constructor creates an empty ImportOptionsKit object.

ImportOptionsKit (HPS.Stream.ImportOptionsKit in_kit)

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

Param in_kit: The source ImportOptionsKit to copy.

override HPS.Type ObjectType ()

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

Return: The declared type of the object in question, which may differ from the true, underlying type.

void Set (HPS.Stream.ImportOptionsKit in_kit)

Copies the source ImportOptionsKit into this ImportOptionsKit.

Param in_kit: The source ImportOptionsKit to copy.

HPS.Stream.ImportOptionsKit SetAlternateRoot (HPS.SegmentKey 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.

Param in_segment: Segment that will be used when the import file tries to access segments above the root segment.
Return: A reference to this ImportOptionsKit.

HPS.Stream.ImportOptionsKit SetEventHandler (HPS.Stream.ImportEventHandler in_handler, IntPtr in_type)

Sets the specified ImportEventHandler for the indicated ImportEvent type.

Param in_handler: An ImportEventHandler to be set.
Param in_type: The type of the StreamImportEvent for which the given event handler will be used.
Return: A reference to this ImportOptionsKit.

HPS.Stream.ImportOptionsKit SetPortfolio (HPS.PortfolioKey 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.

Param in_portfolio: Portfolio that will be used for any definitions that need to be created during import.
Return: A reference to this ImportOptionsKit.

HPS.Stream.ImportOptionsKit SetSegment (HPS.SegmentKey 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.

Param in_segment: Segment the HSF data will be imported into.
Return: A reference to this ImportOptionsKit.

HPS.Stream.ImportOptionsKit SetToolkit (HPS.Stream.Toolkit in_toolkit)

Sets the toolkit used for the import process. If no tooklkit is specified, a default tookit will be used during import.

Return: A reference to this ImportOptionsKit.

void Show (out HPS.Stream.ImportOptionsKit out_kit)

Copies this ImportOptionsKit into the given ImportOptionsKit.

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

bool ShowAlternateRoot (out HPS.SegmentKey out_segment)

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

Param out_segment: Segment that will be used when the import file tries to access segments above the root segment.
Return: true if an alternate root segment was specified, false otherwise.

bool ShowPortfolio (out HPS.PortfolioKey out_portfolio)

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

Param out_portfolio: Portfolio that will be used for any definitions that need to be created during import.
Return: true if a portfolio was specified, false otherwise.

bool ShowSegment (out HPS.SegmentKey out_segment)

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