Inheritance diagram for HPS.Stream.ImportOptionsKit:
HPS.Kit HPS.Object

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Stream.ImportOptionsKit in_kit)
 
override int GetHashCode ()
 
 ImportOptionsKit ()
 
 ImportOptionsKit (HPS.Stream.ImportOptionsKit in_kit)
 
override HPS.Type ObjectType ()
 
void Set (HPS.Stream.ImportOptionsKit in_kit)
 
HPS.Stream.ImportOptionsKit SetAlternateRoot (HPS.SegmentKey in_segment)
 
HPS.Stream.ImportOptionsKit SetEventHandler (HPS.Stream.ImportEventHandler in_handler, IntPtr in_type)
 
HPS.Stream.ImportOptionsKit SetPortfolio (HPS.PortfolioKey in_portfolio)
 
HPS.Stream.ImportOptionsKit SetSegment (HPS.SegmentKey in_segment)
 
HPS.Stream.ImportOptionsKit SetToolkit (HPS.Stream.Toolkit in_toolkit)
 
void Show (out HPS.Stream.ImportOptionsKit out_kit)
 
bool ShowAlternateRoot (out HPS.SegmentKey out_segment)
 
bool ShowPortfolio (out HPS.PortfolioKey out_portfolio)
 
bool ShowSegment (out HPS.SegmentKey out_segment)
 
bool ShowToolkit (out HPS.Stream.Toolkit out_toolkit)
 
HPS.Stream.ImportOptionsKit UnsetAlternateRoot ()
 
HPS.Stream.ImportOptionsKit UnsetEventHandler (IntPtr in_type)
 
HPS.Stream.ImportOptionsKit UnsetEventHandlers ()
 
HPS.Stream.ImportOptionsKit UnsetEverything ()
 
HPS.Stream.ImportOptionsKit UnsetPortfolio ()
 
HPS.Stream.ImportOptionsKit UnsetSegment ()
 
HPS.Stream.ImportOptionsKit UnsetToolkit ()
 
- Public Member Functions inherited from HPS.Kit
Kit (HPS.Kit in_that)
 
override HPS.Type Type ()
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
Object (HPS.Object that)
 
virtual void Reset ()
 

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 Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

The ImportOptionsKit class contains any settings controlling the import of HSF files.

Constructor & Destructor Documentation

◆ ImportOptionsKit() [1/2]

HPS.Stream.ImportOptionsKit.ImportOptionsKit ( )
inline

The default constructor creates an empty ImportOptionsKit object.

◆ ImportOptionsKit() [2/2]

HPS.Stream.ImportOptionsKit.ImportOptionsKit ( HPS.Stream.ImportOptionsKit  in_kit)
inline

The copy constructor creates a new ImportOptionsKit object that contains the same settings as the source ImportOptionsKit.

Parameters
in_kitThe source ImportOptionsKit to copy.

Member Function Documentation

◆ Empty()

override bool HPS.Stream.ImportOptionsKit.Empty ( )
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.

◆ Equals()

bool HPS.Stream.ImportOptionsKit.Equals ( HPS.Stream.ImportOptionsKit  in_kit)
inline

Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit.

Parameters
in_kitThe source ImportOptionsKit to compare to this ImportOptionsKit.
Returns
true if the objects are equivalent, false otherwise.

◆ 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()

void HPS.Stream.ImportOptionsKit.Set ( HPS.Stream.ImportOptionsKit  in_kit)
inline

Copies the source ImportOptionsKit into this ImportOptionsKit.

Parameters
in_kitThe source ImportOptionsKit to copy.

◆ SetAlternateRoot()

HPS.Stream.ImportOptionsKit HPS.Stream.ImportOptionsKit.SetAlternateRoot ( HPS.SegmentKey  in_segment)
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_segmentSegment that will be used when the import file tries to access segments above the root segment.
Returns
A reference to this ImportOptionsKit.

◆ SetEventHandler()

HPS.Stream.ImportOptionsKit HPS.Stream.ImportOptionsKit.SetEventHandler ( HPS.Stream.ImportEventHandler  in_handler,
IntPtr  in_type 
)
inline

Sets the specified ImportEventHandler for the indicated ImportEvent type.

Parameters
in_handlerAn ImportEventHandler to be set.
in_typeThe type of the StreamImportEvent for which the given event handler will be used.
Returns
A reference to this ImportOptionsKit.

◆ SetPortfolio()

HPS.Stream.ImportOptionsKit HPS.Stream.ImportOptionsKit.SetPortfolio ( HPS.PortfolioKey  in_portfolio)
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_portfolioPortfolio that will be used for any definitions that need to be created during import.
Returns
A reference to this ImportOptionsKit.

◆ SetSegment()

HPS.Stream.ImportOptionsKit HPS.Stream.ImportOptionsKit.SetSegment ( HPS.SegmentKey  in_segment)
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_segmentSegment the HSF data will be imported into.
Returns
A reference to this ImportOptionsKit.

◆ SetToolkit()

HPS.Stream.ImportOptionsKit HPS.Stream.ImportOptionsKit.SetToolkit ( HPS.Stream.Toolkit  in_toolkit)
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.

◆ Show()

void HPS.Stream.ImportOptionsKit.Show ( out HPS.Stream.ImportOptionsKit  out_kit)
inline

Copies this ImportOptionsKit into the given ImportOptionsKit.

Parameters
out_kitThe ImportOptionsKit to populate with the contents of this ImportOptionsKit.

◆ 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_segmentSegment 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_portfolioPortfolio 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_segmentSegment the HSF data will be imported into.
Returns
true if a root segment was specified, false otherwise.

◆ ShowToolkit()

bool HPS.Stream.ImportOptionsKit.ShowToolkit ( out HPS.Stream.Toolkit  out_toolkit)
inline

Shows the root toolkit used for the import process.

Parameters
out_toolkitThe Toolkit used for the import process.
Returns
true if a toolkit was specified, false otherwise.

◆ UnsetAlternateRoot()

HPS.Stream.ImportOptionsKit HPS.Stream.ImportOptionsKit.UnsetAlternateRoot ( )
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.

◆ UnsetEventHandler()

HPS.Stream.ImportOptionsKit HPS.Stream.ImportOptionsKit.UnsetEventHandler ( IntPtr  in_type)
inline

Unsets the ImportEventHandler for the indicated ImportEvent type.

Parameters
in_typeThe type of the StreamImportEvent to unset.
Returns
A reference to this ImportOptionsKit.

◆ UnsetEventHandlers()

HPS.Stream.ImportOptionsKit HPS.Stream.ImportOptionsKit.UnsetEventHandlers ( )
inline

Unsets the ImportEventHandler for all ImportEvent types.

Returns
A reference to this ImportOptionsKit.

◆ UnsetEverything()

HPS.Stream.ImportOptionsKit HPS.Stream.ImportOptionsKit.UnsetEverything ( )
inline

Removes all settings from this ImportOptionsKit.

Returns
A reference to this ImportOptionsKit.

◆ UnsetPortfolio()

HPS.Stream.ImportOptionsKit HPS.Stream.ImportOptionsKit.UnsetPortfolio ( )
inline

Removes the portfolio which will be used for any definitions that need to be created during import.

Returns
A reference to this ImportOptionsKit.

◆ UnsetSegment()

HPS.Stream.ImportOptionsKit HPS.Stream.ImportOptionsKit.UnsetSegment ( )
inline

Removes the root segment speciyfing where the HSF data will be imported into.

Returns
A reference to this ImportOptionsKit.

◆ UnsetToolkit()

HPS.Stream.ImportOptionsKit HPS.Stream.ImportOptionsKit.UnsetToolkit ( )
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