|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
bool | cMemOwn |
|
HandleRef | cptr |
|
The ImportOptionsKit class contains any settings controlling the import of HSF files.
◆ ImportOptionsKit() [1/2]
HPS.Stream.ImportOptionsKit.ImportOptionsKit |
( |
| ) |
|
|
inline |
◆ ImportOptionsKit() [2/2]
◆ Empty()
override bool HPS.Stream.ImportOptionsKit.Empty |
( |
| ) |
|
|
inlinevirtual |
◆ Equals()
◆ ObjectType()
override HPS.Type HPS.Stream.ImportOptionsKit.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()
◆ SetAlternateRoot()
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.
- Parameters
-
in_segment | Segment that will be used when the import file tries to access segments above the root segment. |
- Returns
- A reference to this ImportOptionsKit.
◆ SetEventHandler()
◆ SetPortfolio()
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.
- Parameters
-
in_portfolio | Portfolio that will be used for any definitions that need to be created during import. |
- Returns
- A reference to this ImportOptionsKit.
◆ SetSegment()
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.
- Parameters
-
in_segment | Segment the HSF data will be imported into. |
- Returns
- A reference to this ImportOptionsKit.
◆ SetToolkit()
Sets the toolkit used for the import process. If no tooklkit is specified, a default tookit will be used during import.
- Returns
- A reference to this ImportOptionsKit.
◆ Show()
◆ ShowAlternateRoot()
bool HPS.Stream.ImportOptionsKit.ShowAlternateRoot |
( |
out HPS.SegmentKey |
out_segment | ) |
|
|
inline |
Shows the segment which will be used when the import file tries to access segments above the root segment.
- Parameters
-
out_segment | Segment that will be used when the import file tries to access segments above the root segment. |
- Returns
- true if an alternate root segment was specified, false otherwise.
◆ ShowPortfolio()
bool HPS.Stream.ImportOptionsKit.ShowPortfolio |
( |
out HPS.PortfolioKey |
out_portfolio | ) |
|
|
inline |
Shows the portfolio which will be used for any definitions that need to be created during import.
- Parameters
-
out_portfolio | Portfolio that will be used for any definitions that need to be created during import. |
- Returns
- true if a portfolio was specified, false otherwise.
◆ ShowSegment()
bool HPS.Stream.ImportOptionsKit.ShowSegment |
( |
out HPS.SegmentKey |
out_segment | ) |
|
|
inline |
Shows the root segment where the HSF data will be imported into.
- Parameters
-
out_segment | Segment the HSF data will be imported into. |
- Returns
- true if a root segment was specified, false otherwise.
◆ ShowToolkit()
Shows the root toolkit used for the import process.
- Parameters
-
out_toolkit | The Toolkit used for the import process. |
- Returns
- true if a toolkit was specified, false otherwise.
◆ UnsetAlternateRoot()
Removes the segment which will be used when the import file tries to access segments above the root segment.
- Returns
- A reference to this ImportOptionsKit.
◆ UnsetEventHandler()
◆ UnsetEventHandlers()
◆ UnsetEverything()
◆ UnsetPortfolio()
Removes the portfolio which will be used for any definitions that need to be created during import.
- Returns
- A reference to this ImportOptionsKit.
◆ UnsetSegment()
Removes the root segment speciyfing where the HSF data will be imported into.
- Returns
- A reference to this ImportOptionsKit.
◆ UnsetToolkit()
Removes the toolkit used for the import process.
- Returns
- A reference to this ImportOptionsKit.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.Stream.cs