The ImportResultsKit class contains the results of a successful HSF import. More...
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... | |
![]() | |
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 IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
HandleRef | cptr |
HandleRef | scptr |
bool | cMemOwn |
The ImportResultsKit class contains the results of a successful HSF import.
|
inline |
The default constructor creates an empty ImportResultsKit object.
|
inline |
The copy constructor creates a new ImportResultsKit object that contains the same settings as the source ImportResultsKit.
in_kit | The source ImportResultsKit to copy. |
|
inlinevirtual |
Indicates whether this ImportResultsKit has any values set on it.
Reimplemented from HPS.Object.
|
inline |
Check if the source ImportResultsKit is equivalent to this ImportResultsKit.
in_kit | The source ImportResultsKit to compare to this ImportResultsKit. |
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.
|
inline |
Copies the source ImportResultsKit into this ImportResultsKit.
in_kit | The source ImportResultsKit to copy. |
|
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.
in_names | The names of the cameras in the HSF file. |
in_cameras | The cameras in the HSF file. |
|
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.
in_segment | Segment that was used when the import file tried to access segments above the root segment during import. |
|
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.
in_camera | The "default" named camera from the HSF file. |
|
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.
in_portfolio | Portfolio that was used for any definitions that had to be created during import. |
|
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.
in_segment | Segment the HSF data was imported into. |
|
inline |
Copies this ImportResultsKit into the given ImportResultsKit.
out_kit | The ImportResultsKit to populate with the contents of this ImportResultsKit. |
|
inline |
Shows the alternate named cameras that were present in the HSF file. This includes all cameras other than "default".
out_names | The names of the cameras in the HSF file. |
out_cameras | The cameras in the HSF file. |
|
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.
out_segment | Segment that was used when the import file tried to access segments above the root segment. |
|
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.
out_camera | The "default" named camera from the HSF file. |
|
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.
out_portfolio | Portfolio that was used for any definitions that had to be created during import. |
|
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.
out_segment | Segment the HSF data was imported into. |
|
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.
|
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.
|
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.
|
inline |
Removes all settings from this ImportResultsKit.
|
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.
|
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.