#include <sprk_exchange.h>

Inheritance diagram for HPS::Exchange::ExportJTOptionsKit:
HPS::SprocketKit HPS::Sprocket HPS::Object

Public Member Functions

bool Empty () const
 
bool Equals (ExportJTOptionsKit const &in_kit) const
 
 ExportJTOptionsKit ()
 
 ExportJTOptionsKit (ExportJTOptionsKit const &in_kit)
 
 ExportJTOptionsKit (ExportJTOptionsKit &&in_that)
 
HPS::Type ObjectType () const
 
bool operator!= (ExportJTOptionsKit const &in_kit) const
 
ExportJTOptionsKitoperator= (ExportJTOptionsKit const &in_kit)
 
ExportJTOptionsKitoperator= (ExportJTOptionsKit &&in_that)
 
bool operator== (ExportJTOptionsKit const &in_kit) const
 
void Set (ExportJTOptionsKit const &in_kit)
 
ExportJTOptionsKitSetContent (JT::Content in_content)
 
ExportJTOptionsKitSetHiddenObjects (bool in_state)
 
ExportJTOptionsKitSetPMI (bool in_state)
 
ExportJTOptionsKitSetVersion (JT::Version in_version)
 
void Show (ExportJTOptionsKit &out_kit) const
 
bool ShowContent (JT::Content &out_content) const
 
bool ShowHiddenObjects (bool &out_state) const
 
bool ShowPMI (bool &out_state) const
 
bool ShowVersion (JT::Version &out_version) const
 
ExportJTOptionsKitUnsetContent ()
 
ExportJTOptionsKitUnsetEverything ()
 
ExportJTOptionsKitUnsetHiddenObjects ()
 
ExportJTOptionsKitUnsetPMI ()
 
ExportJTOptionsKitUnsetVersion ()
 
- 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 ExportJTOptionsKit 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::ExchangeExportJTOptionsKit
 
- 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 HPS::Exchange::ExportJTOptionsKit class is a user space object. It contains settings controlling how JT data is exported via Exchange. Calling HPS::Exchange::ExportJTOptionsKit::GetDefault() will return an options kit with values found in here.

Constructor & Destructor Documentation

◆ ExportJTOptionsKit() [1/3]

HPS::Exchange::ExportJTOptionsKit::ExportJTOptionsKit ( )

The default constructor creates an empty ExportJTOptionsKit object.

◆ ExportJTOptionsKit() [2/3]

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

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

Parameters
in_kitThe source ExportJTOptionsKit to copy.

◆ ExportJTOptionsKit() [3/3]

HPS::Exchange::ExportJTOptionsKit::ExportJTOptionsKit ( ExportJTOptionsKit &&  in_that)

The move constructor creates an ExportJTOptionsKit by transferring the underlying object of the rvalue reference to this ExportJTOptionsKit.

Parameters
in_thatAn rvalue reference to an ExportJTOptionsKit to take the underlying object from.

Member Function Documentation

◆ Empty()

bool HPS::Exchange::ExportJTOptionsKit::Empty ( ) const
virtual

Indicates whether this ExportJTOptionsKit has any values set on it.

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

Reimplemented from HPS::Object.

◆ Equals()

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

Check if the source ExportJTOptionsKit is equivalent to this ExportJTOptionsKit.

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

◆ GetDefault()

static ExportJTOptionsKit HPS::Exchange::ExportJTOptionsKit::GetDefault ( )
static

Creates an ExportJTOptionsKit 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::ExportJT.

Returns
An ExportJTOptionsKit with the default settings.

◆ ObjectType()

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

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

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

◆ operator=() [1/2]

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

Copies the source ExportJTOptionsKit into this ExportJTOptionsKit.

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

◆ operator=() [2/2]

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

The move assignment operator transfers the underlying object of the rvalue reference to this ExportJTOptionsKit.

Parameters
in_thatAn rvalue reference to an ExportJTOptionsKit to take the underlying object from.
Returns
A reference to this ExportJTOptionsKit.

◆ operator==()

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

Check if the source ExportJTOptionsKit is equivalent to this ExportJTOptionsKit.

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

◆ Set()

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

Copies the source ExportJTOptionsKit into this ExportJTOptionsKit.

Parameters
in_kitThe source ExportJTOptionsKit to copy.

◆ SetContent()

ExportJTOptionsKit& HPS::Exchange::ExportJTOptionsKit::SetContent ( JT::Content  in_content)

Sets the type of data to export. This corresponds to the value that will be passed to A3DRWParamsExportJTData::m_eWriteGeomTessMode.

Parameters
in_contentThe type of data to export.
Returns
A reference to this ExportJTOptionsKit.
See also
Default value

◆ SetHiddenObjects()

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

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

Parameters
in_stateWhether to export hidden objects.
Returns
A reference to this ExportJTOptionsKit.
See also
Default value

◆ SetPMI()

ExportJTOptionsKit& HPS::Exchange::ExportJTOptionsKit::SetPMI ( bool  in_state)

Sets whether to export PMI. This corresponds to the value that will be passed to A3DRWParamsExportJTData::m_bWritePMI.

Parameters
in_stateWhether to export PMI.
Returns
A reference to this ExportJTOptionsKit.
See also
Default value

◆ SetVersion()

ExportJTOptionsKit& HPS::Exchange::ExportJTOptionsKit::SetVersion ( JT::Version  in_version)

Sets the version of the JT format to export. This corresponds to the value that will be passed to A3DRWParamsExportJTData::m_eJTVersion.

Parameters
in_versionThe version of the JT format to export.
Returns
A reference to this ExportJTOptionsKit.
See also
Default value

◆ Show()

void HPS::Exchange::ExportJTOptionsKit::Show ( ExportJTOptionsKit out_kit) const

Copies this ExportJTOptionsKit into the given ExportJTOptionsKit.

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

◆ ShowContent()

bool HPS::Exchange::ExportJTOptionsKit::ShowContent ( JT::Content out_content) const

Shows the content export setting.

Parameters
out_contentThe type of data to export.
Returns
true if a content export setting was specified, false otherwise.

◆ ShowHiddenObjects()

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

Shows the hidden object export setting.

Parameters
out_stateWhether to export hidden objects.
Returns
true if a hidden object export setting was specified, false otherwise.

◆ ShowPMI()

bool HPS::Exchange::ExportJTOptionsKit::ShowPMI ( bool &  out_state) const

Shows the PMI export setting.

Parameters
out_stateWhether to export PMI.
Returns
true if a PMI export setting was specified, false otherwise.

◆ ShowVersion()

bool HPS::Exchange::ExportJTOptionsKit::ShowVersion ( JT::Version out_version) const

Shows the version export setting.

Parameters
out_versionThe version of the JT format to export.
Returns
true if a version export setting was specified, false otherwise.

◆ UnsetContent()

ExportJTOptionsKit& HPS::Exchange::ExportJTOptionsKit::UnsetContent ( )

Removes the content export setting.

Returns
A reference to this ExportJTOptionsKit.

◆ UnsetEverything()

ExportJTOptionsKit& HPS::Exchange::ExportJTOptionsKit::UnsetEverything ( )

Removes all settings from this ExportJTOptionsKit.

Returns
A reference to this ExportJTOptionsKit.

◆ UnsetHiddenObjects()

ExportJTOptionsKit& HPS::Exchange::ExportJTOptionsKit::UnsetHiddenObjects ( )

Removes the hidden objects export setting.

Returns
A reference to this ExportJTOptionsKit.

◆ UnsetPMI()

ExportJTOptionsKit& HPS::Exchange::ExportJTOptionsKit::UnsetPMI ( )

Removes the PMI export setting.

Returns
A reference to this ExportJTOptionsKit.

◆ UnsetVersion()

ExportJTOptionsKit& HPS::Exchange::ExportJTOptionsKit::UnsetVersion ( )

Removes the version export setting.

Returns
A reference to this ExportJTOptionsKit.

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