HPS::Exchange::ProductOccurrence

class HPS::Exchange::ProductOccurrence : public HPS::Exchange::Component

Public Functions

bool Equals(ProductOccurrence const &in_kit) const

Check if the source ProductOccurrence is equivalent to this ProductOccurrence.

Parameters: in_kit – The source ProductOccurrence to compare to this ProductOccurrence.
Returns: true if the objects are equivalent, false otherwise.

LayerArray GetLayers() const

Get the layers defined in this product occurrence.

Returns: A list of all layers defined in this product occurrence.

LoadStatus GetLoadStatus() const

Gets the load status for this product occurrence. This is primarily relevant for product occurrences coming from formats that support incremental loading. For product occurrences coming from formats that don’t support incremental loading, it can provide information about which product occurrences contain no data or could not be loaded (e.g., if there are missing files in an assembly), however, such product occurrences are still not capable of being incrementally loaded.

Returns: The load status for this product occurrence.

bool IsExternalData() const

This function will check if the A3DEntity under the HPS::Exchange::Component from where we call it is an External Data Product Occurrence or not.

Returns: A boolean which indicates if the product occurrence is an external data or not.

inline virtual HPS::Type ObjectType() const

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.

bool operator!=(ProductOccurrence const &in_kit) const

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

Parameters: in_kit – The source ProductOccurrence to compare to this ProductOccurrence.
Returns: true if the objects are not equivalent, false otherwise.

ProductOccurrence &operator=(const ProductOccurrence &that)

ProductOccurrence &operator=(ProductOccurrence &&in_that)

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

Parameters: in_that – An rvalue reference to a ProductOccurrence to take the impl from.
Returns: A reference to this ProductOccurrence.

bool operator==(ProductOccurrence const &in_kit) const

Check if the source ProductOccurrence is equivalent to this ProductOccurrence.

Parameters: in_kit – The source ProductOccurrence to compare to this ProductOccurrence.
Returns: true if the objects are equivalent, false otherwise.

ProductOccurrence(): The default constructor creates an empty ProductOccurrence object.

ProductOccurrence(Component const &in_that)

This constructor creates a ProductOccurrence object that shares the underlying smart-pointer of the source Component. The copy will only be successful if the source component is really an upcast of an Exchange::ProductOccurrence object. Otherwise the copy will fail and the resulting Exchange::ProductOccurrence will be invalid.

Parameters: in_that – The source Component to copy.

ProductOccurrence(HPS::Component const &in_that)

This constructor creates a ProductOccurrence object that shares the underlying smart-pointer of the source Component. The copy will only be successful if the source component is really an upcast of an Exchange::ProductOccurrence object. Otherwise the copy will fail and the resulting Exchange::ProductOccurrence will be invalid.

Parameters: in_that – The source Component to copy.

ProductOccurrence(ProductOccurrence &&in_that)

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

Parameters: in_that – An rvalue reference to a ProductOccurrence to take the impl from.

ProductOccurrence(ProductOccurrence const &in_sheet)

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

Parameters: in_sheet – The source ProductOccurrence to copy.

void Unload(UnloadMode in_mode = UnloadMode::ExchangeAndVisualization)

Unloads this product occurrence. This will remove the underlying data from Exchange for this component and potentially also the corresponding component objects depending on the specified UnloadMode. This operation can only be performed for product occurrence components coming from file formats that support incremental loading (see ImportMode::Incremental). If you try to unload a product occurrence coming from a format that does not support incremental loading, an exception will be thrown.

Parameters: in_mode – The unload mode to use for this product occurrence.

virtual ~ProductOccurrence()

Public Static Attributes

static const HPS::Type staticType = HPS::Type::ExchangeProductOccurrence