#include <sprk_exchange.h>

Public Member Functions | |
bool | Empty () const |
bool | Equals (ExportACISOptionsKit const &in_kit) const |
ExportACISOptionsKit () | |
ExportACISOptionsKit (ExportACISOptionsKit const &in_kit) | |
ExportACISOptionsKit (ExportACISOptionsKit &&in_that) | |
HPS::Type | ObjectType () const |
bool | operator!= (ExportACISOptionsKit const &in_kit) const |
ExportACISOptionsKit & | operator= (ExportACISOptionsKit const &in_kit) |
ExportACISOptionsKit & | operator= (ExportACISOptionsKit &&in_that) |
bool | operator== (ExportACISOptionsKit const &in_kit) const |
void | Set (ExportACISOptionsKit const &in_kit) |
ExportACISOptionsKit & | SetBinary (bool in_state) |
ExportACISOptionsKit & | SetMillimeterUnits (bool in_state) |
void | Show (ExportACISOptionsKit &out_kit) const |
bool | ShowBinary (bool &out_state) const |
bool | ShowMillimeterUnits (bool &out_state) const |
ExportACISOptionsKit & | UnsetBinary () |
ExportACISOptionsKit & | UnsetEverything () |
ExportACISOptionsKit & | UnsetMillimeterUnits () |
![]() | |
Sprocket (Sprocket &&in_that) | |
![]() | |
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 ExportACISOptionsKit | GetDefault () |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Static Public Attributes | |
static const HPS::Type | staticType = HPS::Type::ExchangeExportACISOptionsKit |
![]() | |
static const HPS::Type | staticType = HPS::Type::SprocketKit |
![]() | |
static const HPS::Type | staticType = HPS::Type::None |
Additional Inherited Members | |
![]() | |
SprocketKit & | operator= (SprocketKit &&in_that) |
SprocketKit (SprocketKit &&in_that) | |
Detailed Description
The HPS::Exchange::ExportACISOptionsKit class is a user space object. It contains settings controlling how ACIS data is exported via the Exchange interface. Calling HPS::Exchange::ExportACISOptionsKit::GetDefault() will return an options kit with values found in here.
Constructor & Destructor Documentation
◆ ExportACISOptionsKit() [1/3]
HPS::Exchange::ExportACISOptionsKit::ExportACISOptionsKit | ( | ) |
The default constructor creates an empty ExportACISOptionsKit object.
◆ ExportACISOptionsKit() [2/3]
HPS::Exchange::ExportACISOptionsKit::ExportACISOptionsKit | ( | ExportACISOptionsKit const & | in_kit | ) |
The copy constructor creates a new ExportACISOptionsKit object that contains the same settings as the source ExportACISOptionsKit.
- Parameters
-
in_kit The source ExportACISOptionsKit to copy.
◆ ExportACISOptionsKit() [3/3]
HPS::Exchange::ExportACISOptionsKit::ExportACISOptionsKit | ( | ExportACISOptionsKit && | in_that | ) |
The move constructor creates an ExportACISOptionsKit by transferring the underlying object of the rvalue reference to this ExportACISOptionsKit.
- Parameters
-
in_that An rvalue reference to an ExportACISOptionsKit to take the underlying object from.
Member Function Documentation
◆ Empty()
|
virtual |
Indicates whether this ExportACISOptionsKit has any values set on it.
- Returns
- true if no values are set on this ExportACISOptionsKit, false otherwise.
Reimplemented from HPS::Object.
◆ Equals()
bool HPS::Exchange::ExportACISOptionsKit::Equals | ( | ExportACISOptionsKit const & | in_kit | ) | const |
Check if the source ExportACISOptionsKit is equivalent to this ExportACISOptionsKit.
- Parameters
-
in_kit The source ExportACISOptionsKit to compare to this ExportACISOptionsKit.
- Returns
- true if the objects are equivalent, false otherwise.
◆ GetDefault()
|
static |
Creates an ExportACISOptionsKit 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::ExportACIS.
- Returns
- An ExportACISOptionsKit with the default settings.
◆ ObjectType()
|
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::ExportACISOptionsKit::operator!= | ( | ExportACISOptionsKit const & | in_kit | ) | const |
Check if the source ExportACISOptionsKit is not equivalent to this ExportACISOptionsKit.
- Parameters
-
in_kit The source ExportACISOptionsKit to compare to this ExportACISOptionsKit.
- Returns
- true if the objects are not equivalent, false otherwise.
◆ operator=() [1/2]
ExportACISOptionsKit& HPS::Exchange::ExportACISOptionsKit::operator= | ( | ExportACISOptionsKit const & | in_kit | ) |
Copies the source ExportACISOptionsKit into this ExportACISOptionsKit.
- Parameters
-
in_kit The source ExportACISOptionsKit to copy.
- Returns
- A reference to this ExportACISOptionsKit.
◆ operator=() [2/2]
ExportACISOptionsKit& HPS::Exchange::ExportACISOptionsKit::operator= | ( | ExportACISOptionsKit && | in_that | ) |
The move assignment operator transfers the underlying object of the rvalue reference to this ExportACISOptionsKit.
- Parameters
-
in_that An rvalue reference to an ExportACISOptionsKit to take the underlying object from.
- Returns
- A reference to this ExportACISOptionsKit.
◆ operator==()
bool HPS::Exchange::ExportACISOptionsKit::operator== | ( | ExportACISOptionsKit const & | in_kit | ) | const |
Check if the source ExportACISOptionsKit is equivalent to this ExportACISOptionsKit.
- Parameters
-
in_kit The source ExportACISOptionsKit to compare to this ExportACISOptionsKit.
- Returns
- true if the objects are equivalent, false otherwise.
◆ Set()
void HPS::Exchange::ExportACISOptionsKit::Set | ( | ExportACISOptionsKit const & | in_kit | ) |
Copies the source ExportACISOptionsKit into this ExportACISOptionsKit.
- Parameters
-
in_kit The source ExportACISOptionsKit to copy.
◆ SetBinary()
ExportACISOptionsKit& HPS::Exchange::ExportACISOptionsKit::SetBinary | ( | bool | in_state | ) |
Sets whether to write ACIS data in binary form. This corresponds to the value that will be passed to A3DRWParamsExportAcisData::m_bSaveAsBinary.
- Parameters
-
in_state Whether to write ACIS data in binary form.
- Returns
- A reference to this ExportACISOptionsKit.
- See also
- Default value
◆ SetMillimeterUnits()
ExportACISOptionsKit& HPS::Exchange::ExportACISOptionsKit::SetMillimeterUnits | ( | bool | in_state | ) |
Sets whether to write ACIS data in millimeter units instead of the native units of the CADModel. This corresponds to the value that will be passed to A3DRWParamsExportAcisData::m_bSaveAsMillimeter.
- Parameters
-
in_state Whether to write ACIS data in millimeter units instead of the native units of the CADModel.
- Returns
- A reference to this ExportACISOptionsKit.
- See also
- Default value
◆ Show()
void HPS::Exchange::ExportACISOptionsKit::Show | ( | ExportACISOptionsKit & | out_kit | ) | const |
Copies this ExportACISOptionsKit into the given ExportACISOptionsKit.
- Parameters
-
out_kit The ExportACISOptionsKit to populate with the contents of this ExportACISOptionsKit.
◆ ShowBinary()
bool HPS::Exchange::ExportACISOptionsKit::ShowBinary | ( | bool & | out_state | ) | const |
Shows the binary export setting.
- Parameters
-
out_state Whether to write ACIS data in binary form.
- Returns
- true if a binary export setting was specified, false otherwise.
◆ ShowMillimeterUnits()
bool HPS::Exchange::ExportACISOptionsKit::ShowMillimeterUnits | ( | bool & | out_state | ) | const |
Shows the millimeter unit export setting.
- Parameters
-
out_state Whether to write ACIS data in millimeter units instead of the native units of the CADModel.
- Returns
- true if a millimeter unit export setting was specified, false otherwise.
◆ UnsetBinary()
ExportACISOptionsKit& HPS::Exchange::ExportACISOptionsKit::UnsetBinary | ( | ) |
Removes the binary export setting.
- Returns
- A reference to this ExportACISOptionsKit.
◆ UnsetEverything()
ExportACISOptionsKit& HPS::Exchange::ExportACISOptionsKit::UnsetEverything | ( | ) |
Removes all settings from this ExportACISOptionsKit.
- Returns
- A reference to this ExportACISOptionsKit.
◆ UnsetMillimeterUnits()
ExportACISOptionsKit& HPS::Exchange::ExportACISOptionsKit::UnsetMillimeterUnits | ( | ) |
Removes the millimeter unit export setting.
- Returns
- A reference to this ExportACISOptionsKit.
The documentation for this class was generated from the following file:
- include/sprk_exchange.h