Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
HPS.Exchange.Factory Class Reference

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

Inheritance diagram for HPS.Exchange.Factory:
HPS.Sprocket HPS.Object

Public Member Functions

override void Dispose ()
 
- Public Member Functions inherited from HPS.Sprocket
 Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
 Object (HPS.Object in_that)
 The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More...
 
HPS.Type Type ()
 This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More...
 
virtual HPS.Type ObjectType ()
 This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More...
 
virtual bool Empty ()
 Indicates whether this object has any values set on it. More...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More...
 

Static Public Member Functions

static 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. More...
 
static 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. More...
 
static HPS.Exchange.CADModel CreateCADModel (HPS.Model in_model, IntPtr in_entity, bool in_owns_entity)
 Creates a new Exchange::CADModel. More...
 
static HPS.Exchange.CADModel CreateCADModel (HPS.Model in_model, IntPtr in_entity)
 Creates a new Exchange::CADModel. More...
 
static HPS.Exchange.CADModel CreateCADModel (HPS.Model in_model)
 Creates a new Exchange::CADModel. More...
 
static HPS.Exchange.CADModel CreateCADModel ()
 Creates a new Exchange::CADModel. More...
 
static HPS.Exchange.Filter CreateFilter (HPS.Component in_owner, IntPtr in_entity)
 Creates a new Exchange::Filter as a subcomponent of a given Component. More...
 
static HPS.Exchange.Filter CreateFilter (HPS.Component in_owner)
 Creates a new Exchange::Filter as a subcomponent of a given Component. More...
 
static 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. More...
 
static HPS.Exchange.Capture CreateCapture (HPS.Component in_owner, IntPtr in_entity)
 Creates a new Exchange::Capture as a subcomponent of a given Component. More...
 
static HPS.Exchange.Capture CreateCapture (HPS.Component in_owner)
 Creates a new Exchange::Capture as a subcomponent of a given Component. More...
 
static HPS.Exchange.Sheet CreateSheet (HPS.Component in_owner, IntPtr in_entity)
 Creates a new Exchange::Sheet as a subcomponent of a given Component. More...
 
static HPS.Exchange.Sheet CreateSheet (HPS.Component in_owner)
 Creates a new Exchange::Sheet as a subcomponent of a given Component. More...
 
- 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.Sprocket
enum  UpdateType { Synchronous = 0, Asynchronous = 1 }
 The type of update to perform, either synchronous or asynchronous. More...
 
- Protected Attributes inherited from HPS.Object
HandleRef cptr
 
HandleRef scptr
 
bool cMemOwn
 

Detailed Description

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

Member Function Documentation

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

Creates a new Exchange::CADModel.

Parameters
in_modelThe Model associated with the newly created <ref refid="class_h_p_s_1_1_exchange_1_1_c_a_d_model" kindref="compound">Exchange::CADModel</ref>.
in_entityThe <ref refid="class_h_p_s_1_1_exchange" kindref="compound">Exchange</ref> entity associated with the newly created <ref refid="class_h_p_s_1_1_exchange_1_1_c_a_d_model" kindref="compound">Exchange::CADModel</ref>.
in_owns_entityWhether the newly created <ref refid="class_h_p_s_1_1_exchange_1_1_c_a_d_model" kindref="compound">Exchange::CADModel</ref> owns the associated A3DAsmModelFile (see the documentation for <ref refid="class_h_p_s_1_1_exchange_1_1_c_a_d_model_1afb206977d12bd43276c94f63c0a9e227" kindref="member">Exchange::CADModel::GetEntityOwnership</ref> for more details).
static HPS.Exchange.CADModel HPS.Exchange.Factory.CreateCADModel ( HPS.Model  in_model,
IntPtr  in_entity 
)
inlinestatic

Creates a new Exchange::CADModel.

Parameters
in_modelThe Model associated with the newly created <ref refid="class_h_p_s_1_1_exchange_1_1_c_a_d_model" kindref="compound">Exchange::CADModel</ref>.
in_entityThe <ref refid="class_h_p_s_1_1_exchange" kindref="compound">Exchange</ref> entity associated with the newly created <ref refid="class_h_p_s_1_1_exchange_1_1_c_a_d_model" kindref="compound">Exchange::CADModel</ref>.
static HPS.Exchange.CADModel HPS.Exchange.Factory.CreateCADModel ( HPS.Model  in_model)
inlinestatic

Creates a new Exchange::CADModel.

Parameters
in_modelThe Model associated with the newly created <ref refid="class_h_p_s_1_1_exchange_1_1_c_a_d_model" kindref="compound">Exchange::CADModel</ref>.
static HPS.Exchange.CADModel HPS.Exchange.Factory.CreateCADModel ( )
inlinestatic

Creates a new Exchange::CADModel.

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

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

Parameters
in_ownerThe HPS::Component which owns the newly created <ref refid="class_h_p_s_1_1_exchange_1_1_capture" kindref="compound">Exchange::Capture</ref>.
in_entityThe <ref refid="class_h_p_s_1_1_exchange" kindref="compound">Exchange</ref> entity associated with the newly created <ref refid="class_h_p_s_1_1_exchange_1_1_capture" kindref="compound">Exchange::Capture</ref>.
in_is_defaultWhether the newly created <ref refid="class_h_p_s_1_1_exchange_1_1_capture" kindref="compound">Exchange::Capture</ref> is the default capture for the <ref refid="class_h_p_s_1_1_exchange_1_1_c_a_d_model" kindref="compound">CADModel</ref>, 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 <ref refid="class_h_p_s_1_1_exchange_1_1_c_a_d_model" kindref="compound">CADModel</ref> (or subclass thereof) and this will delete the old default capture on that <ref refid="class_h_p_s_1_1_exchange_1_1_c_a_d_model" kindref="compound">CADModel</ref> if one was present.
static HPS.Exchange.Capture HPS.Exchange.Factory.CreateCapture ( HPS.Component  in_owner,
IntPtr  in_entity 
)
inlinestatic

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

Parameters
in_ownerThe HPS::Component which owns the newly created <ref refid="class_h_p_s_1_1_exchange_1_1_capture" kindref="compound">Exchange::Capture</ref>.
in_entityThe <ref refid="class_h_p_s_1_1_exchange" kindref="compound">Exchange</ref> entity associated with the newly created <ref refid="class_h_p_s_1_1_exchange_1_1_capture" kindref="compound">Exchange::Capture</ref>.
static HPS.Exchange.Capture HPS.Exchange.Factory.CreateCapture ( HPS.Component  in_owner)
inlinestatic

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

Parameters
in_ownerThe HPS::Component which owns the newly created <ref refid="class_h_p_s_1_1_exchange_1_1_capture" kindref="compound">Exchange::Capture</ref>.
static HPS.Exchange.Component HPS.Exchange.Factory.CreateComponent ( HPS.Component  in_owner,
HPS.Component.ComponentType  in_type,
IntPtr  in_entity 
)
inlinestatic

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

Parameters
in_ownerThe HPS::Component which owns the newly created <ref refid="class_h_p_s_1_1_exchange_1_1_component" kindref="compound">Exchange::Component</ref>.
in_typeThe type of <ref refid="class_h_p_s_1_1_exchange_1_1_component" kindref="compound">Exchange::Component</ref> to create.
in_entityThe <ref refid="class_h_p_s_1_1_exchange" kindref="compound">Exchange</ref> entity associated with the newly created <ref refid="class_h_p_s_1_1_exchange_1_1_component" kindref="compound">Exchange::Component</ref>.
static HPS.Exchange.Component HPS.Exchange.Factory.CreateComponent ( HPS.Component  in_owner,
HPS.Component.ComponentType  in_type 
)
inlinestatic

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

Parameters
in_ownerThe HPS::Component which owns the newly created <ref refid="class_h_p_s_1_1_exchange_1_1_component" kindref="compound">Exchange::Component</ref>.
in_typeThe type of <ref refid="class_h_p_s_1_1_exchange_1_1_component" kindref="compound">Exchange::Component</ref> to create.
static HPS.Exchange.Filter HPS.Exchange.Factory.CreateFilter ( HPS.Component  in_owner,
IntPtr  in_entity 
)
inlinestatic

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

Parameters
in_ownerThe HPS::Component which owns the newly created <ref refid="class_h_p_s_1_1_exchange_1_1_filter" kindref="compound">Exchange::Filter</ref>.
in_entityThe <ref refid="class_h_p_s_1_1_exchange" kindref="compound">Exchange</ref> entity associated with the newly created <ref refid="class_h_p_s_1_1_exchange_1_1_filter" kindref="compound">Exchange::Filter</ref>.
static HPS.Exchange.Filter HPS.Exchange.Factory.CreateFilter ( HPS.Component  in_owner)
inlinestatic

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

Parameters
in_ownerThe HPS::Component which owns the newly created <ref refid="class_h_p_s_1_1_exchange_1_1_filter" kindref="compound">Exchange::Filter</ref>.
static HPS.Exchange.Sheet HPS.Exchange.Factory.CreateSheet ( HPS.Component  in_owner,
IntPtr  in_entity 
)
inlinestatic

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

Parameters
in_ownerThe HPS::Component which owns the newly created <ref refid="class_h_p_s_1_1_exchange_1_1_sheet" kindref="compound">Exchange::Sheet</ref>.
in_entityThe <ref refid="class_h_p_s_1_1_exchange" kindref="compound">Exchange</ref> entity associated with the newly created <ref refid="class_h_p_s_1_1_exchange_1_1_sheet" kindref="compound">Exchange::Sheet</ref>.
static HPS.Exchange.Sheet HPS.Exchange.Factory.CreateSheet ( HPS.Component  in_owner)
inlinestatic

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

Parameters
in_ownerThe HPS::Component which owns the newly created <ref refid="class_h_p_s_1_1_exchange_1_1_sheet" kindref="compound">Exchange::Sheet</ref>.

The documentation for this class was generated from the following file: