Inheritance diagram for HPS.Exchange.ProductOccurrence:
HPS.Exchange.Component HPS.Component HPS.Sprocket HPS.Object

Public Member Functions

override void Dispose ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Exchange.ProductOccurrence in_kit)
 
override int GetHashCode ()
 
HPS.Exchange.LoadStatus GetLoadStatus ()
 
bool IsExternalData ()
 
override HPS.Type ObjectType ()
 
 ProductOccurrence ()
 
 ProductOccurrence (HPS.Component in_that)
 
 ProductOccurrence (HPS.Exchange.Component in_that)
 
 ProductOccurrence (HPS.Exchange.ProductOccurrence in_sheet)
 
void Unload (HPS.Exchange.UnloadMode in_mode)
 
void Unload ()
 
- Public Member Functions inherited from HPS.Exchange.Component
bool AddTransform (HPS.MatrixKit in_transform)
 
 Component ()
 
 Component (HPS.Component in_that)
 
 Component (HPS.Exchange.Component in_that)
 
HPS.Component CopyTo (HPS.Component in_new_owner)
 
IntPtr GetExchangeEntity ()
 
HPS.Exchange.ReloadNotifier Reload (HPS.Exchange.TessellationOptionsKit in_tessellation_options, HPS.Exchange.TranslationOptionsKit in_translation_options)
 
HPS.Exchange.ReloadNotifier Reload (HPS.Exchange.TessellationOptionsKit in_tessellation_options)
 
HPS.Exchange.ReloadNotifier Reload ()
 
bool SetName (string in_new_name)
 
bool SetTransform (HPS.MatrixKit in_transform)
 
void Tessellate (HPS.Exchange.TessellationOptionsKit in_options)
 
HPS.Exchange.TranslationNotifier Translate (HPS.Exchange.Units in_units, HPS.Exchange.TranslationOptionsKit in_translation_options)
 
- Public Member Functions inherited from HPS.Component
void AddKey (HPS.Key in_key)
 
void AddOwner (HPS.Component in_owner, HPS.IncludeKey in_include)
 
void AddOwner (HPS.Component in_owner)
 
void AddReference (HPS.Component in_reference)
 
bool AddTransform (HPS.MatrixKit in_transform)
 
virtual void Assign (HPS.Component in_that)
 
 Component ()
 
 Component (HPS.Component in_that)
 
HPS.Component CopyTo (HPS.Component in_new_owner)
 
void Delete (HPS.Component.DeleteMode mode)
 
void Delete ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Component in_that)
 
void Flush ()
 
HPS.Metadata [] GetAllMetadata ()
 
HPS.Component [] GetAllSubcomponents (HPS.Component.ComponentType in_type)
 
HPS.Component.ComponentType GetComponentType ()
 
override int GetHashCode ()
 
HPS.Key [] GetKeys ()
 
HPS.Metadata GetMetadata (string in_name)
 
string GetName ()
 
HPS.Component [] GetOwners ()
 
HPS.Component [] GetReferences ()
 
HPS.Component [] GetReferrers ()
 
HPS.Component [] GetSubcomponents ()
 
bool HasComponentType (HPS.Component.ComponentType in_mask)
 
bool SetName (string in_new_name)
 
bool SetTransform (HPS.MatrixKit in_transform)
 
- Public Member Functions inherited from HPS.Sprocket
Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

Static Public Member Functions

static bool operator!= (HPS.Exchange.ProductOccurrence a, HPS.Exchange.ProductOccurrence b)
 
static bool operator== (HPS.Exchange.ProductOccurrence a, HPS.Exchange.ProductOccurrence b)
 
- Static Public Member Functions inherited from HPS.Component
static HPS.KeyPath [] GetKeyPath (HPS.Component in_component)
 
static HPS.KeyPath [] GetKeyPath (HPS.Component[] in_components)
 
static bool operator!= (HPS.Component a, HPS.Component b)
 
static bool operator== (HPS.Component a, HPS.Component b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Public Types inherited from HPS.Component
enum  ComponentType : uint {
None = 0x00000000, GenericMask = 0xFFFFF000, ComponentType.ExchangeComponentMask = 0x00001000, ComponentType.ExchangeModelFile = 0x00001001,
ComponentType.ExchangeProductOccurrence = 0x00001002, ComponentType.ExchangePartDefinition = 0x00001003, ComponentType.ExchangeView = 0x00001004, ComponentType.ExchangeFilter = 0x00001005,
ComponentType.ExchangeRepresentationItemMask = 0x00003000, ComponentType.ExchangeRIBRepModel = 0x00003001, ComponentType.ExchangeRICurve = 0x00003002, ComponentType.ExchangeRIDirection = 0x00003003,
ComponentType.ExchangeRIPlane = 0x00003004, ComponentType.ExchangeRIPointSet = 0x00003005, ComponentType.ExchangeRIPolyBRepModel = 0x00003006, ComponentType.ExchangeRIPolyWire = 0x00003007,
ComponentType.ExchangeRISet = 0x00003008, ComponentType.ExchangeRICoordinateSystem = 0x00003009, ComponentType.ExchangeTopologyMask = 0x00005000, ComponentType.ExchangeTopoBody = 0x00005001,
ComponentType.ExchangeTopoConnex = 0x00005002, ComponentType.ExchangeTopoShell = 0x00005003, ComponentType.ExchangeTopoFace = 0x00005004, ComponentType.ExchangeTopoLoop = 0x00005005,
ComponentType.ExchangeTopoCoEdge = 0x00005006, ComponentType.ExchangeTopoEdge = 0x00005007, ComponentType.ExchangeTopoVertex = 0x00005008, ComponentType.ExchangeTopoSingleWireBody = 0x00005009,
ComponentType.ExchangeTopoWireEdge = 0x0000500A, ComponentType.ExchangeDrawingMask = 0x00009000, ComponentType.ExchangeDrawingModel = 0x00009001, ComponentType.ExchangeDrawingView = 0x00009002,
ComponentType.ExchangeDrawingSheet = 0x00009003, ComponentType.ExchangeBasicDrawingBlock = 0x00009004, ComponentType.ExchangeOperatorDrawingBlock = 0x00009005, ComponentType.ExchangePMIMask = 0x00011000,
ComponentType.ExchangePMI = 0x00011000, ComponentType.ExchangePMIText = 0x00011100, ComponentType.ExchangePMIRichText = 0x00011200, ComponentType.ExchangePMIRoughness = 0x00011300,
ComponentType.ExchangePMIGDT = 0x00011400, ComponentType.ExchangePMIDatum = 0x00011500, ComponentType.ExchangePMILineWelding = 0x00011600, ComponentType.ExchangePMISpotWelding = 0x00011700,
ComponentType.ExchangePMIDimension = 0x00011800, ComponentType.ExchangePMIBalloon = 0x00011900, ComponentType.ExchangePMICoordinate = 0x00011A00, ComponentType.ExchangePMIFastener = 0x00011B00,
ComponentType.ExchangePMILocator = 0x00011C00, ComponentType.ExchangePMIMeasurementPoint = 0x00011D00, ComponentType.ParasolidComponentMask = 0x00020000, ComponentType.ParasolidModelFile = 0x00020001,
ComponentType.ParasolidAssembly = 0x00020002, ComponentType.ParasolidInstance = 0x00020003, ComponentType.ParasolidTopologyMask = 0x00060000, ComponentType.ParasolidTopoBody = 0x00060001,
ComponentType.ParasolidTopoRegion = 0x00060002, ComponentType.ParasolidTopoShell = 0x00060003, ComponentType.ParasolidTopoFace = 0x00060004, ComponentType.ParasolidTopoLoop = 0x00060005,
ComponentType.ParasolidTopoFin = 0x00060006, ComponentType.ParasolidTopoEdge = 0x00060007, ComponentType.ParasolidTopoVertex = 0x00060008, ComponentType.DWGComponentMask = 0x00100000,
ComponentType.DWGModelFile = 0x00100001, ComponentType.DWGLayout = 0x00100002, ComponentType.DWGBlockTable = 0x00100003, ComponentType.DWGBlockTableRecord = 0x00100004,
ComponentType.DWGEntity = 0x00100005, ComponentType.DWGLayerTable = 0x00100006, ComponentType.DWGLayer = 0x00100007, ComponentType.UserComponent = 0x01000000
}





 
enum  DeleteMode { Standard = 0, Full = 1, StandardAndExchange = 2 }
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Constructor & Destructor Documentation

◆ ProductOccurrence() [1/4]

HPS.Exchange.ProductOccurrence.ProductOccurrence ( )
inline

The default constructor creates an empty ProductOccurrence object.

◆ ProductOccurrence() [2/4]

HPS.Exchange.ProductOccurrence.ProductOccurrence ( HPS.Component  in_that)
inline

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_thatThe source Component to copy.

◆ ProductOccurrence() [3/4]

HPS.Exchange.ProductOccurrence.ProductOccurrence ( HPS.Exchange.Component  in_that)
inline

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_thatThe source Component to copy.

◆ ProductOccurrence() [4/4]

HPS.Exchange.ProductOccurrence.ProductOccurrence ( HPS.Exchange.ProductOccurrence  in_sheet)
inline

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

Parameters
in_sheetThe source ProductOccurrence to copy.

Member Function Documentation

◆ Equals()

bool HPS.Exchange.ProductOccurrence.Equals ( HPS.Exchange.ProductOccurrence  in_kit)
inline

Check if the source ProductOccurrence is equivalent to this ProductOccurrence.

Parameters
in_kitThe source ProductOccurrence to compare to this ProductOccurrence.
Returns
true if the objects are equivalent, false otherwise.

◆ GetLoadStatus()

HPS.Exchange.LoadStatus HPS.Exchange.ProductOccurrence.GetLoadStatus ( )
inline

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.

◆ IsExternalData()

bool HPS.Exchange.ProductOccurrence.IsExternalData ( )
inline

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.

◆ ObjectType()

override HPS.Type HPS.Exchange.ProductOccurrence.ObjectType ( )
inlinevirtual

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.

Reimplemented from HPS.Exchange.Component.

◆ Unload() [1/2]

void HPS.Exchange.ProductOccurrence.Unload ( HPS.Exchange.UnloadMode  in_mode)
inline

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_modeThe unload mode to use for this product occurrence.

◆ Unload() [2/2]

void HPS.Exchange.ProductOccurrence.Unload ( )
inline

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.


The documentation for this class was generated from the following file:
  • internals/hps_sprk_exchange/source/cs/HPS.Exchange.cs