HPS::SegmentOptimizationOptionsKit Class Reference

#include <hps.h>

Inheritance diagram for HPS::SegmentOptimizationOptionsKit:
HPS::Kit HPS::Object

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
 
SegmentOptimizationOptionsKitoperator= (SegmentOptimizationOptionsKit const &in_kit)
 
SegmentOptimizationOptionsKitoperator= (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)
 
SegmentOptimizationOptionsKitSetAttributeDelocalization (bool in_attribute_delocalization)
 
SegmentOptimizationOptionsKitSetExpansion (HPS::SegmentOptimizationOptions::Expansion in_expansion)
 
SegmentOptimizationOptionsKitSetMatrix (HPS::SegmentOptimizationOptions::Matrix in_matrix)
 
SegmentOptimizationOptionsKitSetReorganization (HPS::SegmentOptimizationOptions::Reorganization in_reorganization)
 
SegmentOptimizationOptionsKitSetScope (HPS::SegmentOptimizationOptions::Scope in_scope)
 
SegmentOptimizationOptionsKitSetShellInstancing (bool in_shell_instancing)
 
SegmentOptimizationOptionsKitSetShellMerging (bool in_shell_merging)
 
SegmentOptimizationOptionsKitSetUserData (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
 
SegmentOptimizationOptionsKitUnsetAttributeDelocalization ()
 
SegmentOptimizationOptionsKitUnsetEverything ()
 
SegmentOptimizationOptionsKitUnsetExpansion ()
 
SegmentOptimizationOptionsKitUnsetMatrix ()
 
SegmentOptimizationOptionsKitUnsetReorganization ()
 
SegmentOptimizationOptionsKitUnsetScope ()
 
SegmentOptimizationOptionsKitUnsetShellInstancing ()
 
SegmentOptimizationOptionsKitUnsetShellMerging ()
 
SegmentOptimizationOptionsKitUnsetUserData ()
 
- Public Member Functions inherited from HPS::Kit
virtual HPS::Type Type () const
 
- Public Member Functions inherited from HPS::Object
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
 Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::SegmentOptimizationOptionsKit
 
- Static Public Attributes inherited from HPS::Kit
static const HPS::Type staticType = HPS::Type::Kit
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 
- Protected Member Functions inherited from HPS::Kit
 Kit (Kit &&in_that)
 
Kitoperator= (Kit &&in_that)
 

Detailed Description

Configuration options kit for controlling HPS::Segment::Optimize behavior.

Constructor & Destructor Documentation

◆ SegmentOptimizationOptionsKit() [1/3]

HPS::SegmentOptimizationOptionsKit::SegmentOptimizationOptionsKit ( )

The default constructor creates an empty SegmentOptimizationOptionsKit object.

◆ SegmentOptimizationOptionsKit() [2/3]

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_kitThe source SegmentOptimizationOptionsKit to copy.

◆ SegmentOptimizationOptionsKit() [3/3]

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_thatAn rvalue reference to a SegmentOptimizationOptionsKit to take the impl from.

Member Function Documentation

◆ Consume()

void HPS::SegmentOptimizationOptionsKit::Consume ( SegmentOptimizationOptionsKit in_kit)

Copies the source SegmentOptimizationOptionsKit into this SegmentOptimizationOptionsKit and resets the source kit.

Parameters
in_kitThe source SegmentOptimizationOptionsKit to consume.

◆ Empty()

bool HPS::SegmentOptimizationOptionsKit::Empty ( ) const
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.

◆ Equals()

bool HPS::SegmentOptimizationOptionsKit::Equals ( SegmentOptimizationOptionsKit const &  in_kit) const

Check if the source SegmentOptimizationOptionsKit is equivalent to this SegmentOptimizationOptionsKit.

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

◆ ObjectType()

HPS::Type HPS::SegmentOptimizationOptionsKit::ObjectType ( ) const
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.

◆ operator!=()

bool HPS::SegmentOptimizationOptionsKit::operator!= ( SegmentOptimizationOptionsKit const &  in_kit) const

Check if the source SegmentOptimizationOptionsKit is not equivalent to this SegmentOptimizationOptionsKit.

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

◆ operator=() [1/2]

SegmentOptimizationOptionsKit& HPS::SegmentOptimizationOptionsKit::operator= ( SegmentOptimizationOptionsKit const &  in_kit)

Copies the source SegmentOptimizationOptionsKit into this SegmentOptimizationOptionsKit.

Parameters
in_kitThe source SegmentOptimizationOptionsKit to copy.
Returns
A reference to this SegmentOptimizationOptionsKit.

◆ operator=() [2/2]

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_thatAn rvalue reference to a SegmentOptimizationOptionsKit to take the impl from.
Returns
A reference to this SegmentOptimizationOptionsKit.

◆ operator==()

bool HPS::SegmentOptimizationOptionsKit::operator== ( SegmentOptimizationOptionsKit const &  in_kit) const

Check if the source SegmentOptimizationOptionsKit is equivalent to this SegmentOptimizationOptionsKit.

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

◆ Set()

void HPS::SegmentOptimizationOptionsKit::Set ( SegmentOptimizationOptionsKit const &  in_kit)

Copies the source SegmentOptimizationOptionsKit into this SegmentOptimizationOptionsKit.

Parameters
in_kitThe source SegmentOptimizationOptionsKit to copy.

◆ SetAttributeDelocalization()

SegmentOptimizationOptionsKit& HPS::SegmentOptimizationOptionsKit::SetAttributeDelocalization ( bool  in_attribute_delocalization)

Controls whether or not local attributes will be pulled out of geometry.

Parameters
in_attribute_delocalizationDenotes whether or not local attributes will be pulled out of geometry.
Returns
A reference to this SegmentOptimizationOptionsKit.

◆ SetExpansion()

SegmentOptimizationOptionsKit& HPS::SegmentOptimizationOptionsKit::SetExpansion ( HPS::SegmentOptimizationOptions::Expansion  in_expansion)

Controls whether or not includes or references are expanded.

Parameters
in_expansionThe enum value describing how to handle includes and references.
Returns
A reference to this SegmentOptimizationOptionsKit.

◆ SetMatrix()

SegmentOptimizationOptionsKit& HPS::SegmentOptimizationOptionsKit::SetMatrix ( HPS::SegmentOptimizationOptions::Matrix  in_matrix)

Controls whether or not matrices are localized, collapsed, or left as is.

Parameters
in_matrixThe enum value describing how to handle matrices.
Returns
A reference to this SegmentOptimizationOptionsKit.

◆ SetReorganization()

SegmentOptimizationOptionsKit& HPS::SegmentOptimizationOptionsKit::SetReorganization ( HPS::SegmentOptimizationOptions::Reorganization  in_reorganization)

Controls how the tree is reorganized.

Parameters
in_reorganizationThe enum value describing how to reorganize the tree.
Returns
A reference to this SegmentOptimizationOptionsKit.

◆ SetScope()

SegmentOptimizationOptionsKit& HPS::SegmentOptimizationOptionsKit::SetScope ( HPS::SegmentOptimizationOptions::Scope  in_scope)

Controls the traversal scope of the optimization operation.

Parameters
in_scopeThe enum value describing the traversal scope of the optimization.
Returns
A reference to this SegmentOptimizationOptionsKit.

◆ SetShellInstancing()

SegmentOptimizationOptionsKit& HPS::SegmentOptimizationOptionsKit::SetShellInstancing ( bool  in_shell_instancing)

Controls whether or not duplicate shells are instanced.

Parameters
in_shell_instancingDenotes whether or not shells will be instanced.
Returns
A reference to this SegmentOptimizationOptionsKit.

◆ SetShellMerging()

SegmentOptimizationOptionsKit& HPS::SegmentOptimizationOptionsKit::SetShellMerging ( bool  in_shell_merging)

Controls whether or not distinct shells are merged into consolidated shells.

Parameters
in_shell_mergingDenotes whether or not shells will be merged.
Returns
A reference to this SegmentOptimizationOptionsKit.

◆ SetUserData()

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_dataThe enum value describing how to handle user data.
Returns
A reference to this SegmentOptimizationOptionsKit.

◆ Show()

void HPS::SegmentOptimizationOptionsKit::Show ( SegmentOptimizationOptionsKit out_kit) const

Copies this SegmentOptimizationOptionsKit into the given SegmentOptimizationOptionsKit.

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

◆ ShowAttributeDelocalization()

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.

◆ ShowExpansion()

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.

◆ ShowMatrix()

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.

◆ ShowReorganization()

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.

◆ ShowScope()

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.

◆ ShowShellInstancing()

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.

◆ ShowShellMerging()

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.

◆ ShowUserData()

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.

◆ UnsetAttributeDelocalization()

SegmentOptimizationOptionsKit& HPS::SegmentOptimizationOptionsKit::UnsetAttributeDelocalization ( )

Unsets the ttributeDelocalization value on this kit.

Returns
A reference to this SegmentOptimizationOptionsKit.

◆ UnsetEverything()

SegmentOptimizationOptionsKit& HPS::SegmentOptimizationOptionsKit::UnsetEverything ( )

Removes all settings from this object.

Returns
A reference to this object.

◆ UnsetExpansion()

SegmentOptimizationOptionsKit& HPS::SegmentOptimizationOptionsKit::UnsetExpansion ( )

Unsets the Expansion value on this kit.

Returns
A reference to this SegmentOptimizationOptionsKit.

◆ UnsetMatrix()

SegmentOptimizationOptionsKit& HPS::SegmentOptimizationOptionsKit::UnsetMatrix ( )

Unsets the Matrix value on this kit.

Returns
A reference to this SegmentOptimizationOptionsKit.

◆ UnsetReorganization()

SegmentOptimizationOptionsKit& HPS::SegmentOptimizationOptionsKit::UnsetReorganization ( )

Unsets the Reorganization value on this kit.

Returns
A reference to this SegmentOptimizationOptionsKit.

◆ UnsetScope()

SegmentOptimizationOptionsKit& HPS::SegmentOptimizationOptionsKit::UnsetScope ( )

Unsets the Scope value on this kit.

Returns
A reference to this SegmentOptimizationOptionsKit.

◆ UnsetShellInstancing()

SegmentOptimizationOptionsKit& HPS::SegmentOptimizationOptionsKit::UnsetShellInstancing ( )

Unsets the ShellInstancing value on this kit.

Returns
A reference to this SegmentOptimizationOptionsKit.

◆ UnsetShellMerging()

SegmentOptimizationOptionsKit& HPS::SegmentOptimizationOptionsKit::UnsetShellMerging ( )

Unsets the ShellMerging value on this kit.

Returns
A reference to this SegmentOptimizationOptionsKit.

◆ UnsetUserData()

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: