Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
HPS.Stream.ImportResultsKit Class Reference

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

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

Public Member Functions

override void Dispose ()
 
 ImportResultsKit ()
 The default constructor creates an empty ImportResultsKit object. More...
 
 ImportResultsKit (HPS.Stream.ImportResultsKit in_kit)
 The copy constructor creates a new ImportResultsKit object that contains the same settings as the source ImportResultsKit. More...
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More...
 
void Set (HPS.Stream.ImportResultsKit in_kit)
 Copies the source ImportResultsKit into this ImportResultsKit. More...
 
void Show (out HPS.Stream.ImportResultsKit out_kit)
 Copies this ImportResultsKit into the given ImportResultsKit. More...
 
override bool Empty ()
 Indicates whether this ImportResultsKit has any values set on it. More...
 
override bool Equals (System.Object obj)
 
override int GetHashCode ()
 
bool Equals (HPS.Stream.ImportResultsKit in_kit)
 Check if the source ImportResultsKit is equivalent to this ImportResultsKit. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
HPS.Stream.ImportResultsKit SetDefaultCamera (HPS.CameraKit in_camera)
 Sets the "default" named camera that was 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. More...
 
HPS.Stream.ImportResultsKit UnsetDefaultCamera ()
 Removes the "default" named camera that was 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. More...
 
bool ShowDefaultCamera (out HPS.CameraKit out_camera)
 Shows the "default" named camera that was present in the HSF file. There can only have been a single default camera in an HSF. More...
 
HPS.Stream.ImportResultsKit SetAlternateCameras (string[] in_names, HPS.CameraKit[] in_cameras)
 Sets 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. More...
 
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. More...
 
bool ShowAlternateCameras (out string[] out_names, out HPS.CameraKit[] out_cameras)
 Shows the alternate named cameras that were present in the HSF file. This includes all cameras other than "default". More...
 
HPS.Stream.ImportResultsKit UnsetEverything ()
 Removes all settings from this ImportResultsKit. More...
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
 Object (HPS.Object that)
 
HPS.Type Type ()
 This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More...
 

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
HandleRef cptr
 
HandleRef scptr
 
bool cMemOwn
 

Detailed Description

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

Constructor & Destructor Documentation

HPS.Stream.ImportResultsKit.ImportResultsKit ( )
inline

The default constructor creates an empty ImportResultsKit object.

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

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.

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

This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.

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

Reimplemented from HPS.Object.

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.
HPS.Stream.ImportResultsKit HPS.Stream.ImportResultsKit.SetAlternateCameras ( string[]  in_names,
HPS.CameraKit[]  in_cameras 
)
inline

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

Parameters
in_namesThe names of the cameras in the HSF file.
in_camerasThe cameras in the HSF file.
Returns
A reference to this ImportResultsKit.
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.
HPS.Stream.ImportResultsKit HPS.Stream.ImportResultsKit.SetDefaultCamera ( HPS.CameraKit  in_camera)
inline

Sets the "default" named camera that was 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.

Parameters
in_cameraThe "default" named camera from the HSF file.
Returns
A reference to this ImportResultsKit.
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.
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.
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.
bool HPS.Stream.ImportResultsKit.ShowAlternateCameras ( out string[]  out_names,
out HPS.CameraKit[]  out_cameras 
)
inline

Shows the alternate named cameras that were present in the HSF file. This includes all cameras other than "default".

Parameters
out_namesThe names of the cameras in the HSF file.
out_camerasThe cameras in the HSF file.
Returns
true if alternate cameras were specified, false otherwise.
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.
bool HPS.Stream.ImportResultsKit.ShowDefaultCamera ( out HPS.CameraKit  out_camera)
inline

Shows the "default" named camera that was present in the HSF file. There can only have been a single default camera in an HSF.

Parameters
out_cameraThe "default" named camera from the HSF file.
Returns
true if a default camera was specified, false otherwise.
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.
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.
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.
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.
HPS.Stream.ImportResultsKit HPS.Stream.ImportResultsKit.UnsetDefaultCamera ( )
inline

Removes the "default" named camera that was 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.
HPS.Stream.ImportResultsKit HPS.Stream.ImportResultsKit.UnsetEverything ( )
inline

Removes all settings from this ImportResultsKit.

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