
Public Member Functions | |
bool | Equals (ProductOccurrence const &in_kit) const |
LoadStatus | GetLoadStatus () const |
HPS::Type | ObjectType () const |
bool | operator!= (ProductOccurrence const &in_kit) const |
ProductOccurrence & | operator= (ProductOccurrence &&in_that) |
bool | operator== (ProductOccurrence const &in_kit) const |
ProductOccurrence () | |
ProductOccurrence (HPS::Component const &in_that) | |
ProductOccurrence (Component const &in_that) | |
ProductOccurrence (ProductOccurrence const &in_sheet) | |
ProductOccurrence (ProductOccurrence &&in_that) | |
void | Unload (UnloadMode in_mode=UnloadMode::ExchangeAndVisualization) |
![]() | |
Component () | |
Component (HPS::Component const &in_that) | |
Component (Exchange::Component const &in_that) | |
Component (Exchange::Component &&in_that) | |
A3DEntity * | GetExchangeEntity () const |
Component & | operator= (Exchange::Component &&in_that) |
ReloadNotifier | Reload (TessellationOptionsKit const &in_tessellation_options=TessellationOptionsKit(), TranslationOptionsKit const &in_translation_options=TranslationOptionsKit()) |
void | Tessellate (TessellationOptionsKit const &in_options) |
TranslationNotifier | Translate (Units in_units, TranslationOptionsKit const &in_translation_options) |
virtual | ~Component () |
![]() | |
void | AddKey (Key const &in_key) |
void | AddOwner (Component &in_owner, IncludeKey const &in_include=IncludeKey()) |
void | AddReference (Component &in_reference) |
virtual void | Assign (Component const &in_that) |
Component () | |
Component (Component const &in_that) | |
Component (Component &&in_that) | |
void | Delete () |
bool | Equals (Component const &in_that) const |
void | Flush () |
MetadataArray | GetAllMetadata () const |
ComponentArray | GetAllSubcomponents (ComponentType in_type) const |
ComponentType | GetComponentType () const |
KeyArray | GetKeys () const |
Metadata | GetMetadata (char const *in_name) const |
UTF8 | GetName () const |
ComponentArray | GetOwners () const |
ComponentArray | GetReferences () const |
ComponentArray | GetReferrers () const |
ComponentArray | GetSubcomponents () const |
bool | HasComponentType (ComponentType in_mask) const |
bool | operator!= (Component const &in_that) const |
Component & | operator= (Component const &in_that) |
Component & | operator= (Component &&in_that) |
bool | operator== (Component const &in_that) const |
![]() | |
Sprocket (Sprocket &&in_that) | |
![]() | |
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 () |
HPS::Type | Type () const |
Constructor & Destructor Documentation
HPS::Exchange::ProductOccurrence::ProductOccurrence | ( | ) |
The default constructor creates an empty ProductOccurrence object.
HPS::Exchange::ProductOccurrence::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.
HPS::Exchange::ProductOccurrence::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.
HPS::Exchange::ProductOccurrence::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.
HPS::Exchange::ProductOccurrence::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.
Member Function Documentation
bool HPS::Exchange::ProductOccurrence::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.
LoadStatus HPS::Exchange::ProductOccurrence::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.
|
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 HPS::Exchange::Component.
bool HPS::Exchange::ProductOccurrence::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& HPS::Exchange::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 HPS::Exchange::ProductOccurrence::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.
void HPS::Exchange::ProductOccurrence::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.
The documentation for this class was generated from the following file:
- include/sprk_exchange.h