#include <sprk_exchange.h>

Inheritance diagram for HPS::Exchange::TranslationOptionsKit:

Public Member Functions
bool	Empty () const

bool	Equals (TranslationOptionsKit const &in_kit) const

HPS::Type	ObjectType () const

bool	operator!= (TranslationOptionsKit const &in_kit) const

TranslationOptionsKit &	operator= (TranslationOptionsKit &&in_that)

TranslationOptionsKit &	operator= (TranslationOptionsKit const &in_kit)

bool	operator== (TranslationOptionsKit const &in_kit) const

void	Set (TranslationOptionsKit const &in_kit)

TranslationOptionsKit &	SetAccurateEdges (Translation::AccurateEdges in_accurate_edges)

TranslationOptionsKit &	SetApplication (char const *in_name)

TranslationOptionsKit &	SetDisjointFaces (bool in_state)

TranslationOptionsKit &	SetEntityMerging (Translation::Merging in_merging)

TranslationOptionsKit &	SetExplodeMultiBodies (bool in_state)

TranslationOptionsKit &	SetHealing (Translation::Healing in_healing)

TranslationOptionsKit &	SetHiddenObjects (bool in_state)

TranslationOptionsKit &	SetMultiProcessCount (unsigned int in_count)

TranslationOptionsKit &	SetSewing (bool in_state, double in_tolerance=0.0)

TranslationOptionsKit &	SetSimplification (Translation::Simplification in_simplification)

TranslationOptionsKit &	SetSolidsAsFaces (bool in_state)

TranslationOptionsKit &	SetTessellation (bool in_state)

TranslationOptionsKit &	SetVersion (char const *in_version)

void	Show (TranslationOptionsKit &out_kit) const

bool	ShowAccurateEdges (Translation::AccurateEdges &out_accurate_edges) const

bool	ShowApplication (UTF8 &out_name) const

bool	ShowDisjointFaces (bool &out_state) const

bool	ShowEntityMerging (Translation::Merging &out_merging) const

bool	ShowExplodeMultiBodies (bool &out_state) const

bool	ShowHealing (Translation::Healing &out_healing) const

bool	ShowHiddenObjects (bool &out_state) const

bool	ShowMultiProcessCount (unsigned int &out_count) const

bool	ShowSewing (bool &out_state, double &out_tolerance) const

bool	ShowSimplification (Translation::Simplification &out_simplification) const

bool	ShowSolidsAsFaces (bool &out_state) const

bool	ShowTessellation (bool &out_state) const

bool	ShowVersion (UTF8 &out_version) const

	TranslationOptionsKit ()

	TranslationOptionsKit (TranslationOptionsKit const &in_kit)

	TranslationOptionsKit (TranslationOptionsKit &&in_that)

TranslationOptionsKit &	UnsetAccurateEdges ()

TranslationOptionsKit &	UnsetApplication ()

TranslationOptionsKit &	UnsetDisjointFaces ()

TranslationOptionsKit &	UnsetEntityMerging ()

TranslationOptionsKit &	UnsetEverything ()

TranslationOptionsKit &	UnsetExplodeMultiBodies ()

TranslationOptionsKit &	UnsetHealing ()

TranslationOptionsKit &	UnsetHiddenObjects ()

TranslationOptionsKit &	UnsetMultiProcessCount ()

TranslationOptionsKit &	UnsetSewing ()

TranslationOptionsKit &	UnsetSimplification ()

TranslationOptionsKit &	UnsetSolidsAsFaces ()

TranslationOptionsKit &	UnsetTessellation ()

TranslationOptionsKit &	UnsetVersion ()

Public Member Functions inherited from HPS::Sprocket
	Sprocket (Sprocket &&in_that)

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)

Object &	operator= (Object const &other_object)

Object &	operator= (Object &&in_that)

virtual void	Reset ()

virtual HPS::Type	Type () const

Static Public Member Functions
static TranslationOptionsKit	GetDefault ()

Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t	ClassID ()

Static Public Attributes
static const HPS::Type	staticType = HPS::Type::ExchangeTranslationOptionsKit

Static Public Attributes inherited from HPS::SprocketKit
static const HPS::Type	staticType = HPS::Type::SprocketKit

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

Additional Inherited Members
Protected Member Functions inherited from HPS::SprocketKit
SprocketKit &	operator= (SprocketKit &&in_that)

	SprocketKit (SprocketKit &&in_that)

Detailed Description

The HPS::Exchange::TranslationOptionsKit class is a user space object. It contains settings controlling what and how data is translated to Parasolid by Exchange. Calling HPS::Exchange::TranslationOptionsKit::GetDefault() will return an options kit with values found in here.

Constructor & Destructor Documentation

◆ TranslationOptionsKit() [1/3]

HPS::Exchange::TranslationOptionsKit::TranslationOptionsKit ( )

The default constructor creates an empty TranslationOptionsKit object.

◆ TranslationOptionsKit() [2/3]

HPS::Exchange::TranslationOptionsKit::TranslationOptionsKit ( TranslationOptionsKit const & in_kit )

The copy constructor creates a new TranslationOptionsKit object that contains the same settings as the source TranslationOptionsKit.

Parameters

in_kit The source TranslationOptionsKit to copy.

◆ TranslationOptionsKit() [3/3]

HPS::Exchange::TranslationOptionsKit::TranslationOptionsKit ( TranslationOptionsKit && in_that )

The move constructor creates a TranslationOptionsKit by transferring the underlying impl of the rvalue reference to this TranslationOptionsKit thereby avoiding a copy and allocation.

Parameters

in_that An rvalue reference to an TranslationOptionsKit to take the impl from.

Member Function Documentation

◆ Empty()

bool HPS::Exchange::TranslationOptionsKit::Empty ( ) const

virtual

Indicates whether this TranslationOptionsKit has any values set on it.

Returns: true if no values are set on this TranslationOptionsKit, false otherwise.

Reimplemented from HPS::Object.

◆ Equals()

bool HPS::Exchange::TranslationOptionsKit::Equals ( TranslationOptionsKit const & in_kit ) const

Check if the source TranslationOptionsKit is equivalent to this TranslationOptionsKit.

Parameters

in_kit The source TranslationOptionsKit to compare to this TranslationOptionsKit.

Returns: true if the objects are equivalent, false otherwise.

◆ GetDefault()

static TranslationOptionsKit HPS::Exchange::TranslationOptionsKit::GetDefault ( )

static

Creates a TranslationOptionsKit 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 translation unless an option is overridden by the options passed to one of the Translate functions.

Returns: A TranslationOptionsKit with the default settings.

◆ ObjectType()

HPS::Type HPS::Exchange::TranslationOptionsKit::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::SprocketKit.

◆ operator!=()

bool HPS::Exchange::TranslationOptionsKit::operator!= ( TranslationOptionsKit const & in_kit ) const

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

Parameters

in_kit The source TranslationOptionsKit to compare to this TranslationOptionsKit.

Returns: true if the objects are not equivalent, false otherwise.

◆ operator=() [1/2]

TranslationOptionsKit& HPS::Exchange::TranslationOptionsKit::operator= ( TranslationOptionsKit && in_that )

The move assignment operator transfers the underlying impl of the rvalue reference to this TranslationOptionsKit thereby avoiding a copy.

Parameters

in_that An rvalue reference to an TranslationOptionsKit to take the impl from.

Returns: A reference to this TranslationOptionsKit.

◆ operator=() [2/2]

TranslationOptionsKit& HPS::Exchange::TranslationOptionsKit::operator= ( TranslationOptionsKit const & in_kit )

Copies the source TranslationOptionsKit into this TranslationOptionsKit.

Parameters

in_kit The source TranslationOptionsKit to copy.

Returns: A reference to this TranslationOptionsKit.

◆ operator==()

bool HPS::Exchange::TranslationOptionsKit::operator== ( TranslationOptionsKit const & in_kit ) const

Check if the source TranslationOptionsKit is equivalent to this TranslationOptionsKit.

Parameters

in_kit The source TranslationOptionsKit to compare to this TranslationOptionsKit.

Returns: true if the objects are equivalent, false otherwise.

◆ Set()

void HPS::Exchange::TranslationOptionsKit::Set ( TranslationOptionsKit const & in_kit )

Copies the source TranslationOptionsKit into this TranslationOptionsKit.

Parameters

in_kit The source TranslationOptionsKit to copy.

◆ SetAccurateEdges()

TranslationOptionsKit& HPS::Exchange::TranslationOptionsKit::SetAccurateEdges ( Translation::AccurateEdges in_accurate_edges )

Sets whether accurate edges will be computed as part of the translation. This corresponds to the value that will be passed to A3DRWParamsTranslateToPkPartsData::m_eComputeAccurateEdges.

Parameters

in_accurate_edges Whether to compute accurate edges.

Returns: A reference to this TranslationOptionsKit.

◆ SetApplication()

TranslationOptionsKit& HPS::Exchange::TranslationOptionsKit::SetApplication ( char const * in_name )

Sets the application name to put in the Parasolid data. This corresponds to the value that will be passed to A3DRWParamsExportParasolidData::m_pcApplication.

Parameters

in_name UTF8-encoded application name to put in the Parasolid data.

Returns: A reference to this TranslationOptionsKit.

◆ SetDisjointFaces()

TranslationOptionsKit& HPS::Exchange::TranslationOptionsKit::SetDisjointFaces ( bool in_state )

Sets whether erroneous faces can be disjointed from their solids as part of the translation. This corresponds to the value that will be passed to A3DRWParamsTranslateToPkPartsData::m_bDisjoinIfFaceFaceError.

Parameters

in_state Whether to disjoin erroneous faces from their owning solids.

Returns: A reference to this TranslationOptionsKit.

◆ SetEntityMerging()

TranslationOptionsKit& HPS::Exchange::TranslationOptionsKit::SetEntityMerging ( Translation::Merging in_merging )

Sets whether entities can be merged as part of the translation. This corresponds to the value that will be passed to A3DRWParamsTranslateToPkPartsData::m_eMergeEntities.

Parameters

in_merging Whether to merge entities.

Returns: A reference to this TranslationOptionsKit.

◆ SetExplodeMultiBodies()

TranslationOptionsKit& HPS::Exchange::TranslationOptionsKit::SetExplodeMultiBodies ( bool in_state )

Sets whether to explode multi-connexes B-reps into multiple bodies. This corresponds to the value that will be passed to A3DRWParamsExportParasolidData::m_bExplodeMultiBodies.

Parameters

in_state Whether to explode multi-connexes B-reps into multiple bodies.

Returns: A reference to this TranslationOptionsKit.

See also: Default value

◆ SetHealing()

TranslationOptionsKit& HPS::Exchange::TranslationOptionsKit::SetHealing ( Translation::Healing in_healing )

Sets whether healing will be performed as part of the translation. This corresponds to the value that will be passed to A3DRWParamsTranslateToPkPartsData::m_eHealing.

Parameters

in_healing Whether to perform healing.

Returns: A reference to this TranslationOptionsKit.

◆ SetHiddenObjects()

TranslationOptionsKit& HPS::Exchange::TranslationOptionsKit::SetHiddenObjects ( bool in_state )

Sets whether to export hidden objects. This corresponds to the value that will be passed to A3DRWParamsExportParasolidData::m_bWriteBlankedEntities.

Parameters

in_state Whether to export hidden objects.

Returns: A reference to this TranslationOptionsKit.

See also: Default value

◆ SetMultiProcessCount()

TranslationOptionsKit& HPS::Exchange::TranslationOptionsKit::SetMultiProcessCount ( unsigned int in_count )

Sets the number of processes to use when performing translation. This should be a value between 1 and the number of cores on your system.

Note: Presently this option is only used for translations performed when using HPS::ExchangeParsolid::File::Import and HPS::ExchangeParasolid::File::Reload.

Parameters

in_count The number of processes to use when performing translation.

Returns: A reference to this TranslationOptionsKit.

◆ SetSewing()

TranslationOptionsKit& HPS::Exchange::TranslationOptionsKit::SetSewing	(	bool	in_state,
		double	in_tolerance = `0.0`
	)

Sets whether perform sewing as part of the translation.

Parameters

in_state	Whether to perform sewing.
in_tolerance	The sewing tolerance in millimeters.

Returns: A reference to this TranslationOptionsKit.

◆ SetSimplification()

TranslationOptionsKit& HPS::Exchange::TranslationOptionsKit::SetSimplification ( Translation::Simplification in_simplification )

Sets whether geometry can be simplified as part of the translation. This corresponds to the value that will be passed to A3DRWParamsTranslateToPkPartsData::m_eSimplifyGeometry.

Parameters

in_simplification Whether to simplify geometry.

Returns: A reference to this TranslationOptionsKit.

◆ SetSolidsAsFaces()

TranslationOptionsKit& HPS::Exchange::TranslationOptionsKit::SetSolidsAsFaces ( bool in_state )

Sets whether to convert solids to a set of independent faces for export. This corresponds to the value that will be passed to A3DRWParamsExportIgesData::m_bSaveSolidsAsFaces.

Parameters

in_state Whether to convert solids to a set of independent faces for export.

Returns: A reference to this TranslationOptionsKit.

See also: Default value

◆ SetTessellation()

TranslationOptionsKit& HPS::Exchange::TranslationOptionsKit::SetTessellation ( bool in_state )

Sets whether to export tessellation data. This corresponds to the value that will be passed to A3DRWParamsExportParasolidData::m_bWriteTessellation.

Parameters

in_state Whether to export tessellation data.

Returns: A reference to this TranslationOptionsKit.

See also: Default value

◆ SetVersion()

TranslationOptionsKit& HPS::Exchange::TranslationOptionsKit::SetVersion ( char const * in_version )

Sets the version string to put in the Parasolid data. This corresponds to the value that will be passed to A3DRWParamsExportParasolidData::m_pcVersion.

Parameters

in_version UTF8-encoded version string to put in the Parasolid data.

Returns: A reference to this TranslationOptionsKit.

◆ Show()

void HPS::Exchange::TranslationOptionsKit::Show ( TranslationOptionsKit & out_kit ) const

Copies this TranslationOptionsKit into the given TranslationOptionsKit.

Parameters

out_kit The TranslationOptionsKit to populate with the contents of this TranslationOptionsKit.

◆ ShowAccurateEdges()

bool HPS::Exchange::TranslationOptionsKit::ShowAccurateEdges ( Translation::AccurateEdges & out_accurate_edges ) const

Shows the accurate edges setting.

Parameters

out_accurate_edges Whether to compute accurate edges for translation.

Returns: true if an accurate edges setting was specified, false otherwise.

◆ ShowApplication()

bool HPS::Exchange::TranslationOptionsKit::ShowApplication ( UTF8 & out_name ) const

Shows the application name setting.

Parameters

out_name The application name to put in the Parasolid data.

Returns: true if an application name setting was specified, false otherwise.

◆ ShowDisjointFaces()

bool HPS::Exchange::TranslationOptionsKit::ShowDisjointFaces ( bool & out_state ) const

Shows the disjoin faces setting.

Parameters

out_state Whether to disjoin erroneous faces from their owning solids.

Returns: true if a disjoin faces setting was specified, false otherwise.

◆ ShowEntityMerging()

bool HPS::Exchange::TranslationOptionsKit::ShowEntityMerging ( Translation::Merging & out_merging ) const

Shows the merging setting.

Parameters

out_merging Whether to merge entities for translation.

Returns: true if a merging setting was specified, false otherwise.

◆ ShowExplodeMultiBodies()

bool HPS::Exchange::TranslationOptionsKit::ShowExplodeMultiBodies ( bool & out_state ) const

Shows the explode multi bodies setting.

Parameters

out_state The explode multi bodies setting to put in the Parasolid data.

Returns: true if a explode multi bodies setting was specified, false otherwise.

◆ ShowHealing()

bool HPS::Exchange::TranslationOptionsKit::ShowHealing ( Translation::Healing & out_healing ) const

Shows the healing setting.

Parameters

out_healing Whether to heal data for translation.

Returns: true if a healing setting was specified, false otherwise.

◆ ShowHiddenObjects()

bool HPS::Exchange::TranslationOptionsKit::ShowHiddenObjects ( bool & out_state ) const

Shows the hidden object translation setting.

Parameters

out_state Whether to translate hidden objects.

Returns: true if a hidden object export setting was specified, false otherwise.

◆ ShowMultiProcessCount()

bool HPS::Exchange::TranslationOptionsKit::ShowMultiProcessCount ( unsigned int & out_count ) const

Shows the multi-process count setting.

Parameters

out_count The number of processes to use when performing translation.

Returns: true if a multi-process count setting was specified, false otherwise.

◆ ShowSewing()

bool HPS::Exchange::TranslationOptionsKit::ShowSewing	(	bool &	out_state,
		double &	out_tolerance
	)		const

Shows the sewing setting.

Parameters

out_state	Whether to perform sewing for translation.
out_tolerance	The sewing tolerance. Only valid if out_state is true.

Returns: true if a sewing setting was specified, false otherwise.

◆ ShowSimplification()

bool HPS::Exchange::TranslationOptionsKit::ShowSimplification ( Translation::Simplification & out_simplification ) const

Shows the simplification setting.

Parameters

out_simplification Whether to simplify geometry for translation.

Returns: true if a simplification setting was specified, false otherwise.

◆ ShowSolidsAsFaces()

bool HPS::Exchange::TranslationOptionsKit::ShowSolidsAsFaces ( bool & out_state ) const

Shows the solids to faces conversion setting.

Parameters

out_state Whether to convert solids to a set of independent faces for translation.

Returns: true if a solids to faces conversion setting was specified, false otherwise.

◆ ShowTessellation()

bool HPS::Exchange::TranslationOptionsKit::ShowTessellation ( bool & out_state ) const

Shows the tessellation translation setting.

Parameters

out_state Whether to export tessellation data.

Returns: true if a tessellation export setting was specified, false otherwise.

◆ ShowVersion()

bool HPS::Exchange::TranslationOptionsKit::ShowVersion ( UTF8 & out_version ) const

Shows the version string setting.

Parameters

out_version The version string to put in the Parasolid data.

Returns: true if a version string setting was specified, false otherwise.

◆ UnsetAccurateEdges()

TranslationOptionsKit& HPS::Exchange::TranslationOptionsKit::UnsetAccurateEdges ( )

Removes the accurate edges setting.

Returns: A reference to this TranslationOptionsKit.

◆ UnsetApplication()

TranslationOptionsKit& HPS::Exchange::TranslationOptionsKit::UnsetApplication ( )

Removes the application name setting.

Returns: A reference to this TranslationOptionsKit.

◆ UnsetDisjointFaces()

TranslationOptionsKit& HPS::Exchange::TranslationOptionsKit::UnsetDisjointFaces ( )

Removes the disjoin faces setting.

Returns: A reference to this TranslationOptionsKit.

◆ UnsetEntityMerging()

TranslationOptionsKit& HPS::Exchange::TranslationOptionsKit::UnsetEntityMerging ( )

Removes the merging setting.

Returns: A reference to this TranslationOptionsKit.

◆ UnsetEverything()

TranslationOptionsKit& HPS::Exchange::TranslationOptionsKit::UnsetEverything ( )

Removes all settings from this TranslationOptionsKit.

Returns: A reference to this TranslationOptionsKit.

◆ UnsetExplodeMultiBodies()

TranslationOptionsKit& HPS::Exchange::TranslationOptionsKit::UnsetExplodeMultiBodies ( )

Removes the explode multi bodies setting.

Returns: A reference to this TranslationOptionsKit.

◆ UnsetHealing()

TranslationOptionsKit& HPS::Exchange::TranslationOptionsKit::UnsetHealing ( )

Removes the healing setting.

Returns: A reference to this TranslationOptionsKit.

◆ UnsetHiddenObjects()

TranslationOptionsKit& HPS::Exchange::TranslationOptionsKit::UnsetHiddenObjects ( )

Removes the hidden objects export setting.

Returns: A reference to this TranslationOptionsKit.

◆ UnsetMultiProcessCount()

TranslationOptionsKit& HPS::Exchange::TranslationOptionsKit::UnsetMultiProcessCount ( )

Removes the multi-process count setting.

Returns: A reference to this TranslationOptionsKit.

◆ UnsetSewing()

TranslationOptionsKit& HPS::Exchange::TranslationOptionsKit::UnsetSewing ( )

Removes the sewing setting.

Returns: A reference to this TranslationOptionsKit.

◆ UnsetSimplification()

TranslationOptionsKit& HPS::Exchange::TranslationOptionsKit::UnsetSimplification ( )

Removes the simplification setting.

Returns: A reference to this TranslationOptionsKit.

◆ UnsetSolidsAsFaces()

TranslationOptionsKit& HPS::Exchange::TranslationOptionsKit::UnsetSolidsAsFaces ( )

Removes the solids to faces conversion setting.

Returns: A reference to this TranslationOptionsKit.

◆ UnsetTessellation()

TranslationOptionsKit& HPS::Exchange::TranslationOptionsKit::UnsetTessellation ( )

Removes the tessellation export setting.

Returns: A reference to this TranslationOptionsKit.

◆ UnsetVersion()

TranslationOptionsKit& HPS::Exchange::TranslationOptionsKit::UnsetVersion ( )

Removes the version string setting.

Returns: A reference to this TranslationOptionsKit.

The documentation for this class was generated from the following file:

include/sprk_exchange.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TranslationOptionsKit() [1/3]

◆ TranslationOptionsKit() [2/3]

◆ TranslationOptionsKit() [3/3]

Member Function Documentation

◆ Empty()

◆ Equals()

◆ GetDefault()

◆ ObjectType()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ Set()

◆ SetAccurateEdges()

◆ SetApplication()

◆ SetDisjointFaces()

◆ SetEntityMerging()

◆ SetExplodeMultiBodies()

◆ SetHealing()

◆ SetHiddenObjects()

◆ SetMultiProcessCount()

◆ SetSewing()

◆ SetSimplification()

◆ SetSolidsAsFaces()

◆ SetTessellation()

◆ SetVersion()

◆ Show()

◆ ShowAccurateEdges()

◆ ShowApplication()

◆ ShowDisjointFaces()

◆ ShowEntityMerging()

◆ ShowExplodeMultiBodies()

◆ ShowHealing()

◆ ShowHiddenObjects()

◆ ShowMultiProcessCount()

◆ ShowSewing()

◆ ShowSimplification()

◆ ShowSolidsAsFaces()

◆ ShowTessellation()

◆ ShowVersion()

◆ UnsetAccurateEdges()

◆ UnsetApplication()

◆ UnsetDisjointFaces()

◆ UnsetEntityMerging()

◆ UnsetEverything()

◆ UnsetExplodeMultiBodies()

◆ UnsetHealing()

◆ UnsetHiddenObjects()

◆ UnsetMultiProcessCount()

◆ UnsetSewing()

◆ UnsetSimplification()

◆ UnsetSolidsAsFaces()

◆ UnsetTessellation()

◆ UnsetVersion()