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

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.OOC.ImportOptionsKit in_kit)
 
override int GetHashCode ()
 
 ImportOptionsKit ()
 
 ImportOptionsKit (HPS.OOC.ImportOptionsKit in_kit)
 
override HPS.Type ObjectType ()
 
void Set (HPS.OOC.ImportOptionsKit in_kit)
 
HPS.OOC.ImportOptionsKit SetAreaHighlightTracker (HPS.OOC.AreaHighlightTracker in_area_highlight_tracker)
 
HPS.OOC.ImportOptionsKit SetCenterBounding (bool in_center_bounding)
 
HPS.OOC.ImportOptionsKit SetManualUpdates (bool in_manual_updates)
 
HPS.OOC.ImportOptionsKit SetTarget (HPS.Model in_target)
 
HPS.OOC.ImportOptionsKit SetTranslation (double in_x, double in_y, double in_z)
 
void Show (out HPS.OOC.ImportOptionsKit out_kit)
 
bool ShowCenterBounding (out bool out_center_bounding)
 
bool ShowManualUpdates (out bool out_manual_updates)
 
bool ShowTarget (out HPS.Model out_model)
 
bool ShowTranslation (out double out_x, out double out_y, out double out_z)
 
HPS.OOC.ImportOptionsKit UnsetAreaHighlightTracker ()
 
HPS.OOC.ImportOptionsKit UnsetCenterBounding ()
 
HPS.OOC.ImportOptionsKit UnsetEverything ()
 
HPS.OOC.ImportOptionsKit UnsetManualUpdates ()
 
HPS.OOC.ImportOptionsKit UnsetTarget ()
 
HPS.OOC.ImportOptionsKit UnsetTranslation ()
 
- 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.OOC.ImportOptionsKit GetDefault ()
 
static bool operator!= (HPS.OOC.ImportOptionsKit a, HPS.OOC.ImportOptionsKit b)
 
static bool operator== (HPS.OOC.ImportOptionsKit a, HPS.OOC.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 is a user space object. It contains settings controlling what and how data is imported via OOC.

Constructor & Destructor Documentation

◆ ImportOptionsKit() [1/2]

HPS.OOC.ImportOptionsKit.ImportOptionsKit ( )
inline

The default constructor creates an empty ImportOptionsKit object.

◆ ImportOptionsKit() [2/2]

HPS.OOC.ImportOptionsKit.ImportOptionsKit ( HPS.OOC.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.OOC.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.OOC.ImportOptionsKit.Equals ( HPS.OOC.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.OOC.ImportOptionsKit HPS.OOC.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.OOC.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.OOC.ImportOptionsKit.Set ( HPS.OOC.ImportOptionsKit  in_kit)
inline

Copies the source ImportOptionsKit into this ImportOptionsKit.

Parameters
in_kitThe source ImportOptionsKit to copy.

◆ SetAreaHighlightTracker()

HPS.OOC.ImportOptionsKit HPS.OOC.ImportOptionsKit.SetAreaHighlightTracker ( HPS.OOC.AreaHighlightTracker  in_area_highlight_tracker)
inline

Sets the AreaHighlightTracker.

Note
You should pass in an instance of a class that derives from AreaHighlightTracker that implements your desired behavior.
Parameters
in_area_highlight_trackerThe AreaHighlightTracker to use for this
Returns
A reference to this ImportOptionsKit.

◆ SetCenterBounding()

HPS.OOC.ImportOptionsKit HPS.OOC.ImportOptionsKit.SetCenterBounding ( bool  in_center_bounding)
inline

Configures the model set a transform to the center of the bounding.

Parameters
in_center_boundingThe new center bounding setting
Returns
A reference to this ImportOptionsKit.

◆ SetManualUpdates()

HPS.OOC.ImportOptionsKit HPS.OOC.ImportOptionsKit.SetManualUpdates ( bool  in_manual_updates)
inline

Configures the model to only load based on manual updates.

Parameters
in_manual_updatesThe new manual update setting
Returns
A reference to this ImportOptionsKit.

◆ SetTarget()

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

Uses the Model to set the root segment, library segment, and portfolio where the data will be imported.

Returns
A reference to this ImportOptionsKit.

◆ SetTranslation()

HPS.OOC.ImportOptionsKit HPS.OOC.ImportOptionsKit.SetTranslation ( double  in_x,
double  in_y,
double  in_z 
)
inline

Configures a translate to be set on the model.

Parameters
in_xThe x translate
in_yThe y translate
in_zThe z translate
Returns
A reference to this ImportOptionsKit.

◆ Show()

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

Copies this ImportOptionsKit into the given ImportOptionsKit.

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

◆ ShowCenterBounding()

bool HPS.OOC.ImportOptionsKit.ShowCenterBounding ( out bool  out_center_bounding)
inline

Shows if the model is configured to transform to the center of the bounding.

Parameters
out_center_boundingThe current center bounding setting
Returns
Returns false if there is no manual update setting.

◆ ShowManualUpdates()

bool HPS.OOC.ImportOptionsKit.ShowManualUpdates ( out bool  out_manual_updates)
inline

Shows if the model is configured to only load based on manual updates.

Parameters
out_manual_updatesThe current manual update setting
Returns
Returns false if there is no manual update setting.

◆ ShowTarget()

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

Shows the root and library segments and portfolio where the data will be imported. If no segments are specified, root segments will be created for this purpose during import.

Parameters
out_modelModel to use to implicitly set Segment, Library and Portfolio into which the data will be imported.
Returns
Returns false if there is no target, false otherwise.

◆ ShowTranslation()

bool HPS.OOC.ImportOptionsKit.ShowTranslation ( out double  out_x,
out double  out_y,
out double  out_z 
)
inline

Shows if a translate is set.

Parameters
out_xThe x translate
out_yThe y translate
out_zThe z translate
Returns
Returns false if there is no manual update setting.

◆ UnsetAreaHighlightTracker()

HPS.OOC.ImportOptionsKit HPS.OOC.ImportOptionsKit.UnsetAreaHighlightTracker ( )
inline

Removes the AreaHighlightTracker.

Returns
A reference to this ImportOptionsKit.

◆ UnsetCenterBounding()

HPS.OOC.ImportOptionsKit HPS.OOC.ImportOptionsKit.UnsetCenterBounding ( )
inline

Removes the center bounding setting.

Returns
A reference to this ImportOptionsKit.

◆ UnsetEverything()

HPS.OOC.ImportOptionsKit HPS.OOC.ImportOptionsKit.UnsetEverything ( )
inline

Removes all settings from this ImportOptionsKit.

Returns
A reference to this ImportOptionsKit.

◆ UnsetManualUpdates()

HPS.OOC.ImportOptionsKit HPS.OOC.ImportOptionsKit.UnsetManualUpdates ( )
inline

Removes the manual update setting.

Returns
A reference to this ImportOptionsKit.

◆ UnsetTarget()

HPS.OOC.ImportOptionsKit HPS.OOC.ImportOptionsKit.UnsetTarget ( )
inline

Removes the target and library segments, and Model import state.

Returns
A reference to this ImportOptionsKit.

◆ UnsetTranslation()

HPS.OOC.ImportOptionsKit HPS.OOC.ImportOptionsKit.UnsetTranslation ( )
inline

Removes a translate setting.

Returns
A reference to this ImportOptionsKit.

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