
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 () |
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. If no segment is specified, a root segment will be created for this purpose during import. More... | |
HPS.Stream.ImportOptionsKit | SetEventHandler (HPS.Stream.ImportEventHandler in_handler, IntPtr in_type) |
Sets the specified ImportEventHandler for the indicated ImportEvent type. 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. If no portfolio is specified, a portfolio will be created for this purpose during import. More... | |
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. More... | |
HPS.Stream.ImportOptionsKit | SetToolkit (HPS.Stream.Toolkit in_toolkit) |
Sets the toolkit used for the import process. If no tooklkit is specified, a default tookit will be used during import. 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... | |
bool | ShowToolkit (out HPS.Stream.Toolkit out_toolkit) |
Shows the root toolkit used for the import process. 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 | UnsetEventHandler (IntPtr in_type) |
Unsets the ImportEventHandler for the indicated ImportEvent type. More... | |
HPS.Stream.ImportOptionsKit | UnsetEventHandlers () |
Unsets the ImportEventHandler for all ImportEvent types. 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... | |
HPS.Stream.ImportOptionsKit | UnsetToolkit () |
Removes the toolkit used for the import process. 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 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... | |
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.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 |
Detailed Description
The ImportOptionsKit class contains any settings controlling the import of HSF files.
Constructor & Destructor Documentation
|
inline |
The default constructor creates an empty ImportOptionsKit object.
|
inline |
The copy constructor creates a new ImportOptionsKit object that contains the same settings as the source ImportOptionsKit.
- Parameters
-
in_kit The source ImportOptionsKit to copy.
Member Function Documentation
|
inlinevirtual |
Indicates whether this ImportOptionsKit has any values set on it.
- Returns
- true if no values are set on this ImportOptionsKit, false otherwise.
Reimplemented from HPS.Object.
|
inline |
Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit.
- Parameters
-
in_kit The source ImportOptionsKit to compare to this ImportOptionsKit.
- Returns
- true if the objects are equivalent, false otherwise.
|
inline |
Copies the source ImportOptionsKit into this ImportOptionsKit.
- Parameters
-
in_kit The source ImportOptionsKit to copy.
|
inline |
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.
|
inline |
Sets the specified ImportEventHandler for the indicated ImportEvent type.
- Parameters
-
in_handler An ImportEventHandler to be set. in_type The type of the StreamImportEvent for which the given event handler will be used.
- Returns
- A reference to this ImportOptionsKit.
|
inline |
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.
|
inline |
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.
|
inline |
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.
|
inline |
Copies this ImportOptionsKit into the given ImportOptionsKit.
- Parameters
-
out_kit The ImportOptionsKit to populate with the contents of this ImportOptionsKit.
|
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.
|
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.
|
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.
|
inline |
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.
|
inline |
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.
|
inline |
Unsets the ImportEventHandler for the indicated ImportEvent type.
- Parameters
-
in_type The type of the StreamImportEvent to unset.
- Returns
- A reference to this ImportOptionsKit.
|
inline |
Unsets the ImportEventHandler for all ImportEvent types.
- Returns
- A reference to this ImportOptionsKit.
|
inline |
Removes all settings from this ImportOptionsKit.
- Returns
- A reference to this ImportOptionsKit.
|
inline |
Removes the portfolio which will be used for any definitions that need to be created during import.
- Returns
- A reference to this ImportOptionsKit.
|
inline |
Removes the root segment speciyfing where the HSF data will be imported into.
- Returns
- A reference to this ImportOptionsKit.
|
inline |
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