HPS::Stream::ImportResultsKit

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

The ImportResultsKit class contains the results of a successful HSF import.

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this ImportResultsKit has any values set on it.

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

bool Equals (HPS.Stream.ImportResultsKit in_kit)

Check if the source ImportResultsKit is equivalent to this ImportResultsKit.

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

override bool Equals (Object obj)

override int GetHashCode ()

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

ImportResultsKit (HPS.Stream.ImportResultsKit in_kit)

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

Param in_kit: The source ImportResultsKit 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.ImportResultsKit in_kit)

Copies the source ImportResultsKit into this ImportResultsKit.

Param in_kit: The source ImportResultsKit to copy.

HPS.Stream.ImportResultsKit SetAlternateCameras (string[] in_names, HPS.CameraKit[] in_cameras)

HPS.Stream.ImportResultsKit SetAlternateRoot (HPS.SegmentKey in_segment)

Sets the segment which was used when the import file tried to access segments above the root segment. This is really only used when generating an ImportResultsKit which is being returned to a user following an HSF import.

Param in_segment: Segment that was used when the import file tried to access segments above the root segment during import.
Return: A reference to this ImportResultsKit.

HPS.Stream.ImportResultsKit SetDefaultCamera (HPS.CameraKit in_camera)

Sets the “default” camera for this ImportResultsKit. This is generally only used during a Stream Import to record the default camera read from the Stream file.

Param in_camera: The “default” named camera from the HSF file.
Return: A reference to this ImportResultsKit.

HPS.Stream.ImportResultsKit SetPortfolio (HPS.PortfolioKey in_portfolio)

Sets the portfolio which was used for any definitions that had to be created during import. This is really only used when generating an ImportResultsKit which is being returned to a user following an HSF import.

Param in_portfolio: Portfolio that was used for any definitions that had to be created during import.
Return: A reference to this ImportResultsKit.

HPS.Stream.ImportResultsKit SetSegment (HPS.SegmentKey in_segment)

Sets the root segment which the HSF data was imported into. This is really only used when generating an ImportResultsKit which is being returned to a user following an HSF import.

Param in_segment: Segment the HSF data was imported into.
Return: A reference to this ImportResultsKit.

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

Copies this ImportResultsKit into the given ImportResultsKit.

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

bool ShowAlternateCameras (out string[] out_names, out HPS.CameraKit[] out_cameras)

bool ShowAlternateRoot (out HPS.SegmentKey out_segment)

Shows the segment which was used when the import file tried to access segments above the root segment. This was either the alternate root specified by the user in the ImportOptionsKit passed to Stream.File.Import, or the root segment that was created for this purpose during import.

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

bool ShowDefaultCamera (out HPS.CameraKit out_camera)

Shows the “default” camera for this ImportOptionsKit. The “default” camera is set during a Stream Import. There can only be a single default camera in a Stream file.

Param out_camera: The “default” camera from the Stream file.
Return: true if a default camera was specified, false otherwise.

bool ShowPortfolio (out HPS.PortfolioKey out_portfolio)

Shows the portfolio which was used for any definitions that had to be created during import. This was either the portfolio specified by the user in the ImportOptionsKit passed to Stream.File.Import, or the portfolio that was created for this purpose during import.

Param out_portfolio: Portfolio that was used for any definitions that had 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 which the HSF data was imported into. This was either the root segment specified by the user in the ImportOptionsKit passed to Stream.File.Import, or the root segment that was created for this purpose during import.

Param out_segment: Segment the HSF data was imported into.
Return: true if a root segment was specified, false otherwise.

HPS.Stream.ImportResultsKit UnsetAlternateCameras ()

Removes the alternate named cameras that were present in the HSF file. This is really only used when generating an ImportResultsKit which is being returned to a user following an HSF import.

Return: A reference to this ImportResultsKit.

HPS.Stream.ImportResultsKit UnsetAlternateRoot ()

Removes the segment which was used when the import file tried to access segments above the root segment. This is really only used when generating an ImportResultsKit which is being returned to a user following an HSF import.

Return: A reference to this ImportResultsKit.

HPS.Stream.ImportResultsKit UnsetDefaultCamera ()

Removes the “default” camera from this ImportResultsKit. This is generally only used for ImportResultsKits that are generated from a Stream import.

Return: A reference to this ImportResultsKit.

HPS.Stream.ImportResultsKit UnsetEverything ()

Removes all settings from this ImportResultsKit.

Return: A reference to this ImportResultsKit.

HPS.Stream.ImportResultsKit UnsetPortfolio ()

Removes the portfolio which was used for any definitions that had to be created during import. This is really only used when generating an ImportResultsKit which is being returned to a user following an HSF import.

Return: A reference to this ImportResultsKit.

HPS.Stream.ImportResultsKit UnsetSegment ()

Removes the root segment which the HSF data was imported into. This is really only used when generating an ImportResultsKit which is being returned to a user following an HSF import.

Return: A reference to this ImportResultsKit.

Public Static Functions

bool operator!= (HPS.Stream.ImportResultsKit a, HPS.Stream.ImportResultsKit b)

bool operator== (HPS.Stream.ImportResultsKit a, HPS.Stream.ImportResultsKit b)