
Public Member Functions | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this ImportResultsKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.Stream.ImportResultsKit in_kit) |
Check if the source ImportResultsKit is equivalent to this ImportResultsKit. More... | |
override int | GetHashCode () |
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 (if the object is derived, this does not give the true type of the derived object). More... | |
void | Set (HPS.Stream.ImportResultsKit in_kit) |
Copies the source ImportResultsKit into this ImportResultsKit. 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 | 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 | 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. 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 | 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... | |
void | Show (out HPS.Stream.ImportResultsKit out_kit) |
Copies this ImportResultsKit into the given ImportResultsKit. 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... | |
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... | |
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. 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... | |
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 | 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... | |
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... | |
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. More... | |
HPS.Stream.ImportResultsKit | UnsetEverything () |
Removes all settings from this ImportResultsKit. 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... | |
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... | |
![]() | |
Kit (HPS.Kit in_that) | |
override 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... | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns the object's database handle, which can be used to determine which instance of a class the object is. For example, controls are simply aliases for segment keys that group related functions. Therefore, a SegmentKey and all of its controls would return the same instance id. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. 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 | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
The ImportResultsKit class contains the results of a successful HSF import.
Constructor & Destructor Documentation
◆ ImportResultsKit() [1/2]
|
inline |
The default constructor creates an empty ImportResultsKit object.
◆ ImportResultsKit() [2/2]
|
inline |
The copy constructor creates a new ImportResultsKit object that contains the same settings as the source ImportResultsKit.
- Parameters
-
in_kit The source ImportResultsKit to copy.
Member Function Documentation
◆ 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()
|
inline |
Check if the source ImportResultsKit is equivalent to this ImportResultsKit.
- Parameters
-
in_kit The source ImportResultsKit to compare to this ImportResultsKit.
- Returns
- true if the objects are equivalent, false otherwise.
◆ 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()
|
inline |
Copies the source ImportResultsKit into this ImportResultsKit.
- Parameters
-
in_kit The source ImportResultsKit to copy.
◆ SetAlternateCameras()
|
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_names The names of the cameras in the HSF file. in_cameras The cameras in the HSF file.
- Returns
- A reference to this ImportResultsKit.
◆ SetAlternateRoot()
|
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_segment Segment that was used when the import file tried to access segments above the root segment during import.
- Returns
- A reference to this ImportResultsKit.
◆ SetDefaultCamera()
|
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_camera The "default" named camera from the HSF file.
- Returns
- A reference to this ImportResultsKit.
◆ SetPortfolio()
|
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_portfolio Portfolio that was used for any definitions that had to be created during import.
- Returns
- A reference to this ImportResultsKit.
◆ SetSegment()
|
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_segment Segment the HSF data was imported into.
- Returns
- A reference to this ImportResultsKit.
◆ Show()
|
inline |
Copies this ImportResultsKit into the given ImportResultsKit.
- Parameters
-
out_kit The ImportResultsKit to populate with the contents of this ImportResultsKit.
◆ ShowAlternateCameras()
|
inline |
Shows the alternate named cameras that were present in the HSF file. This includes all cameras other than "default".
- Parameters
-
out_names The names of the cameras in the HSF file. out_cameras The cameras in the HSF file.
- Returns
- true if alternate cameras were specified, false otherwise.
◆ ShowAlternateRoot()
|
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_segment Segment 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()
|
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_camera The "default" camera from the Stream file.
- Returns
- true if a default camera was specified, false otherwise.
◆ ShowPortfolio()
|
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_portfolio Portfolio that was used for any definitions that had to be created during import.
- Returns
- true if a portfolio was specified, false otherwise.
◆ ShowSegment()
|
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_segment Segment the HSF data was imported into.
- Returns
- true if a root segment was specified, false otherwise.
◆ 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()
|
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()
|
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()
|
inline |
Removes all settings from this ImportResultsKit.
- Returns
- A reference to this 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()
|
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