Inheritance diagram for HPS.HCA.ImportOptionsKit:
HPS.Sprocket HPS.Object

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.HCA.ImportOptionsKit in_kit)
 
override int GetHashCode ()
 
 ImportOptionsKit ()
 
 ImportOptionsKit (HPS.HCA.ImportOptionsKit in_kit)
 
override HPS.Type ObjectType ()
 
void Set (HPS.HCA.ImportOptionsKit in_kit)
 
HPS.HCA.ImportOptionsKit SetJavascriptPath (string javascript_path)
 
HPS.HCA.ImportOptionsKit SetTarget (HPS.Model in_target)
 
HPS.HCA.ImportOptionsKit SetView (HPS.View in_view)
 
void Show (out HPS.HCA.ImportOptionsKit out_kit)
 
bool ShowJavascriptPath (out string out_javascript_path)
 
bool ShowTarget (out HPS.Model out_model)
 
bool ShowView (out HPS.View out_view)
 
HPS.HCA.ImportOptionsKit UnsetEverything ()
 
HPS.HCA.ImportOptionsKit UnsetJavascriptPath ()
 
HPS.HCA.ImportOptionsKit UnsetTarget ()
 
HPS.HCA.ImportOptionsKit UnsetView ()
 
- Public Member Functions inherited from HPS.Sprocket
Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

Static Public Member Functions

static HPS.HCA.ImportOptionsKit GetDefault ()
 
static bool operator!= (HPS.HCA.ImportOptionsKit a, HPS.HCA.ImportOptionsKit b)
 
static bool operator== (HPS.HCA.ImportOptionsKit a, HPS.HCA.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 HPS.HCA.ImportOptionsKit class is a user space object. It contains settings controlling what and how Stream Cache data is imported via the HCA Sprocket.

Constructor & Destructor Documentation

◆ ImportOptionsKit() [1/2]

HPS.HCA.ImportOptionsKit.ImportOptionsKit ( )
inline

The default constructor creates an empty ImportOptionsKit object.

◆ ImportOptionsKit() [2/2]

HPS.HCA.ImportOptionsKit.ImportOptionsKit ( HPS.HCA.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.HCA.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.HCA.ImportOptionsKit.Equals ( HPS.HCA.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.

◆ GetDefault()

static HPS.HCA.ImportOptionsKit HPS.HCA.ImportOptionsKit.GetDefault ( )
inlinestatic

Creates an ImportOptionsKit which contains the default settings. The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default. These values will be used for import unless an option is overridden by the options passed to File.Import.

Returns
An ImportOptionsKit with the default settings.

◆ ObjectType()

override HPS.Type HPS.HCA.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.Object.

◆ Set()

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

Copies the source ImportOptionsKit into this ImportOptionsKit.

Parameters
in_kitThe source ImportOptionsKit to copy.

◆ SetTarget()

HPS.HCA.ImportOptionsKit HPS.HCA.ImportOptionsKit.SetTarget ( HPS.Model  in_target)
inline

Sets a Model to be used as part of the import. Geometry will be imported in the model Segment, and definitions will be added to the Portfolio associated with the Model provided. Setting a target is required for the import to succeed.

Returns
A reference to this ImportOptionsKit.

◆ SetView()

HPS.HCA.ImportOptionsKit HPS.HCA.ImportOptionsKit.SetView ( HPS.View  in_view)
inline

Sets a View to be used as part of the import. Setting a View is required for the import to succeed.

Parameters
in_viewView to use for camera tracking.
Returns
A reference to this ImportOptionsKit.

◆ Show()

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

Copies this ImportOptionsKit into the given ImportOptionsKit.

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

◆ ShowJavascriptPath()

bool HPS.HCA.ImportOptionsKit.ShowJavascriptPath ( out string  out_javascript_path)
inline

Shows the path that will be used to find hc_access.js during import.

Parameters
out_javascript_pathThe path used to reach hc_access.js.
Returns
Returns false if a javascript path setting was not specified, false otherwise.

◆ ShowTarget()

bool HPS.HCA.ImportOptionsKit.ShowTarget ( out HPS.Model  out_model)
inline

Shows the target import setting.

Parameters
out_modelModel to use to implicitly set Segment, Library and Portfolio into which the data will be imported.
Returns
Returns false if a target setting was not specified, false otherwise.

◆ ShowView()

bool HPS.HCA.ImportOptionsKit.ShowView ( out HPS.View  out_view)
inline

Shows the view import setting.

Parameters
out_viewView to use.
Returns
Returns false if a view setting was not specified, false otherwise.

◆ UnsetEverything()

HPS.HCA.ImportOptionsKit HPS.HCA.ImportOptionsKit.UnsetEverything ( )
inline

Removes all settings from this ImportOptionsKit.

Returns
A reference to this ImportOptionsKit.

◆ UnsetJavascriptPath()

HPS.HCA.ImportOptionsKit HPS.HCA.ImportOptionsKit.UnsetJavascriptPath ( )
inline

Removes javascript path import setting.

Returns
A reference to this ImportOptionsKit.

◆ UnsetTarget()

HPS.HCA.ImportOptionsKit HPS.HCA.ImportOptionsKit.UnsetTarget ( )
inline

Removes the target import setting.

Returns
A reference to this ImportOptionsKit.

◆ UnsetView()

HPS.HCA.ImportOptionsKit HPS.HCA.ImportOptionsKit.UnsetView ( )
inline

Removes the view import setting.

Returns
A reference to this ImportOptionsKit.

The documentation for this class was generated from the following file:
  • internals/hps_sprk_hca/source/cs/HPS.HCA.cs