All Frameworks  Object Hierarchy  This Framework  Indexes   

EHMInsertionActPlugMapViewData (Object)

Interface to access Plug Map view data associated to an Insertion activity.

Role: Component that implement DNBIAEHMInsertionActPlugMapViewData is DNBEHMModel.

When using DNBIAEHMInsertionActPlugMapViewData interface in C++, query from interface DNBIEHMInsertionActivity.
When using from VB Script, use GetTechnologicalObject to get handle to interface.

PlugMap Data consists of 2 parts namely Connector data & inserted wires data.
To get data about inserted wires, first get the number of wires using method
get_NumInsertedWires, then set index of wire using put_WireID and then access information about that wire.
Please note that default returned string for all PROPERTY of type CATBSTR is "UnSet".

Sample Code in VB Script is as given below
'---- InsertionAct is activity for Plug Map view data.
Dim InsertionAct As Activity
Set InsertionAct = get activity DNBEHMInsertionAct.1
Set PlugMapData = InsertionAct.GetTechnologicalObject( "EHMInsertionActPlugMapViewData" )
Dim ConnectorName As String
ConnectorName = PlugMapData.ConnectorName
Dim NumInsertedWires, ii As Integer
NumInsertedWires = PlugMapData.NumInsertedWires
Dim TerminationName, WireName, ContactName As String
For ii = 1 to NumInsertedWires
PlugMapData.WireID = ii
TerminationName = PlugMapData.TerminationName
WireName = PlugMapData.WireName
Next


Property Index

ConnectorName
Gets ConnectorName.
ConnectorPartNumber
Gets Connector Part Number.
ConnectorRefDesignator
Gets Connector Reference Designator.
ConnectorSubType
Gets Connector Sub Type.
ConnectorType
Gets Connector Type.
ContactElecBarrelDiameter
Gets Contact Elec Barrel Diameter.
ContactName
Gets Contact Name.
ContactPartNumber
Gets Contact Part Number.
ContactRefDesignator
Gets Contact Reference Designator.
ContactSubType
Gets Contact Sub Type.
ContactType
Gets Contact Type.
NumInsertedWires
Gets the number of inserted wires.
TerminationIDNumber
Gets Termination ID Number.
TerminationName
Gets Termination Name.
TerminationNumber
Gets Termination Number.
TerminationRefDesignator
Gets Termination Reference Designator.
TerminationSubType
Gets Termination Sub Type.
TerminationType
Gets Termination Type.
WireColor
Gets Wire Color.
WireDiameter
Gets Wire Diameter.
WireID
Sets the index of wire.
WireLength
Gets Wire Length.
WireName
Gets Wire Name.
WirePartNumber
Gets Wire Part Number.
WireRefDesignator
Gets Wire Reference Designator.
WireSeparationCode
Gets Wire Separation Code.
WireSignalID
Gets Wire Signal ID.
WireSubType
Gets Wire Sub Type.
WireType
Gets Wire Type.

Properties


o Property ConnectorName() As (Read Only)
Gets ConnectorName.
Parameters:
oConnectorName
the Connector Name.
Returns:
An HRESULT
Legal values:
  • S_OK if the Property is returned successfully.
  • E_FAIL otherwise
  • .
o Property ConnectorPartNumber() As (Read Only)
Gets Connector Part Number.
Parameters:
oConnectorPartNumber
the Connector Part Number.
Returns:
An HRESULT
Legal values:
  • S_OK if the Property is returned successfully.
  • E_FAIL otherwise
  • .
o Property ConnectorRefDesignator() As (Read Only)
Gets Connector Reference Designator.
Parameters:
oConnectorRefDesignator
the Connector Reference Designator.
Returns:
An HRESULT
Legal values:
  • S_OK if the Property is returned successfully.
  • E_FAIL otherwise
  • .
o Property ConnectorSubType() As (Read Only)
Gets Connector Sub Type.
Parameters:
oConnectorSubType
the Connector Sub Type.
Returns:
An HRESULT
Legal values:
  • S_OK if the Property is returned successfully.
  • E_FAIL otherwise
  • .
o Property ConnectorType() As (Read Only)
Gets Connector Type.
Parameters:
oConnectorType
the Connector Type.
Returns:
An HRESULT
Legal values:
  • S_OK if the Property is returned successfully.
  • E_FAIL otherwise
  • .
o Property ContactElecBarrelDiameter() As (Read Only)
Gets Contact Elec Barrel Diameter.
Parameters:
oContactElecBarrelDiameter
the Contact Elec Barrel Diameter.
Returns:
An HRESULT
Legal values:
  • S_OK if the Property is returned successfully.
  • E_FAIL otherwise
  • .
o Property ContactName() As (Read Only)
Gets Contact Name.
Parameters:
oContactName
the Contact Name.
Returns:
An HRESULT
Legal values:
  • S_OK if the Property is returned successfully.
  • E_FAIL otherwise
  • .
o Property ContactPartNumber() As (Read Only)
Gets Contact Part Number.
Parameters:
oContactPartNumber
the Contact Part Number.
Returns:
An HRESULT
Legal values:
  • S_OK if the Property is returned successfully.
  • E_FAIL otherwise
  • .
o Property ContactRefDesignator() As (Read Only)
Gets Contact Reference Designator.
Parameters:
oContactRefDesignator
the Contact Ref Designator.
Returns:
An HRESULT
Legal values:
  • S_OK if the Property is returned successfully.
  • E_FAIL otherwise
  • .
o Property ContactSubType() As (Read Only)
Gets Contact Sub Type.
Parameters:
oContactSubType
the Contact Sub Type.
Returns:
An HRESULT
Legal values:
  • S_OK if the Property is returned successfully.
  • E_FAIL otherwise
  • .
o Property ContactType() As (Read Only)
Gets Contact Type.
Parameters:
oContactType
the Contact Type.
Returns:
An HRESULT
Legal values:
  • S_OK if the Property is returned successfully.
  • E_FAIL otherwise
  • .
o Property NumInsertedWires() As (Read Only)
Gets the number of inserted wires.
Parameters:
NumInsertedWires
the number of inserted wires.
Returns:
An HRESULT
Legal values:
  • S_OK if the wire ID is set successfully.
  • E_FAIL otherwise
  • .
o Property TerminationIDNumber() As (Read Only)
Gets Termination ID Number.
Parameters:
oTerminationIDNumber.
the Termination ID Number
Returns:
An HRESULT
Legal values:
  • S_OK if the Property is returned successfully.
  • E_FAIL otherwise
  • .
o Property TerminationName() As (Read Only)
Gets Termination Name.
Parameters:
oTerminationName
the Termination Name.
Returns:
An HRESULT
Legal values:
  • S_OK if the Property is returned successfully.
  • E_FAIL otherwise
  • .
o Property TerminationNumber() As (Read Only)
Gets Termination Number.
Parameters:
oTerminationNumber
the Termination Number.
Returns:
An HRESULT
Legal values:
  • S_OK if the Property is returned successfully.
  • E_FAIL otherwise
  • .
o Property TerminationRefDesignator() As (Read Only)
Gets Termination Reference Designator.
Parameters:
oTerminationRefDesignator
the Termination Ref Designator.
Returns:
An HRESULT
Legal values:
  • S_OK if the Property is returned successfully.
  • E_FAIL otherwise
  • .
o Property TerminationSubType() As (Read Only)
Gets Termination Sub Type.
Parameters:
oTerminationSubType
the Termination Sub Type.
Returns:
An HRESULT
Legal values:
  • S_OK if the Property is returned successfully.
  • E_FAIL otherwise
  • .
o Property TerminationType() As (Read Only)
Gets Termination Type.
Parameters:
oTerminationType
the Termination Type.
Returns:
An HRESULT
Legal values:
  • S_OK if the Property is returned successfully.
  • E_FAIL otherwise
  • .
o Property WireColor() As (Read Only)
Gets Wire Color.
Parameters:
oWireColor
the Wire Color.
Returns:
An HRESULT
Legal values:
  • S_OK if the Property is returned successfully.
  • E_FAIL otherwise
  • .
o Property WireDiameter() As (Read Only)
Gets Wire Diameter.
Parameters:
oWireDiameter
the Wire Diameter.
Returns:
An HRESULT
Legal values:
  • S_OK if the Property is returned successfully.
  • E_FAIL otherwise
  • .
o Property WireID( iWireID) (Write Only)
Sets the index of wire.
Parameters:
iWireID
Index of wire between 1 & NumInsertedWires associated to an Insertion Activity.
Returns:
An HRESULT
Legal values:
  • S_OK if the wire ID is set successfully.
  • E_FAIL otherwise
  • .
o Property WireLength() As (Read Only)
Gets Wire Length.
Parameters:
oWireLength
the Wire Length.
Returns:
An HRESULT
Legal values:
  • S_OK if the Property is returned successfully.
  • E_FAIL otherwise
  • .
o Property WireName() As (Read Only)
Gets Wire Name.
Parameters:
oWireName
the Wire Name.
Returns:
An HRESULT
Legal values:
  • S_OK if the Property is returned successfully.
  • E_FAIL otherwise
  • .
o Property WirePartNumber() As (Read Only)
Gets Wire Part Number.
Parameters:
oWirePartNumber
the Wire Part Number.
Returns:
An HRESULT
Legal values:
  • S_OK if the Property is returned successfully.
  • E_FAIL otherwise
  • .
o Property WireRefDesignator() As (Read Only)
Gets Wire Reference Designator.
Parameters:
oWireRefDesignator
the Wire Ref Designator.
Returns:
An HRESULT
Legal values:
  • S_OK if the Property is returned successfully.
  • E_FAIL otherwise
  • .
o Property WireSeparationCode() As (Read Only)
Gets Wire Separation Code.
Parameters:
oWireSeparationCode
the Wire Separation Code.
Returns:
An HRESULT
Legal values:
  • S_OK if the Property is returned successfully.
  • E_FAIL otherwise
  • .
o Property WireSignalID() As (Read Only)
Gets Wire Signal ID.
Parameters:
oWireSignalID
the Wire Signal ID.
Returns:
An HRESULT
Legal values:
  • S_OK if the Property is returned successfully.
  • E_FAIL otherwise
  • .
o Property WireSubType() As (Read Only)
Gets Wire Sub Type.
Parameters:
oWireSubType
the Wire Sub Type.
Returns:
An HRESULT
Legal values:
  • S_OK if the Property is returned successfully.
  • E_FAIL otherwise
  • .
o Property WireType() As (Read Only)
Gets Wire Type.
Parameters:
oWireType
the Wire Type.
Returns:
An HRESULT
Legal values:
  • S_OK if the Property is returned successfully.
  • E_FAIL otherwise
  • .

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