< Home

< Table of Contents

REFERENCE MANUAL

Exchange::TranslationNotifier Class Reference

#include <sprk_exchange.h>

Inheritance diagram for Exchange::TranslationNotifier:
IONotifier Object

Public Member Functions

void Assign (TranslationNotifier const &in_that)
 
Time GetModelLoadTime () const
 
Exchange::ParasolidEntityArray GetParasolidParts () const
 
Time GetTranslationTime () const
 
Type ObjectType () const
 
TranslationNotifieroperator= (TranslationNotifier &&in_that)
 
TranslationNotifieroperator= (TranslationNotifier const &in_that)
 
 TranslationNotifier ()
 
 TranslationNotifier (TranslationNotifier const &in_that)
 
 TranslationNotifier (IONotifier const &in_that)
 
 TranslationNotifier (TranslationNotifier &&in_that)
 
- Public Member Functions inherited from IONotifier
void Assign (IONotifier const &in_that)
 
void Cancel ()
 
 IONotifier ()
 
 IONotifier (IONotifier const &in_that)
 
 IONotifier (IONotifier &&in_that)
 
IONotifieroperator= (IONotifier &&in_that)
 
IONotifieroperator= (IONotifier const &in_that)
 
IOResult Status () const
 
IOResult Status (float &out_percent_complete) const
 
void Wait ()
 
- Public Member Functions inherited from Object
virtual bool Empty () const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (Type in_mask) const
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
Type Type () const
 

Additional Inherited Members

- Static Public Member Functions inherited from Object
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

Exchange::TranslationNotifier::TranslationNotifier ( )

The default constructor creates an TranslationNotifier object which is not tied to any file translation.

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_thatThe source TranslationNotifier to copy.
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_thatThe source IONotifier to copy.
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_thatAn rvalue reference to an TranslationNotifier to take the impl from.

Member Function Documentation

void Exchange::TranslationNotifier::Assign ( TranslationNotifier const &  in_that)

Associate this TranslationNotifier with the same file translation as the source TranslationNotifier.

Parameters
in_thatThe source TranslationNotifier for the assignment.
Time Exchange::TranslationNotifier::GetModelLoadTime ( ) const

Get time it took Exchange to load the model into memory

Returns
The time it took Exchange to load the model into memory. Specified in seconds
Exchange::ParasolidEntityArray 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.
Time Exchange::TranslationNotifier::GetTranslationTime ( ) const

Get time it took Exchange translate the model into Parasolid parts

Returns
The time it took Exchange to translate the model into Parasolid parts. Specified in seconds
Type Exchange::TranslationNotifier::ObjectType ( ) const
inlinevirtual

This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from IONotifier.

TranslationNotifier& 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_thatAn rvalue reference to an TranslationNotifier to take the impl from.
Returns
A reference to this TranslationNotifier.
TranslationNotifier& Exchange::TranslationNotifier::operator= ( TranslationNotifier const &  in_that)

Associate this TranslationNotifier with the same file translation as the source TranslationNotifier.

Parameters
in_thatThe source TranslationNotifier for the assignment.
Returns
A reference to this TranslationNotifier.

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