REFERENCE MANUAL
The ImportOptionsKit class contains any settings controlling the import of HSF files. More...
Public Member Functions | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this ImportOptionsKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.Stream.ImportOptionsKit in_kit) |
Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit. More... | |
override int | GetHashCode () |
ImportOptionsKit () | |
The default constructor creates an empty ImportOptionsKit object. More... | |
ImportOptionsKit (HPS.Stream.ImportOptionsKit in_kit) | |
The copy constructor creates a new ImportOptionsKit object that contains the same settings as the source ImportOptionsKit. More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
void | Set (HPS.Stream.ImportOptionsKit in_kit) |
Copies the source ImportOptionsKit into this ImportOptionsKit. More... | |
HPS.Stream.ImportOptionsKit | SetAlternateRoot (HPS.SegmentKey in_segment) |
Sets the segment which will be used when the import file tries to access segments above the root segment. More... | |
HPS.Stream.ImportOptionsKit | SetPortfolio (HPS.PortfolioKey in_portfolio) |
Sets the portfolio which will be used for any definitions that need to be created during import. More... | |
HPS.Stream.ImportOptionsKit | SetSegment (HPS.SegmentKey in_segment) |
Sets the root segment where the HSF data will be imported into. More... | |
void | Show (out HPS.Stream.ImportOptionsKit out_kit) |
Copies this ImportOptionsKit into the given ImportOptionsKit. More... | |
bool | ShowAlternateRoot (out HPS.SegmentKey out_segment) |
Shows the segment which will be used when the import file tries to access segments above the root segment. More... | |
bool | ShowPortfolio (out HPS.PortfolioKey out_portfolio) |
Shows the portfolio which will be used for any definitions that need to be created during import. More... | |
bool | ShowSegment (out HPS.SegmentKey out_segment) |
Shows the root segment where the HSF data will be imported into. More... | |
HPS.Stream.ImportOptionsKit | UnsetAlternateRoot () |
Removes the segment which will be used when the import file tries to access segments above the root segment. More... | |
HPS.Stream.ImportOptionsKit | UnsetEverything () |
Removes all settings from this ImportOptionsKit. More... | |
HPS.Stream.ImportOptionsKit | UnsetPortfolio () |
Removes the portfolio which will be used for any definitions that need to be created during import. More... | |
HPS.Stream.ImportOptionsKit | UnsetSegment () |
Removes the root segment speciyfing where the HSF data will be imported into. More... | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object in_that) | |
The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
HPS.Type | Type () |
This function returns the true type of the underlying object. More... | |
Static Public Member Functions | |
static bool | operator!= (HPS.Stream.ImportOptionsKit a, HPS.Stream.ImportOptionsKit b) |
static bool | operator== (HPS.Stream.ImportOptionsKit a, HPS.Stream.ImportOptionsKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
The ImportOptionsKit class contains any settings controlling the import of HSF files.
HPS.Stream.ImportOptionsKit.ImportOptionsKit | ( | ) |
The default constructor creates an empty ImportOptionsKit object.
HPS.Stream.ImportOptionsKit.ImportOptionsKit | ( | HPS.Stream.ImportOptionsKit | in_kit | ) |
The copy constructor creates a new ImportOptionsKit object that contains the same settings as the source ImportOptionsKit.
in_kit | The source <ref refid="class_h_p_s_1_1_stream_1_1_import_options_kit" kindref="compound">ImportOptionsKit</ref> to copy. |
|
virtual |
Indicates whether this ImportOptionsKit has any values set on it.
Reimplemented from HPS.Object.
bool HPS.Stream.ImportOptionsKit.Equals | ( | HPS.Stream.ImportOptionsKit | in_kit | ) |
Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit.
in_kit | The source <ref refid="class_h_p_s_1_1_stream_1_1_import_options_kit" kindref="compound">ImportOptionsKit</ref> to compare to this <ref refid="class_h_p_s_1_1_stream_1_1_import_options_kit" kindref="compound">ImportOptionsKit</ref>. |
|
virtual |
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.
void HPS.Stream.ImportOptionsKit.Set | ( | HPS.Stream.ImportOptionsKit | in_kit | ) |
Copies the source ImportOptionsKit into this ImportOptionsKit.
in_kit | The source <ref refid="class_h_p_s_1_1_stream_1_1_import_options_kit" kindref="compound">ImportOptionsKit</ref> to copy. |
HPS.Stream.ImportOptionsKit HPS.Stream.ImportOptionsKit.SetAlternateRoot | ( | HPS.SegmentKey | in_segment | ) |
Sets the segment which will be used when the import file tries to access segments above the root segment.
If no segment is specified, a root segment will be created for this purpose during import.
in_segment | Segment that will be used when the import file tries to access segments above the root segment. |
HPS.Stream.ImportOptionsKit HPS.Stream.ImportOptionsKit.SetPortfolio | ( | HPS.PortfolioKey | in_portfolio | ) |
Sets the portfolio which will be used for any definitions that need to be created during import.
If no portfolio is specified, a portfolio will be created for this purpose during import.
in_portfolio | Portfolio that will be used for any definitions that need to be created during import. |
HPS.Stream.ImportOptionsKit HPS.Stream.ImportOptionsKit.SetSegment | ( | HPS.SegmentKey | in_segment | ) |
Sets the root segment where the HSF data will be imported into.
If no segment is specified, a root segment will be created for this purpose during import.
in_segment | Segment the HSF data will be imported into. |
void HPS.Stream.ImportOptionsKit.Show | ( | out HPS.Stream.ImportOptionsKit | out_kit | ) |
Copies this ImportOptionsKit into the given ImportOptionsKit.
out_kit | The <ref refid="class_h_p_s_1_1_stream_1_1_import_options_kit" kindref="compound">ImportOptionsKit</ref> to populate with the contents of this <ref refid="class_h_p_s_1_1_stream_1_1_import_options_kit" kindref="compound">ImportOptionsKit</ref>. |
bool HPS.Stream.ImportOptionsKit.ShowAlternateRoot | ( | out HPS.SegmentKey | out_segment | ) |
Shows the segment which will be used when the import file tries to access segments above the root segment.
out_segment | Segment that will be used when the import file tries to access segments above the root segment. |
bool HPS.Stream.ImportOptionsKit.ShowPortfolio | ( | out HPS.PortfolioKey | out_portfolio | ) |
Shows the portfolio which will be used for any definitions that need to be created during import.
out_portfolio | Portfolio that will be used for any definitions that need to be created during import. |
bool HPS.Stream.ImportOptionsKit.ShowSegment | ( | out HPS.SegmentKey | out_segment | ) |
Shows the root segment where the HSF data will be imported into.
out_segment | Segment the HSF data will be imported into. |
HPS.Stream.ImportOptionsKit HPS.Stream.ImportOptionsKit.UnsetAlternateRoot | ( | ) |
Removes the segment which will be used when the import file tries to access segments above the root segment.
HPS.Stream.ImportOptionsKit HPS.Stream.ImportOptionsKit.UnsetEverything | ( | ) |
Removes all settings from this ImportOptionsKit.
HPS.Stream.ImportOptionsKit HPS.Stream.ImportOptionsKit.UnsetPortfolio | ( | ) |
Removes the portfolio which will be used for any definitions that need to be created during import.
HPS.Stream.ImportOptionsKit HPS.Stream.ImportOptionsKit.UnsetSegment | ( | ) |
Removes the root segment speciyfing where the HSF data will be imported into.