All Frameworks Class Hierarchy This Framework Indexes
ElecDeviceItf Interface CATIElbSingleConnector
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIElbSingleConnector
Interface to manage Single Connectors.
Method Index
- o
AddConnectorCnctPt(CATUnicodeString&,CATIProduct*,CATILinkableObject*,CATUnicodeString&,CATListValCATBaseUnknown_var*,CATIElbConnectorCnctPt*&)
-
Add Connector Connection Point on Device.
- o
ConnectBackShell(CATIElbBackShellCnctPt*,CATIElbBackShell*,int&)
- Connect the single connector with a back shell.
- o
ConnectSingleConnector(CATIElbConnectorCnctPt*,CATIElbSingleConnector*,int&)
- Connect the single connector with a single connector.
- o
Connect(CATIElbCavity*,CATIElbEquipment*,int&)
- Connect the single connector with an Equipment.
- o
Connect(CATIElbCavity*,CATIElbConnectorShell*,int&)
- Connect the single connector with a Shell connector.
- o
Connect(CATIElbCavity*,CATIElbMountingEquipment*,int&)
- Connect the single connector with a Mounting Equipment.
- o
GetFatherCavity(CATIElbCavity*&)
- Get Father Cavity.
- o
ListBackShellCnctPts(CATListValCATBaseUnknown_var*&)
- List of BackShellCnctPts.
- o
ListBackShells(CATListValCATBaseUnknown_var*&)
- List the Back Shells assembled to the Single Insert Connector.
- o
ListBundleCnctPts(CATListValCATBaseUnknown_var*&)
- List of BundleCnctPts.
- o
ListCavities(CATListValCATBaseUnknown_var*&)
- List of Cavities.
- o
ListConnectorCnctPts(CATListValCATBaseUnknown_var*&)
- List of ConnectorCnctPts.
- o
ListDeviceComposition(CATListValCATBaseUnknown_var*&)
- List Device Composition.
- o
ListMatingConnectors(CATListValCATBaseUnknown_var*&)
- List Mating Connectors.
- o
ListTerminations(CATListValCATBaseUnknown_var*&)
- List of Terminations.
Methods
o AddConnectorCnctPt
| public virtual AddConnectorCnctPt( | const | iId, |
| | iGeoDefinition, |
| | iRepresentation, |
| const | iJointType, |
| | iJointReferences, |
| | oConnectorCnctPt) |
-
Add Connector Connection Point on Device.
- Parameters:
-
- iId
- Identifier (Name)
- iGeoDefinition
- Define the Leaf Product where Joint's Graphical elements and
representation come from
- iRepresentation
- Connector's graphical representation (optional)
- iJointType
- Joint's type
- iJointReferences
- Graphical elements used to realize joint
- oConnectorCnctPt
- The connector
- Returns:
- Return code
o ConnectBackShell
| public virtual ConnectBackShell( | | ipElecBackShellCnctPt, |
| | ipElecBackShellTarget, |
| | StatusOfGeometricalConstraint) |
-
Connect the single connector with a back shell.
- Parameters:
-
- ipElecBackShellCnctPt
- The back shell connection point of this
- ipElecBackShellTarget
- The back shell used to be connected with single connector.
- StatusOfGeometricalConstraint
- Value is: 0 if all geometrical constraint are correctly created.
1 if a geometrical constraint is over constraint.
2 if no geometrical constraint was defined to constraint the device between them.
- Returns:
- Return code
o ConnectSingleConnector
| public virtual ConnectSingleConnector( | | ipElecConnectorCnctPt, |
| | ipElecSingleConnector, |
| | StatusOfGeometricalConstraint) |
-
Connect the single connector with a single connector.
- Parameters:
-
- ipElecConnectorCnctPt
- The connector connection point of this.
- ipElecSingleConnector
- The single connector used to be connected with single connector.
- StatusOfGeometricalConstraint
- Value is: 0 if all geometrical constraint are correctly created.
1 if a geometrical constraint is over constraint.
2 if no geometry is defined to constraint the device between them.
- Returns:
- Return code
o Connect
| public virtual Connect( | | ipCavity, |
| | ipEquipment, |
| | oStatusOfGeometricalConstraint) |
-
Connect the single connector with an Equipment.
- Parameters:
-
- ipCavity
- The cavity of the Equipment.
- ipEquipment
- The Equipment to be connected
- StatusOfGeometricalConstraint
- Value is: 0 if all geometrical constraint are correctly created.
1 if a geometrical constraint is over constraint.
2 if no geometry is defined to constraint the device between them.
- Returns:
- An HRESULT value.
S_OK : no error.
E_FAIL : Error occured while connecting devices.
S_FALSE : Devices already connected.
o Connect
| public virtual Connect( | | ipCavity, |
| | ipShell, |
| | oStatusOfGeometricalConstraint) |
-
Connect the single connector with a Shell connector.
- Parameters:
-
- ipCavity
- The cavity of Shell connector.
- ipShell
- The Shell Connector to be connected
- StatusOfGeometricalConstraint
- Value is: 0 if all geometrical constraint are correctly created.
1 if a geometrical constraint is over constraint.
2 if no geometry is defined to constraint the device between them.
- Returns:
- An HRESULT value.
S_OK : no error.
E_FAIL : Error occured while connecting devices.
S_FALSE : Devices already connected.
o Connect
| public virtual Connect( | | ipCavity, |
| | ipMountingEquipment, |
| | oStatusOfGeometricalConstraint) |
-
Connect the single connector with a Mounting Equipment.
- Parameters:
-
- ipCavity
- The cavity of Mounting Equipment.
- ipMountingEquipment
- The Mounting Equipment to be connected
- StatusOfGeometricalConstraint
- Value is: 0 if all geometrical constraint are correctly created.
1 if a geometrical constraint is over constraint.
2 if no geometry is defined to constraint the device between them.
- Returns:
- An HRESULT value.
S_OK : no error.
E_FAIL : Error occured while connecting devices.
S_FALSE : Devices already connected.
o GetFatherCavity
| public virtual GetFatherCavity( | | oCavity) |
-
Get Father Cavity.
- Parameters:
-
- oCavity
- The cavity of the father Equipment or ConnectorShell used by the SingleConnector.
- Returns:
- Return code
o ListBackShellCnctPts
| public virtual ListBackShellCnctPts( | | oBackShellCnctPts) |
-
List of BackShellCnctPts.
- Parameters:
-
- oBackShellCnctPts
- The list
- Returns:
- Return code
o ListBackShells
| public virtual ListBackShells( | | opLBackShells) |
-
List the Back Shells assembled to the Single Insert Connector.
- Parameters:
-
- opLBackShells
- The pointer on a list of smart pointers of Back Shells
- Returns:
- Return code
o ListBundleCnctPts
| public virtual ListBundleCnctPts( | | oBundleCnctPts) |
-
List of BundleCnctPts.
- Parameters:
-
- oBundleCnctPts
- The list
- Returns:
- Return code
o ListCavities
| public virtual ListCavities( | | oCavities) |
-
List of Cavities.
- Parameters:
-
- oCavities
- The list
- Returns:
- Return code
o ListConnectorCnctPts
| public virtual ListConnectorCnctPts( | | oConnectorCnctPts) |
-
List of ConnectorCnctPts.
- Parameters:
-
- oConnectorCnctPts
- The list
- Returns:
- Return code
o ListDeviceComposition
| public virtual ListDeviceComposition( | | oDevices) |
-
List Device Composition.
- Parameters:
-
- oDevices
- The list of ElecContact or ElecFillerPlug.
- Returns:
- Return code
o ListMatingConnectors
| public virtual ListMatingConnectors( | | oMatingConnectors) |
-
List Mating Connectors.
- Parameters:
-
- oMatingConnectors
- The list of Mating Connectors.
- Returns:
- Return code
o ListTerminations
| public virtual ListTerminations( | | oTerminations) |
-
List of Terminations.
- Parameters:
-
- oTerminations
- The list
- Returns:
- Return code
This object is included in the file: CATIElbSingleConnector.h
If needed, your Imakefile.mk should include the module: CATElbInterfaces