HPS::Exchange::Factory

class HPS.Exchange.Factory : public HPS.Sprocket

The Factory class is used to create and Exchange objects which inherit from HPS.Component or one of its subclasses.

Public Functions

override void Dispose ()
Factory (HPS.Exchange.Factory in_that)

Public Static Functions

HPS.Exchange.CADModel CreateCADModel ()

Creates a new Exchange.CADModel.

HPS.Exchange.CADModel CreateCADModel (HPS.Model in_model)

Creates a new Exchange.CADModel.

Param in_model

The Model associated with the newly created Exchange.CADModel.

HPS.Exchange.CADModel CreateCADModel (HPS.Model in_model, IntPtr in_entity)

Creates a new Exchange.CADModel.

Param in_model

The Model associated with the newly created Exchange.CADModel.

Param in_entity

The Exchange entity associated with the newly created Exchange.CADModel.

HPS.Exchange.CADModel CreateCADModel (HPS.Model in_model, IntPtr in_entity, bool in_owns_entity)

Creates a new Exchange.CADModel.

Param in_model

The Model associated with the newly created Exchange.CADModel.

Param in_entity

The Exchange entity associated with the newly created Exchange.CADModel.

Param in_owns_entity

Whether the newly created Exchange.CADModel owns the associated A3DAsmModelFile (see the documentation for Exchange.CADModel::GetEntityOwnership for more details).

HPS.Exchange.Capture CreateCapture (HPS.Component in_owner)

Creates a new Exchange.Capture as a subcomponent of a given Component.

Param in_owner

The HPS.Component which owns the newly created Exchange.Capture.

HPS.Exchange.Capture CreateCapture (HPS.Component in_owner, IntPtr in_entity)

Creates a new Exchange.Capture as a subcomponent of a given Component.

Param in_owner

The HPS.Component which owns the newly created Exchange.Capture.

Param in_entity

The Exchange entity associated with the newly created Exchange.Capture.

HPS.Exchange.Capture CreateCapture (HPS.Component in_owner, IntPtr in_entity, bool in_is_default)

Creates a new Exchange.Capture as a subcomponent of a given Component.

Param in_owner

The HPS.Component which owns the newly created Exchange.Capture.

Param in_entity

The Exchange entity associated with the newly created Exchange.Capture.

Param in_is_default

Whether the newly created Exchange.Capture is the default capture for the CADModel, i.e., the capture that will be activated when CADModel.ActivateDefaultCapture is invoked. Note that if one is creating a default capture, the owner must be a CADModel (or subclass thereof) and this will delete the old default capture on that CADModel if one was present.

HPS.Exchange.Component CreateComponent (HPS.Component in_owner, HPS.Component.ComponentType in_type)

Creates a new Exchange.Component as a subcomponent of a given Component.

Param in_owner

The HPS.Component which owns the newly created Exchange.Component.

Param in_type

The type of Exchange.Component to create.

HPS.Exchange.Component CreateComponent (HPS.Component in_owner, HPS.Component.ComponentType in_type, IntPtr in_entity)

Creates a new Exchange.Component as a subcomponent of a given Component.

Param in_owner

The HPS.Component which owns the newly created Exchange.Component.

Param in_type

The type of Exchange.Component to create.

Param in_entity

The Exchange entity associated with the newly created Exchange.Component.

HPS.Exchange.Filter CreateFilter (HPS.Component in_owner)

Creates a new Exchange.Filter as a subcomponent of a given Component.

Param in_owner

The HPS.Component which owns the newly created Exchange.Filter.

HPS.Exchange.Filter CreateFilter (HPS.Component in_owner, IntPtr in_entity)

Creates a new Exchange.Filter as a subcomponent of a given Component.

Param in_owner

The HPS.Component which owns the newly created Exchange.Filter.

Param in_entity

The Exchange entity associated with the newly created Exchange.Filter.

HPS.Exchange.Sheet CreateSheet (HPS.Component in_owner)

Creates a new Exchange.Sheet as a subcomponent of a given Component.

Param in_owner

The HPS.Component which owns the newly created Exchange.Sheet.

HPS.Exchange.Sheet CreateSheet (HPS.Component in_owner, IntPtr in_entity)

Creates a new Exchange.Sheet as a subcomponent of a given Component.

Param in_owner

The HPS.Component which owns the newly created Exchange.Sheet.

Param in_entity

The Exchange entity associated with the newly created Exchange.Sheet.

HPS.Exchange.Component DeInstanceComponent (HPS.ComponentPath in_component_path)

Returns the component at whose level changes can be made without influencing other instances of the same component. The ComponentPath passed to this function needs to include a component of type Representation Item.

Param in_component_path

The ComponentPath to operate on.

Return

The newly de-instanced Component.