All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATEngConnectionUseItf Interface CATIEngConnection

Usage: you must use this class as is. You should never derive it.

interface CATIEngConnection

This interface is implemented by the Engineering Connection.

Role: Contains API to manage the Engineering Connection.

Method Index

o GetDirection(int,CATIEngConnection::Direction&): Returns the direction in the Engineering Connection.
o GetImpacted(int,CATOmbObjectInContext*&,CATOmbObjectInContext*&): Returns the impacted instances.
o GetNbImpacted(int&): Returns the number of impacted.
o GetParent(CATIPLMProducts*&): Returns the PLM product aggregating the Engineering Connection
o SetDirection(int,CATIEngConnection::Direction): Sets the direction in the Engineering Connection.

o Direction: Engineering Connection direction.
o Type: Engineering Connection type.

Methods

o GetDirection

public virtual GetDirection(		`inbp`,
		`odir`)

Returns the direction in the Engineering Connection.
Role: The direction specifies how impacted instances are moving.

Parameters:

inbp: [in] Impacted instance identifier.
odir: [out] the direction.

Returns:

S_OK: if the operation is successful.
E_FAIL: if the operation is failed.

o GetImpacted

public virtual GetImpacted(		`inbe`,
		`oImpacted`,
		`oContext`)

Returns the impacted instances.

Parameters:

inbe: [in] The indice of impacted .
oImpacted: [out] The impacted instance.
oContext: [out] The link to the instance for contextual Engineering Connection. If the pointer is NULL, the Engineering Connection is not contextual.

Returns:

E_FAIL: if the operation is failed.
S_OK: if the operation is successful.

o GetNbImpacted

public virtual GetNbImpacted( oNbImpacted)

Returns the number of impacted.

Parameters:

oNbImpacted: [out] The number of impacted.

Returns:

E_FAIL: if the operation is failed.
S_OK: if the operation is successful.

o GetParent

public virtual GetParent( oparent)

Returns the PLM product aggregating the Engineering Connection

Parameters:

oparent: [out] The parent PLM product.

Returns:

E_FAIL: If the operation is failed.
S_OK: If the operation is successful.

o SetDirection

public virtual SetDirection(		`inbp`,
		`idir`)

Sets the direction in the Engineering Connection.
Role: The direction specifies how impacted instances are moving.

Parameters:

inbp: [in] Impacted instance identifier.
odir: [out] the direction.

Returns:

S_OK: if the operation is successful.
E_FAIL: if the operation is failed.

Enumerated Types

o Direction

enum Direction {
  Direction_Error,
  Direction_In,
  Direction_Out
}

Engineering Connection direction.

Parameters:

Direction_Error: Not used. Can be returned in case of error.
Direction_In: The element cannot move.
Direction_Out: The element can move.

o Type

enum Type {
  Type_UserDefined,
  Type_Rigid,
  Type_Spherical,
  Type_Cylindrical,
  Type_Planar,
  Type_Prismatic,
  Type_Revolute,
  Type_PointCurve,
  Type_PointSurface,
  Type_Gear,
  Type_Rack,
  Type_Cable,
  Type_Universal,
  Type_RollCurve
}

Engineering Connection type.

Parameters:

Type_UserDefined,: .
Type_Rigid,: .
Type_Spherical,: .
Type_Cylindrical,: .
Type_Planar,: .
Type_Prismatic,: .
Type_Revolute: .
Type_PointCurve: .
Type_PointSurface: .
Type_Gear: .
Type_Rack: .
Type_Cable: .
Type_Universal: .
Type_RollCurve: .

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

CATEngConnectionUseItf Interface CATIEngConnection

Method Index

Enumerated Type Index

Methods

Enumerated Types