HPS::Exchange::ProductOccurrence
- class HPS.Exchange.ProductOccurrence : public HPS.Exchange.Component
Public Functions
- override void Dispose ()
- bool Equals (HPS.Exchange.ProductOccurrence in_kit)
Check if the source ProductOccurrence is equivalent to this ProductOccurrence.
- Param in_kit
The source ProductOccurrence to compare to this ProductOccurrence.
- Return
true if the objects are equivalent, false otherwise.
- override bool Equals (Object obj)
- override int GetHashCode ()
- HPS.Exchange.Layer[] GetLayers ()
Get the layers defined in this product occurrence.
- Return
A list of all layers defined in this product occurrence.
- HPS.Exchange.LoadStatus GetLoadStatus ()
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.
- Return
The load status for this product occurrence.
- bool IsExternalData ()
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.
- Return
A boolean which indicates if the product occurrence is an external data or not.
- override HPS.Type ObjectType ()
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).
- Return
The declared type of the object in question, which may differ from the true, underlying type.
- ProductOccurrence ()
The default constructor creates an empty ProductOccurrence object.
- ProductOccurrence (HPS.Component 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.
- Param in_that
The source Component to copy.
- ProductOccurrence (HPS.Exchange.Component 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.
- Param in_that
The source Component to copy.
- ProductOccurrence (HPS.Exchange.ProductOccurrence in_sheet)
The copy constructor creates a new ProductOccurrence object that contains the same settings as the source ProductOccurrence.
- Param in_sheet
The source ProductOccurrence to copy.
- void Unload ()
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.
- void Unload (HPS.Exchange.UnloadMode in_mode)
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.
- Param in_mode
The unload mode to use for this product occurrence.
Public Static Functions
- bool operator!= (HPS.Exchange.ProductOccurrence a, HPS.Exchange.ProductOccurrence b)
- bool operator== (HPS.Exchange.ProductOccurrence a, HPS.Exchange.ProductOccurrence b)
