All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATPLMFmaModelerInterfaces Interface CATIFmaPositioningServices

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface CATIFmaPositioningServices

Interfaces that provides the capability to define the specifications of the associative positioning of a fastener component or the fastener itself according to other fastener objects (fastener components, fastened parts or fastener itself).

Method Index

o CreateAxisAxisCoincidenceConstraint(CATBaseUnknown*,CATOmbObjectInContext*,CATOmbObjectInContext*)

Creates a coincidence constraint in an engineering connection aggregated into the specified product between:

the fastener axis and a fastener component axis
a fastener component axis and a published axis of a fasten part
the fastener axis and a published axis of a fastener part
two fastener component axis Note: In case of Impacts on Fastener Instance, the specification of constraint will be added to the existing fastener engineering connection (if no constraint specification was existing before)

o CreatePlanePlaneContactConstraint(CATBaseUnknown*,CATOmbObjectInContext*,CATOmbObjectInContext*,CATFmaCstOrientation)

Creates a contact constraint in an engineering connection aggregated into the specified product between:

the fastener plane and a fastener component plane
a fastener component plane and a published support of a fasten part
the fastener plane and a published support of a fastener part
two fastener component planes Note: In case of Impacts on Fastener Instance, the specification of constraint will be added to the existing fastener engineering connection (if no constraint specification was existing before)

o CreateRevoluteConstraints(CATBaseUnknown*,CATOmbObjectInContext*,CATOmbObjectInContext*,CATOmbObjectInContext*,CATOmbObjectInContext*)

Creates a ‘Revolute’ constraint specification in an engineering connection aggregated into the specified reference product.

o DeleteConstraints(CATOmbObjectInContext*)

Deletes all the constraints that drive the associative positioning of the input specified fastener component or fastener itself.

Methods

o CreateAxisAxisCoincidenceConstraint

public virtual CreateAxisAxisCoincidenceConstraint(	const	`ipParent`,
	const	`ipAxisImpactedBy`,
	const	`ipAxisImpactsOn`)

Creates a coincidence constraint in an engineering connection aggregated into the specified product between:

the fastener axis and a fastener component axis
a fastener component axis and a published axis of a fasten part
the fastener axis and a published axis of a fastener part
two fastener component axis Note: In case of Impacts on Fastener Instance, the specification of constraint will be added to the existing fastener engineering connection (if no constraint specification was existing before)

Parameters:

ipParent: the reference product that will contain the constraint specifications
ipAxisImpactedBy: the information representing the ‘impacted by’ axis, i.e. the one that is “driving” the position Note: This CATOmbObjectInContext Info can ONLY be a CATOmbObjectInContext of a publication of an axis that is aggregated by: - the Fastener reference (in this case its name must be Fst_Axis) - another Fastener component (no naming convention) - a fastener joined part (no naming convention)
ipAxisImpactsOn: the information representing the ‘impact on’ axis, i.e. the one whose position is “driven” Note: This CATOmbObjectInContext info can ONLY be a CATOmbObjectInContext of a publication of an axis that is aggregated by: - the Fastener reference (in this case its name must be Fst_Axis) - the Fastener component (no naming convention)

Returns:

S_OK if the constraint specification has been successfully created
E_INVALIDARG if at least one input CATOmbObjectInContext Info is invalid (not publication of axis, or not fastener object...)
E_FAIL otherwise

o CreatePlanePlaneContactConstraint

public virtual CreatePlanePlaneContactConstraint(	const	`ipParent`,
	const	`ipPlaneImpactedBy`,
	const	`ipPlaneImpactsOn`,
	const	`iOrientation`	`= CATFmaCstOrientation_Same`)

Creates a contact constraint in an engineering connection aggregated into the specified product between:

the fastener plane and a fastener component plane
a fastener component plane and a published support of a fasten part
the fastener plane and a published support of a fastener part
two fastener component planes Note: In case of Impacts on Fastener Instance, the specification of constraint will be added to the existing fastener engineering connection (if no constraint specification was existing before)

Parameters:

ipParent: the reference product that will contain the constraint specifications
ipPlaneImpactedBy: the information representing the ‘impacted by’ plane, i.e. the one that is “driving” the position Note: this CATOmbObjectInContext info can ONLY be a CATOmbObjectInContext of a publication of a plane that is aggregated by: - the fastener reference (in this case its name must be Fst_Plane) - another Fastener component (no naming convention) - a fastener joined part (no naming convention)
ipAxisImpactsOn: the information representing the ‘impact on’ plane i.e. the one whose position is “driven” Note: This CATOmbObjectInContext info can ONLY be a CATOmbObjectInContext of a publication of a plane that is aggregated by: - the Fastener reference (in this case its name must be Fst_Axis) - the Fastener component (no naming convention)
iOrientation: the constraint orientation. See CATFmaEnumDef.h for information about the possible values

Returns:

S_OK if the constraint specification has been successfully created
E_INVALIDARG if at least one input CATOmbObjectInContext Info is invalid (not publication of axis, or not fastener object...)
E_FAIL otherwise

o CreateRevoluteConstraints

public virtual CreateRevoluteConstraints(	const	`ipParent`,
	const	`ipAxisImpactedBy`,
	const	`ipAxisImpactsOn`,
	const	`ipPlaneImpactedBy`,
	const	`ipPlaneImpactsOn`)

Creates a ‘Revolute’ constraint specification in an engineering connection aggregated into the specified reference product. It is made of:

An axis-axis coincidence constraint between: - the fastener axis and the fastener component axis - or 2 fastener component axis - or a fastener joined part axis and the fastener axis - or a fastener joined part axis and the fastener component axis.
A plane-plane contact constraint between: - the fastener plane and the fastener component plane - or 2 fastener component planes - or a fastener joined part plane and the fastener plane - or a fastener joined part plane and the fastener component plane.

Parameters:

ipParent: the reference product that will contain the constraint specifications
ipAxisImpactedBy: the information representing the ‘impacted by’ axis, i.e. the one that is “driving” the position Note: This CATOmbObjectInContext info can ONLY be a CATOmbObjectInContext of a publication of an axis that is aggregated by: - the Fastener reference (in this case its name must be Fst_Axis) - another Fastener component (no naming convention) - a fastener joined part (no naming convention)
ipAxisImpactsOn: the information representing the ‘impact on’ axis, the one whose position is “driven” Note: This CATOmbObjectInContext info can ONLY be a CATOmbObjectInContext of a publication of an axis that is aggregated by: - the Fastener reference (in this case its name must be Fst_Axis) - the Fastener component (no naming convention)
ipPlaneImpactedBy: the information representing the ‘impacted by’ plane, i.e. the one that is “driving” the position Note: ipPlaneImpactedBy and ipAxisImpactedBy must be associated to publications of elements that belong to the same reference product.
ipPlaneImpactsOn: the information representing the ‘impact on’ plane, the one whose position is “driven” Note: ipPlaneImpactsOn and ipAxisImpactsOn must be associated to publications of elements that belong to the same reference product.

Returns:

S_OK if the constraint specification has been successfully created
E_INVALIDARG if at least one input OmbObjectInContext is invalid (not publication of axis, or not fastener object...)
E_FAIL otherwise

o DeleteConstraints

public virtual DeleteConstraints( const ipImpactsOn)

Deletes all the constraints that drive the associative positioning of the input specified fastener component or fastener itself. Note: This method deletes the constraints that pointing on “Impact on” the specified fastener object.

Parameters:

ipImpactsOn: the information representing the ‘impact on’ fastener object i.e. the one whose position is “driven" Note: this CATOmbObjectInContext info can ONLY be a CATOmbObjectInContext whose the path of first instance is: - the Fastener reference (in this case its name must be Fst_Axis) - the Fastener component (no naming convention) Note: all the constraints specifications aggregated by all reference products specified through the path of first instance that drive the input specified fastener object will be deleted.

Returns:

S_OK if if at least one constraint specification was found and deleted
E_FAIL otherwise

This object is included in the file: CATIFmaPositioningServices.h
If needed, your Imakefile.mk should include the module: CATPLMFmaModelerInterfaces