#include <hps.h>

Public Member Functions | |
void | Consume (SegmentOptimizationOptionsKit &in_kit) |
bool | Empty () const |
bool | Equals (SegmentOptimizationOptionsKit const &in_kit) const |
HPS::Type | ObjectType () const |
bool | operator!= (SegmentOptimizationOptionsKit const &in_kit) const |
SegmentOptimizationOptionsKit & | operator= (SegmentOptimizationOptionsKit const &in_kit) |
SegmentOptimizationOptionsKit & | operator= (SegmentOptimizationOptionsKit &&in_kit) |
bool | operator== (SegmentOptimizationOptionsKit const &in_kit) const |
SegmentOptimizationOptionsKit () | |
SegmentOptimizationOptionsKit (SegmentOptimizationOptionsKit const &in_kit) | |
SegmentOptimizationOptionsKit (SegmentOptimizationOptionsKit &&in_kit) | |
void | Set (SegmentOptimizationOptionsKit const &in_kit) |
SegmentOptimizationOptionsKit & | SetAttributeDelocalization (bool in_attribute_delocalization) |
SegmentOptimizationOptionsKit & | SetExpansion (HPS::SegmentOptimizationOptions::Expansion in_expansion) |
SegmentOptimizationOptionsKit & | SetMatrix (HPS::SegmentOptimizationOptions::Matrix in_matrix) |
SegmentOptimizationOptionsKit & | SetReorganization (HPS::SegmentOptimizationOptions::Reorganization in_reorganization) |
SegmentOptimizationOptionsKit & | SetScope (HPS::SegmentOptimizationOptions::Scope in_scope) |
SegmentOptimizationOptionsKit & | SetShellInstancing (bool in_shell_instancing) |
SegmentOptimizationOptionsKit & | SetShellMerging (bool in_shell_merging) |
SegmentOptimizationOptionsKit & | SetUserData (HPS::SegmentOptimizationOptions::UserData in_user_data) |
void | Show (SegmentOptimizationOptionsKit &out_kit) const |
bool | ShowAttributeDelocalization (bool &out_attribute_delocalization) const |
bool | ShowExpansion (HPS::SegmentOptimizationOptions::Expansion &out_expansion) const |
bool | ShowMatrix (HPS::SegmentOptimizationOptions::Matrix &out_matrix) const |
bool | ShowReorganization (HPS::SegmentOptimizationOptions::Reorganization &out_reorganization) const |
bool | ShowScope (HPS::SegmentOptimizationOptions::Scope &out_scope) const |
bool | ShowShellInstancing (bool &out_shell_instancing) const |
bool | ShowShellMerging (bool &out_shell_merging) const |
bool | ShowUserData (HPS::SegmentOptimizationOptions::UserData &out_user_data) const |
SegmentOptimizationOptionsKit & | UnsetAttributeDelocalization () |
SegmentOptimizationOptionsKit & | UnsetEverything () |
SegmentOptimizationOptionsKit & | UnsetExpansion () |
SegmentOptimizationOptionsKit & | UnsetMatrix () |
SegmentOptimizationOptionsKit & | UnsetReorganization () |
SegmentOptimizationOptionsKit & | UnsetScope () |
SegmentOptimizationOptionsKit & | UnsetShellInstancing () |
SegmentOptimizationOptionsKit & | UnsetShellMerging () |
SegmentOptimizationOptionsKit & | UnsetUserData () |
![]() | |
virtual HPS::Type | Type () const |
![]() | |
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 () |
Static Public Attributes | |
static const HPS::Type | staticType = HPS::Type::SegmentOptimizationOptionsKit |
![]() | |
static const HPS::Type | staticType = HPS::Type::Kit |
![]() | |
static const HPS::Type | staticType = HPS::Type::None |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
![]() | |
Kit (Kit &&in_that) | |
Kit & | operator= (Kit &&in_that) |
Detailed Description
Configuration options kit for controlling HPS::Segment::Optimize behavior.
Constructor & Destructor Documentation
HPS::SegmentOptimizationOptionsKit::SegmentOptimizationOptionsKit | ( | ) |
The default constructor creates an empty SegmentOptimizationOptionsKit object.
HPS::SegmentOptimizationOptionsKit::SegmentOptimizationOptionsKit | ( | SegmentOptimizationOptionsKit const & | in_kit | ) |
The copy constructor creates a new SegmentOptimizationOptionsKit object that contains the same settings as the source SegmentOptimizationOptionsKit.
- Parameters
-
in_kit The source SegmentOptimizationOptionsKit to copy.
HPS::SegmentOptimizationOptionsKit::SegmentOptimizationOptionsKit | ( | SegmentOptimizationOptionsKit && | in_kit | ) |
The move constructor creates a SegmentOptimizationOptionsKit by transferring the underlying impl of the rvalue reference to this SegmentOptimizationOptionsKit thereby avoiding a copy and allocation.
- Parameters
-
in_that An rvalue reference to a SegmentOptimizationOptionsKit to take the impl from.
Member Function Documentation
void HPS::SegmentOptimizationOptionsKit::Consume | ( | SegmentOptimizationOptionsKit & | in_kit | ) |
Copies the source SegmentOptimizationOptionsKit into this SegmentOptimizationOptionsKit and resets the source kit.
- Parameters
-
in_kit The source SegmentOptimizationOptionsKit to consume.
|
virtual |
Indicates whether this SegmentOptimizationOptionsKit has any values set on it.
- Returns
- true if no values are set on this SegmentOptimizationOptionsKit, false otherwise.
Reimplemented from HPS::Object.
bool HPS::SegmentOptimizationOptionsKit::Equals | ( | SegmentOptimizationOptionsKit const & | in_kit | ) | const |
Check if the source SegmentOptimizationOptionsKit is equivalent to this SegmentOptimizationOptionsKit.
- Parameters
-
in_kit The source SegmentOptimizationOptionsKit to compare to this SegmentOptimizationOptionsKit.
- Returns
- true if the objects are equivalent, false otherwise.
bool HPS::SegmentOptimizationOptionsKit::operator!= | ( | SegmentOptimizationOptionsKit const & | in_kit | ) | const |
Check if the source SegmentOptimizationOptionsKit is not equivalent to this SegmentOptimizationOptionsKit.
- Parameters
-
in_kit The source SegmentOptimizationOptionsKit to compare to this SegmentOptimizationOptionsKit.
- Returns
- true if the objects are not equivalent, false otherwise.
SegmentOptimizationOptionsKit& HPS::SegmentOptimizationOptionsKit::operator= | ( | SegmentOptimizationOptionsKit const & | in_kit | ) |
Copies the source SegmentOptimizationOptionsKit into this SegmentOptimizationOptionsKit.
- Parameters
-
in_kit The source SegmentOptimizationOptionsKit to copy.
- Returns
- A reference to this SegmentOptimizationOptionsKit.
SegmentOptimizationOptionsKit& HPS::SegmentOptimizationOptionsKit::operator= | ( | SegmentOptimizationOptionsKit && | in_kit | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this SegmentOptimizationOptionsKit thereby avoiding a copy.
- Parameters
-
in_that An rvalue reference to a SegmentOptimizationOptionsKit to take the impl from.
- Returns
- A reference to this SegmentOptimizationOptionsKit.
bool HPS::SegmentOptimizationOptionsKit::operator== | ( | SegmentOptimizationOptionsKit const & | in_kit | ) | const |
Check if the source SegmentOptimizationOptionsKit is equivalent to this SegmentOptimizationOptionsKit.
- Parameters
-
in_kit The source SegmentOptimizationOptionsKit to compare to this SegmentOptimizationOptionsKit.
- Returns
- true if the objects are equivalent, false otherwise.
void HPS::SegmentOptimizationOptionsKit::Set | ( | SegmentOptimizationOptionsKit const & | in_kit | ) |
Copies the source SegmentOptimizationOptionsKit into this SegmentOptimizationOptionsKit.
- Parameters
-
in_kit The source SegmentOptimizationOptionsKit to copy.
SegmentOptimizationOptionsKit& HPS::SegmentOptimizationOptionsKit::SetAttributeDelocalization | ( | bool | in_attribute_delocalization | ) |
Controls whether or not local attributes will be pulled out of geometry.
- Parameters
-
in_attribute_delocalization Denotes whether or not local attributes will be pulled out of geometry.
- Returns
- A reference to this SegmentOptimizationOptionsKit.
SegmentOptimizationOptionsKit& HPS::SegmentOptimizationOptionsKit::SetExpansion | ( | HPS::SegmentOptimizationOptions::Expansion | in_expansion | ) |
Controls whether or not includes or references are expanded.
- Parameters
-
in_expansion The enum value describing how to handle includes and references.
- Returns
- A reference to this SegmentOptimizationOptionsKit.
SegmentOptimizationOptionsKit& HPS::SegmentOptimizationOptionsKit::SetMatrix | ( | HPS::SegmentOptimizationOptions::Matrix | in_matrix | ) |
Controls whether or not matrices are localized, collapsed, or left as is.
- Parameters
-
in_matrix The enum value describing how to handle matrices.
- Returns
- A reference to this SegmentOptimizationOptionsKit.
SegmentOptimizationOptionsKit& HPS::SegmentOptimizationOptionsKit::SetReorganization | ( | HPS::SegmentOptimizationOptions::Reorganization | in_reorganization | ) |
Controls how the tree is reorganized.
- Parameters
-
in_reorganization The enum value describing how to reorganize the tree.
- Returns
- A reference to this SegmentOptimizationOptionsKit.
SegmentOptimizationOptionsKit& HPS::SegmentOptimizationOptionsKit::SetScope | ( | HPS::SegmentOptimizationOptions::Scope | in_scope | ) |
Controls the traversal scope of the optimization operation.
- Parameters
-
in_scope The enum value describing the traversal scope of the optimization.
- Returns
- A reference to this SegmentOptimizationOptionsKit.
SegmentOptimizationOptionsKit& HPS::SegmentOptimizationOptionsKit::SetShellInstancing | ( | bool | in_shell_instancing | ) |
Controls whether or not duplicate shells are instanced.
- Parameters
-
in_shell_instancing Denotes whether or not shells will be instanced.
- Returns
- A reference to this SegmentOptimizationOptionsKit.
SegmentOptimizationOptionsKit& HPS::SegmentOptimizationOptionsKit::SetShellMerging | ( | bool | in_shell_merging | ) |
Controls whether or not distinct shells are merged into consolidated shells.
- Parameters
-
in_shell_merging Denotes whether or not shells will be merged.
- Returns
- A reference to this SegmentOptimizationOptionsKit.
SegmentOptimizationOptionsKit& HPS::SegmentOptimizationOptionsKit::SetUserData | ( | HPS::SegmentOptimizationOptions::UserData | in_user_data | ) |
Controls whether or not user data is discarded, preserved, merged, localized, or left as is.
- Parameters
-
in_user_data The enum value describing how to handle user data.
- Returns
- A reference to this SegmentOptimizationOptionsKit.
void HPS::SegmentOptimizationOptionsKit::Show | ( | SegmentOptimizationOptionsKit & | out_kit | ) | const |
Copies this SegmentOptimizationOptionsKit into the given SegmentOptimizationOptionsKit.
- Parameters
-
out_kit The SegmentOptimizationOptionsKit to populate with the contents of this SegmentOptimizationOptionsKit.
bool HPS::SegmentOptimizationOptionsKit::ShowAttributeDelocalization | ( | bool & | out_attribute_delocalization | ) | const |
Shows the Attribute Delocalization setting.
- Parameters
-
out_attribute_delocalization
- Returns
- true if the setting is valid, false otherwise.
bool HPS::SegmentOptimizationOptionsKit::ShowExpansion | ( | HPS::SegmentOptimizationOptions::Expansion & | out_expansion | ) | const |
Shows the Expansion setting.
- Parameters
-
out_expansion
- Returns
- true if the setting is valid, false otherwise.
bool HPS::SegmentOptimizationOptionsKit::ShowMatrix | ( | HPS::SegmentOptimizationOptions::Matrix & | out_matrix | ) | const |
Shows the Matrix setting.
- Parameters
-
out_matrix
- Returns
- true if the setting is valid, false otherwise.
bool HPS::SegmentOptimizationOptionsKit::ShowReorganization | ( | HPS::SegmentOptimizationOptions::Reorganization & | out_reorganization | ) | const |
Shows the Reorganization setting.
- Parameters
-
out_reorganization
- Returns
- true if the setting is valid, false otherwise.
bool HPS::SegmentOptimizationOptionsKit::ShowScope | ( | HPS::SegmentOptimizationOptions::Scope & | out_scope | ) | const |
Shows the Scope setting.
- Parameters
-
out_scope
- Returns
- true if the setting is valid, false otherwise.
bool HPS::SegmentOptimizationOptionsKit::ShowShellInstancing | ( | bool & | out_shell_instancing | ) | const |
Shows the Shell Instancing setting.
- Parameters
-
out_shell_instancing
- Returns
- true if the setting is valid, false otherwise.
bool HPS::SegmentOptimizationOptionsKit::ShowShellMerging | ( | bool & | out_shell_merging | ) | const |
Shows the Shell Merging setting.
- Parameters
-
out_shell_merging
- Returns
- true if the setting is valid, false otherwise.
bool HPS::SegmentOptimizationOptionsKit::ShowUserData | ( | HPS::SegmentOptimizationOptions::UserData & | out_user_data | ) | const |
Shows the User Data setting.
- Parameters
-
out_user_data
- Returns
- true if the setting is valid, false otherwise.
SegmentOptimizationOptionsKit& HPS::SegmentOptimizationOptionsKit::UnsetAttributeDelocalization | ( | ) |
Unsets the ttributeDelocalization value on this kit.
- Returns
- A reference to this SegmentOptimizationOptionsKit.
SegmentOptimizationOptionsKit& HPS::SegmentOptimizationOptionsKit::UnsetEverything | ( | ) |
Removes all settings from this object.
- Returns
- A reference to this object.
SegmentOptimizationOptionsKit& HPS::SegmentOptimizationOptionsKit::UnsetExpansion | ( | ) |
Unsets the Expansion value on this kit.
- Returns
- A reference to this SegmentOptimizationOptionsKit.
SegmentOptimizationOptionsKit& HPS::SegmentOptimizationOptionsKit::UnsetMatrix | ( | ) |
Unsets the Matrix value on this kit.
- Returns
- A reference to this SegmentOptimizationOptionsKit.
SegmentOptimizationOptionsKit& HPS::SegmentOptimizationOptionsKit::UnsetReorganization | ( | ) |
Unsets the Reorganization value on this kit.
- Returns
- A reference to this SegmentOptimizationOptionsKit.
SegmentOptimizationOptionsKit& HPS::SegmentOptimizationOptionsKit::UnsetScope | ( | ) |
Unsets the Scope value on this kit.
- Returns
- A reference to this SegmentOptimizationOptionsKit.
SegmentOptimizationOptionsKit& HPS::SegmentOptimizationOptionsKit::UnsetShellInstancing | ( | ) |
Unsets the ShellInstancing value on this kit.
- Returns
- A reference to this SegmentOptimizationOptionsKit.
SegmentOptimizationOptionsKit& HPS::SegmentOptimizationOptionsKit::UnsetShellMerging | ( | ) |
Unsets the ShellMerging value on this kit.
- Returns
- A reference to this SegmentOptimizationOptionsKit.
SegmentOptimizationOptionsKit& HPS::SegmentOptimizationOptionsKit::UnsetUserData | ( | ) |
Unsets the UserData value on this kit.
- Returns
- A reference to this SegmentOptimizationOptionsKit.
The documentation for this class was generated from the following file:
- include/hps.h