#include <sprk_exchange.h>

Public Member Functions | |
void | Assign (TranslationNotifier const &in_that) |
HPS::Time | GetImportTime () const |
Exchange::ParasolidEntityArray | GetParasolidParts () const |
HPS::Time | GetTranslationTime () const |
HPS::Type | ObjectType () const |
TranslationNotifier & | operator= (TranslationNotifier &&in_that) |
TranslationNotifier & | operator= (TranslationNotifier const &in_that) |
TranslationNotifier () | |
TranslationNotifier (TranslationNotifier const &in_that) | |
TranslationNotifier (IONotifier const &in_that) | |
TranslationNotifier (TranslationNotifier &&in_that) | |
![]() | |
void | Assign (IONotifier const &in_that) |
IONotifier & | Cancel () |
IONotifier () | |
IONotifier (IONotifier const &in_that) | |
IONotifier (IONotifier &&in_that) | |
IONotifier & | operator= (IONotifier &&in_that) |
IONotifier & | operator= (IONotifier const &in_that) |
IOResult | Status () const |
IOResult | Status (float &out_percent_complete) const |
IONotifier & | Wait () |
![]() | |
virtual bool | Empty () const |
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 Attributes | |
static const HPS::Type | staticType = HPS::Type::ExchangeTranslationNotifier |
![]() | |
static const HPS::Type | staticType = HPS::Type::IONotifier |
![]() | |
static const HPS::Type | staticType = HPS::Type::None |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Detailed Description
The TranslationNotifier class is a smart-pointer that is tied to a file translation. It is used to interact with an ongoing translation or get the results from a completed translation.
Constructor & Destructor Documentation
HPS::Exchange::TranslationNotifier::TranslationNotifier | ( | ) |
The default constructor creates an TranslationNotifier object which is not tied to any file translation.
HPS::Exchange::TranslationNotifier::TranslationNotifier | ( | TranslationNotifier const & | in_that | ) |
The copy constructor creates a new TranslationNotifier object that is associated with the same file translation as the source TranslationNotifier.
- Parameters
-
in_that The source TranslationNotifier to copy.
HPS::Exchange::TranslationNotifier::TranslationNotifier | ( | IONotifier const & | in_that | ) |
The conversion constructor creates a new derived TranslationNotifier object from a base IONotifier object. The copy will only be successful if the source notifier is really an upcast of this notifier type. Otherwise the copy will fail and the resulting TranslationNotifier will be invalid.
- Parameters
-
in_that The source IONotifier to copy.
HPS::Exchange::TranslationNotifier::TranslationNotifier | ( | TranslationNotifier && | in_that | ) |
The move constructor creates an TranslationNotifier by transferring the underlying impl of the rvalue reference to this TranslationNotifier thereby avoiding a copy and allocation.
- Parameters
-
in_that An rvalue reference to an TranslationNotifier to take the impl from.
Member Function Documentation
void HPS::Exchange::TranslationNotifier::Assign | ( | TranslationNotifier const & | in_that | ) |
Associate this TranslationNotifier with the same file translation as the source TranslationNotifier.
- Parameters
-
in_that The source TranslationNotifier for the assignment.
HPS::Time HPS::Exchange::TranslationNotifier::GetImportTime | ( | ) | const |
Get the number of milliseconds it took Exchange to read the CAD file(s) and generate the corresponding PRC data. Throws an IOException if the translation is not complete, was not successful or was canceled.
Exchange::ParasolidEntityArray HPS::Exchange::TranslationNotifier::GetParasolidParts | ( | ) | const |
Get the Parasolid parts obtained from the translation. Throws an IOException if the translation is not complete, was not successful or was canceled.
- Returns
- The Parasolid Parts for a successful file translation.
HPS::Time HPS::Exchange::TranslationNotifier::GetTranslationTime | ( | ) | const |
Get the number of milliseconds it took Exchange to translate the PRC data into Parasolid data. Throws an IOException if the translation is not complete, was not successful or was canceled.
TranslationNotifier& HPS::Exchange::TranslationNotifier::operator= | ( | TranslationNotifier && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this TranslationNotifier thereby avoiding a copy.
- Parameters
-
in_that An rvalue reference to an TranslationNotifier to take the impl from.
- Returns
- A reference to this TranslationNotifier.
TranslationNotifier& HPS::Exchange::TranslationNotifier::operator= | ( | TranslationNotifier const & | in_that | ) |
Associate this TranslationNotifier with the same file translation as the source TranslationNotifier.
- Parameters
-
in_that The source TranslationNotifier for the assignment.
- Returns
- A reference to this TranslationNotifier.
The documentation for this class was generated from the following file:
- include/sprk_exchange.h