All Frameworks  Class Hierarchy  This Framework  Next  Indexes

ElecFunctionalItf Interface CATIEfdConnector

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATIEfdConnector
 

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


interface CATIEfdConnector

Interface to manage electrical connectors.
Role: An electrical connector is a functional electrical component with one or more associated contact points, for example, a power or signal transmission connector.


Method Index


o AddContactPoint(wchar_t*,wchar_t*,CATIEfdContactPoint**)
Creates an contact point.
o GetEfdEquipment(CATIEfdEquipment**)
Retrieves the Equipment in which it is contained.
o GetEfdSystem(CATIEfdSystem**)
Retrieves the System in which it is contained.
o ListAssociatedSignals(CATListValCATBaseUnknown_var**)
Lists all the signals connected to a functional connector object.
o ListContactPoints(CATListValCATBaseUnknown_var**)
Lists contact point objects directly referenced within the EfdEquipment.
o Remove(CATIEfdContactPoint**)
Removes a contact point.

Methods


o AddContactPoint
public virtual HRESULT AddContactPoint( const wchar_t* iObjectId,
const wchar_t* iIdNumber,
CATIEfdContactPoint** oContactPoint)=0
Creates an contact point.
Parameters:
iObjectId
the contact point user identifier.
iIdNumber
the contact point identification number.
oContactPoint
the contact point created.
o GetEfdEquipment
public virtual HRESULT GetEfdEquipment(CATIEfdEquipment** oEquipment)=0
Retrieves the Equipment in which it is contained.
Parameters:
oEquipment
the equipment object
o GetEfdSystem
public virtual HRESULT GetEfdSystem(CATIEfdSystem** oSystem)=0
Retrieves the System in which it is contained.
Parameters:
oSystem
the system object
o ListAssociatedSignals
public virtual HRESULT ListAssociatedSignals(CATListValCATBaseUnknown_var** oSignals)=0
Lists all the signals connected to a functional connector object.
Parameters:
oSignals
the list of signal objects
Legal values: NULL if the list is created from scratch, orNOT NULL if you want to append new elements to the list.
o ListContactPoints
public virtual HRESULT ListContactPoints(CATListValCATBaseUnknown_var** oContacts)=0
Lists contact point objects directly referenced within the EfdEquipment.
Parameters:
oContacts
the list of Contact Points objects
Legal values: NULL if the list is created from scratch, orNOT NULL if you want to append new elements to the list.
o Remove
public virtual HRESULT Remove(CATIEfdContactPoint** iContact)=0
Removes a contact point.
Parameters:
iContact
contact point to be removed.

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

Copyright © 2003, Dassault Systèmes. All rights reserved.