#include <sprk_parasolid.h>

Inheritance diagram for HPS::Parasolid::ExportOptionsKit:
HPS::SprocketKit HPS::Sprocket HPS::Object

Public Member Functions

bool Empty () const
 
bool Equals (ExportOptionsKit const &in_kit) const
 
 ExportOptionsKit ()
 
 ExportOptionsKit (ExportOptionsKit const &in_kit)
 
 ExportOptionsKit (ExportOptionsKit &&in_that)
 
HPS::Type ObjectType () const
 
bool operator!= (ExportOptionsKit const &in_kit) const
 
ExportOptionsKitoperator= (ExportOptionsKit &&in_that)
 
ExportOptionsKitoperator= (ExportOptionsKit const &in_kit)
 
bool operator== (ExportOptionsKit const &in_kit) const
 
void Set (ExportOptionsKit const &in_kit)
 
ExportOptionsKitSetFormat (Parasolid::Format in_format)
 
ExportOptionsKitSetUserFields (bool in_export_user_fields)
 
void Show (ExportOptionsKit &out_kit) const
 
bool ShowFormat (Parasolid::Format &out_format) const
 
bool ShowUserFields (bool &out_user_fields) const
 
ExportOptionsKitUnsetEverything ()
 
ExportOptionsKitUnsetFormat ()
 
ExportOptionsKitUnsetUserFields ()
 
- 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)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
virtual HPS::Type Type () const
 

Static Public Member Functions

static ExportOptionsKit 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::ParasolidExportOptionsKit
 
- 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
SprocketKitoperator= (SprocketKit &&in_that)
 
 SprocketKit (SprocketKit &&in_that)
 

Detailed Description

The ExportOptionsKit class is a user space object. It contains settings controlling what and how data is exported via Parasolid. Default values for the various fields of this class can be found here.

Constructor & Destructor Documentation

◆ ExportOptionsKit() [1/3]

HPS::Parasolid::ExportOptionsKit::ExportOptionsKit ( )

The default constructor creates an empty ExportOptionsKit object.

◆ ExportOptionsKit() [2/3]

HPS::Parasolid::ExportOptionsKit::ExportOptionsKit ( ExportOptionsKit const &  in_kit)

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

Parameters
in_kitThe source ExportOptionsKit to copy.

◆ ExportOptionsKit() [3/3]

HPS::Parasolid::ExportOptionsKit::ExportOptionsKit ( ExportOptionsKit &&  in_that)

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

Parameters
in_thatAn rvalue reference to an ExportOptionsKit to take the impl from.

Member Function Documentation

◆ Empty()

bool HPS::Parasolid::ExportOptionsKit::Empty ( ) const
virtual

Indicates whether this ExportOptionsKit has any values set on it.

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

Reimplemented from HPS::Object.

◆ Equals()

bool HPS::Parasolid::ExportOptionsKit::Equals ( ExportOptionsKit const &  in_kit) const

Check if the source ExportOptionsKit is equivalent to this ExportOptionsKit.

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

◆ GetDefault()

static ExportOptionsKit HPS::Parasolid::ExportOptionsKit::GetDefault ( )
static

Creates an ExportOptionsKit 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::Export.

Returns
An ExportOptionsKit with the default settings.

◆ ObjectType()

HPS::Type HPS::Parasolid::ExportOptionsKit::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::Parasolid::ExportOptionsKit::operator!= ( ExportOptionsKit const &  in_kit) const

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

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

◆ operator=() [1/2]

ExportOptionsKit& HPS::Parasolid::ExportOptionsKit::operator= ( ExportOptionsKit &&  in_that)

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

Parameters
in_thatAn rvalue reference to an ExportOptionsKit to take the impl from.
Returns
A reference to this ExportOptionsKit.

◆ operator=() [2/2]

ExportOptionsKit& HPS::Parasolid::ExportOptionsKit::operator= ( ExportOptionsKit const &  in_kit)

Copies the source ExportOptionsKit into this ExportOptionsKit.

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

◆ operator==()

bool HPS::Parasolid::ExportOptionsKit::operator== ( ExportOptionsKit const &  in_kit) const

Check if the source ExportOptionsKit is equivalent to this ExportOptionsKit.

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

◆ Set()

void HPS::Parasolid::ExportOptionsKit::Set ( ExportOptionsKit const &  in_kit)

Copies the source ExportOptionsKit into this ExportOptionsKit.

Parameters
in_kitThe source ExportOptionsKit to copy.

◆ SetFormat()

ExportOptionsKit& HPS::Parasolid::ExportOptionsKit::SetFormat ( Parasolid::Format  in_format)

Sets the format type to be exported.
This corresponds to the value that will be passed to PK_PART_transmit_o_t.transmit_format.

Parameters
in_formatThe format of the file to be exported.
Returns
A reference to this ExportOptionsKit.
See also
Default value

◆ SetUserFields()

ExportOptionsKit& HPS::Parasolid::ExportOptionsKit::SetUserFields ( bool  in_export_user_fields)

Sets whether to export user fields from the CAD file.
This corresponds to the value that will be passed to PK_PART_transmit_o_t.receive_user_fields.

Parameters
in_export_user_fieldsWhether to export user fields from the CAD file.
Returns
A reference to this ExportOptionsKit.

◆ Show()

void HPS::Parasolid::ExportOptionsKit::Show ( ExportOptionsKit out_kit) const

Copies this ExportOptionsKit into the given ExportOptionsKit.

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

◆ ShowFormat()

bool HPS::Parasolid::ExportOptionsKit::ShowFormat ( Parasolid::Format out_format) const

Shows the format export setting.

Parameters
out_formatThe format setting for this export.
Returns
true if a format setting was specified, false otherwise.

◆ ShowUserFields()

bool HPS::Parasolid::ExportOptionsKit::ShowUserFields ( bool &  out_user_fields) const

Shows the user fields export setting.

Parameters
out_user_fieldsThe user fields setting for this export.
Returns
true if a user fields setting was specified, false otherwise.

◆ UnsetEverything()

ExportOptionsKit& HPS::Parasolid::ExportOptionsKit::UnsetEverything ( )

Removes all settings from this ExportOptionsKit.

Returns
A reference to this ExportOptionsKit.

◆ UnsetFormat()

ExportOptionsKit& HPS::Parasolid::ExportOptionsKit::UnsetFormat ( )

Removes the format export state.

Returns
A reference to this ExportOptionsKit.

◆ UnsetUserFields()

ExportOptionsKit& HPS::Parasolid::ExportOptionsKit::UnsetUserFields ( )

Removes the user fields export state.

Returns
A reference to this ExportOptionsKit.

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