#include <sprk_hca.h>

Public Member Functions | |
bool | Empty () const |
bool | Equals (ImportOptionsKit const &in_kit) const |
ImportOptionsKit () | |
ImportOptionsKit (ImportOptionsKit const &in_kit) | |
ImportOptionsKit (ImportOptionsKit &&in_that) | |
HPS::Type | ObjectType () const |
bool | operator!= (ImportOptionsKit const &in_kit) const |
ImportOptionsKit & | operator= (ImportOptionsKit &&in_that) |
ImportOptionsKit & | operator= (ImportOptionsKit const &in_kit) |
bool | operator== (ImportOptionsKit const &in_kit) const |
void | Set (ImportOptionsKit const &in_kit) |
ImportOptionsKit & | SetJavascriptPath (HPS::UTF8 const &javascript_path) |
ImportOptionsKit & | SetTarget (HPS::Model const &in_target) |
ImportOptionsKit & | SetView (HPS::View const &in_view) |
void | Show (ImportOptionsKit &out_kit) const |
bool | ShowJavascriptPath (HPS::UTF8 &out_javascript_path) const |
bool | ShowTarget (HPS::Model &out_model) const |
bool | ShowView (HPS::View &out_view) const |
ImportOptionsKit & | UnsetEverything () |
ImportOptionsKit & | UnsetJavascriptPath () |
ImportOptionsKit & | UnsetTarget () |
ImportOptionsKit & | UnsetView () |
![]() | |
Sprocket (Sprocket &&in_that) | |
![]() | |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
bool | HasType (HPS::Type in_mask) const |
Object (Object const &that) | |
Object (Object &&in_that) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual void | Reset () |
virtual HPS::Type | Type () const |
Static Public Member Functions | |
static ImportOptionsKit | GetDefault () |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Static Public Attributes | |
static const HPS::Type | staticType = HPS::Type::HCAImportOptionsKit |
![]() | |
static const HPS::Type | staticType = HPS::Type::None |
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/3]
HPS::HCA::ImportOptionsKit::ImportOptionsKit | ( | ) |
The default constructor creates an empty ImportOptionsKit object.
◆ ImportOptionsKit() [2/3]
HPS::HCA::ImportOptionsKit::ImportOptionsKit | ( | ImportOptionsKit const & | in_kit | ) |
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.
◆ ImportOptionsKit() [3/3]
HPS::HCA::ImportOptionsKit::ImportOptionsKit | ( | ImportOptionsKit && | in_that | ) |
The move constructor creates an ImportOptionsKit by transferring the underlying impl of the rvalue reference to this ImportOptionsKit thereby avoiding a copy and allocation.
- Parameters
-
in_that An rvalue reference to an ImportOptionsKit to take the impl from.
Member Function Documentation
◆ Empty()
|
virtual |
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 | ( | ImportOptionsKit const & | in_kit | ) | const |
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.
◆ GetDefault()
|
static |
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()
|
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.
◆ operator!=()
bool HPS::HCA::ImportOptionsKit::operator!= | ( | ImportOptionsKit const & | in_kit | ) | const |
Check if the source ImportOptionsKit is not equivalent to this ImportOptionsKit.
- Parameters
-
in_kit The source ImportOptionsKit to compare to this ImportOptionsKit.
- Returns
- true if the objects are not equivalent, false otherwise.
◆ operator=() [1/2]
ImportOptionsKit& HPS::HCA::ImportOptionsKit::operator= | ( | ImportOptionsKit && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this ImportOptionsKit thereby avoiding a copy.
- Parameters
-
in_that An rvalue reference to an ImportOptionsKit to take the impl from.
- Returns
- A reference to this ImportOptionsKit.
◆ operator=() [2/2]
ImportOptionsKit& HPS::HCA::ImportOptionsKit::operator= | ( | ImportOptionsKit const & | in_kit | ) |
Copies the source ImportOptionsKit into this ImportOptionsKit.
- Parameters
-
in_kit The source ImportOptionsKit to copy.
- Returns
- A reference to this ImportOptionsKit.
◆ operator==()
bool HPS::HCA::ImportOptionsKit::operator== | ( | ImportOptionsKit const & | in_kit | ) | const |
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.
◆ Set()
void HPS::HCA::ImportOptionsKit::Set | ( | ImportOptionsKit const & | in_kit | ) |
Copies the source ImportOptionsKit into this ImportOptionsKit.
- Parameters
-
in_kit The source ImportOptionsKit to copy.
◆ SetJavascriptPath()
ImportOptionsKit& HPS::HCA::ImportOptionsKit::SetJavascriptPath | ( | HPS::UTF8 const & | javascript_path | ) |
Sets the path to hc_access.js which will be used during the import. Setting a Javascript Path is required for the import to succeed. The hc_access.js file is provided with HOOPS Visualize.
- Parameters
-
javascript_path Path of the javascript file to use.
- Returns
- A reference to this ImportOptionsKit.
◆ SetTarget()
ImportOptionsKit& HPS::HCA::ImportOptionsKit::SetTarget | ( | HPS::Model const & | in_target | ) |
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.
- Parameters
-
in_model Model to use.
- Returns
- A reference to this ImportOptionsKit.
◆ SetView()
ImportOptionsKit& HPS::HCA::ImportOptionsKit::SetView | ( | HPS::View const & | in_view | ) |
Sets a View to be used as part of the import. Setting a View is required for the import to succeed.
- Parameters
-
in_view View to use for camera tracking.
- Returns
- A reference to this ImportOptionsKit.
◆ Show()
void HPS::HCA::ImportOptionsKit::Show | ( | ImportOptionsKit & | out_kit | ) | const |
Copies this ImportOptionsKit into the given ImportOptionsKit.
- Parameters
-
out_kit The ImportOptionsKit to populate with the contents of this ImportOptionsKit.
◆ ShowJavascriptPath()
bool HPS::HCA::ImportOptionsKit::ShowJavascriptPath | ( | HPS::UTF8 & | out_javascript_path | ) | const |
Shows the path that will be used to find hc_access.js during import.
- Parameters
-
out_javascript_path The 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 | ( | HPS::Model & | out_model | ) | const |
Shows the target import setting.
- Parameters
-
out_model Model 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 | ( | HPS::View & | out_view | ) | const |
Shows the view import setting.
- Parameters
-
out_view View to use.
- Returns
- Returns false if a view setting was not specified, false otherwise.
◆ UnsetEverything()
ImportOptionsKit& HPS::HCA::ImportOptionsKit::UnsetEverything | ( | ) |
Removes all settings from this ImportOptionsKit.
- Returns
- A reference to this ImportOptionsKit.
◆ UnsetJavascriptPath()
ImportOptionsKit& HPS::HCA::ImportOptionsKit::UnsetJavascriptPath | ( | ) |
Removes javascript path import setting.
- Returns
- A reference to this ImportOptionsKit.
◆ UnsetTarget()
ImportOptionsKit& HPS::HCA::ImportOptionsKit::UnsetTarget | ( | ) |
Removes the target import setting.
- Returns
- A reference to this ImportOptionsKit.
◆ UnsetView()
ImportOptionsKit& HPS::HCA::ImportOptionsKit::UnsetView | ( | ) |
Removes the view import setting.
- Returns
- A reference to this ImportOptionsKit.
The documentation for this class was generated from the following file:
- include/sprk_hca.h