Inheritance diagram for HPS.Stream.ImportResultsKit:
HPS.Kit HPS.Object

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Stream.ImportResultsKit in_kit)
 
override int GetHashCode ()
 
 ImportResultsKit ()
 
 ImportResultsKit (HPS.Stream.ImportResultsKit in_kit)
 
override HPS.Type ObjectType ()
 
void Set (HPS.Stream.ImportResultsKit in_kit)
 
HPS.Stream.ImportResultsKit SetAlternateCameras (string[] in_names, HPS.CameraKit[] in_cameras)
 
HPS.Stream.ImportResultsKit SetAlternateRoot (HPS.SegmentKey in_segment)
 
HPS.Stream.ImportResultsKit SetDefaultCamera (HPS.CameraKit in_camera)
 
HPS.Stream.ImportResultsKit SetPortfolio (HPS.PortfolioKey in_portfolio)
 
HPS.Stream.ImportResultsKit SetSegment (HPS.SegmentKey in_segment)
 
void Show (out HPS.Stream.ImportResultsKit out_kit)
 
bool ShowAlternateCameras (out string[] out_names, out HPS.CameraKit[] out_cameras)
 
bool ShowAlternateRoot (out HPS.SegmentKey out_segment)
 
bool ShowDefaultCamera (out HPS.CameraKit out_camera)
 
bool ShowPortfolio (out HPS.PortfolioKey out_portfolio)
 
bool ShowSegment (out HPS.SegmentKey out_segment)
 
HPS.Stream.ImportResultsKit UnsetAlternateCameras ()
 
HPS.Stream.ImportResultsKit UnsetAlternateRoot ()
 
HPS.Stream.ImportResultsKit UnsetDefaultCamera ()
 
HPS.Stream.ImportResultsKit UnsetEverything ()
 
HPS.Stream.ImportResultsKit UnsetPortfolio ()
 
HPS.Stream.ImportResultsKit UnsetSegment ()
 
- Public Member Functions inherited from HPS.Kit
Kit (HPS.Kit in_that)
 
override HPS.Type Type ()
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
Object (HPS.Object that)
 
virtual void Reset ()
 

Static Public Member Functions

static bool operator!= (HPS.Stream.ImportResultsKit a, HPS.Stream.ImportResultsKit b)
 
static bool operator== (HPS.Stream.ImportResultsKit a, HPS.Stream.ImportResultsKit b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

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

Constructor & Destructor Documentation

◆ ImportResultsKit() [1/2]

HPS.Stream.ImportResultsKit.ImportResultsKit ( )
inline

The default constructor creates an empty ImportResultsKit object.

◆ ImportResultsKit() [2/2]

HPS.Stream.ImportResultsKit.ImportResultsKit ( HPS.Stream.ImportResultsKit  in_kit)
inline

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

Parameters
in_kitThe source ImportResultsKit to copy.

Member Function Documentation

◆ Empty()

override bool HPS.Stream.ImportResultsKit.Empty ( )
inlinevirtual

Indicates whether this ImportResultsKit has any values set on it.

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

Reimplemented from HPS.Object.

◆ Equals()

bool HPS.Stream.ImportResultsKit.Equals ( HPS.Stream.ImportResultsKit  in_kit)
inline

Check if the source ImportResultsKit is equivalent to this ImportResultsKit.

Parameters
in_kitThe source ImportResultsKit to compare to this ImportResultsKit.
Returns
true if the objects are equivalent, false otherwise.

◆ ObjectType()

override HPS.Type HPS.Stream.ImportResultsKit.ObjectType ( )
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.

◆ Set()

void HPS.Stream.ImportResultsKit.Set ( HPS.Stream.ImportResultsKit  in_kit)
inline

Copies the source ImportResultsKit into this ImportResultsKit.

Parameters
in_kitThe source ImportResultsKit to copy.

◆ SetAlternateRoot()

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

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.

Parameters
in_segmentSegment that was used when the import file tried to access segments above the root segment during import.
Returns
A reference to this ImportResultsKit.

◆ SetDefaultCamera()

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

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.

Parameters
in_cameraThe "default" named camera from the HSF file.
Returns
A reference to this ImportResultsKit.

◆ SetPortfolio()

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

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.

Parameters
in_portfolioPortfolio that was used for any definitions that had to be created during import.
Returns
A reference to this ImportResultsKit.

◆ SetSegment()

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

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.

Parameters
in_segmentSegment the HSF data was imported into.
Returns
A reference to this ImportResultsKit.

◆ Show()

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

Copies this ImportResultsKit into the given ImportResultsKit.

Parameters
out_kitThe ImportResultsKit to populate with the contents of this ImportResultsKit.

◆ ShowAlternateRoot()

bool HPS.Stream.ImportResultsKit.ShowAlternateRoot ( out HPS.SegmentKey  out_segment)
inline

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.

Parameters
out_segmentSegment that was used when the import file tried to access segments above the root segment.
Returns
true if an alternate root segment was specified, false otherwise.

◆ ShowDefaultCamera()

bool HPS.Stream.ImportResultsKit.ShowDefaultCamera ( out HPS.CameraKit  out_camera)
inline

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.

Parameters
out_cameraThe "default" camera from the Stream file.
Returns
true if a default camera was specified, false otherwise.

◆ ShowPortfolio()

bool HPS.Stream.ImportResultsKit.ShowPortfolio ( out HPS.PortfolioKey  out_portfolio)
inline

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.

Parameters
out_portfolioPortfolio that was used for any definitions that had to be created during import.
Returns
true if a portfolio was specified, false otherwise.

◆ ShowSegment()

bool HPS.Stream.ImportResultsKit.ShowSegment ( out HPS.SegmentKey  out_segment)
inline

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.

Parameters
out_segmentSegment the HSF data was imported into.
Returns
true if a root segment was specified, false otherwise.

◆ UnsetAlternateCameras()

HPS.Stream.ImportResultsKit HPS.Stream.ImportResultsKit.UnsetAlternateCameras ( )
inline

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.

Returns
A reference to this ImportResultsKit.

◆ UnsetAlternateRoot()

HPS.Stream.ImportResultsKit HPS.Stream.ImportResultsKit.UnsetAlternateRoot ( )
inline

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.

Returns
A reference to this ImportResultsKit.

◆ UnsetDefaultCamera()

HPS.Stream.ImportResultsKit HPS.Stream.ImportResultsKit.UnsetDefaultCamera ( )
inline

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

Returns
A reference to this ImportResultsKit.

◆ UnsetEverything()

HPS.Stream.ImportResultsKit HPS.Stream.ImportResultsKit.UnsetEverything ( )
inline

Removes all settings from this ImportResultsKit.

Returns
A reference to this ImportResultsKit.

◆ UnsetPortfolio()

HPS.Stream.ImportResultsKit HPS.Stream.ImportResultsKit.UnsetPortfolio ( )
inline

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.

Returns
A reference to this ImportResultsKit.

◆ UnsetSegment()

HPS.Stream.ImportResultsKit HPS.Stream.ImportResultsKit.UnsetSegment ( )
inline

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.

Returns
A reference to this ImportResultsKit.

The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.Stream.cs