Hide Table of Contents
SOLIDWORKS Electrical API 2024.0.0
Electrical API
EwManufacturerPartObjects.idl
Go to the documentation of this file.
1#pragma once
2
3#if (__midl >= 501)
4 midl_pragma warning(disable:2111) /* Disable warning MIDL2111 regarding identifier lengths exceeding 31 chars. */
5#endif
6//
7// import "oaidl.idl";
8// import "ocidl.idl";
9
10import "EwObjectBaseObjects.idl";
11import "EwClassificationObjects.idl";
12
13/************************************************************************/
14/* In his file, all MANUFACTURER PART object */
15/************************************************************************/
16
17/************************************************************************/
18/* ENUMERATION */
19/************************************************************************/
20
21/************************************************************************/
22/* INTERFACES */
23/************************************************************************/
28[
29 object,
30 uuid(DABCB1C7-AC49-4B1A-9460-F0AF4BF05B18),
31 dual,
32 oleautomation,
33 nonextensible,
34 helpstring("IEwManufacturerPartTerminalX Interface"),
35 pointer_default(unique)
36]
37interface IEwManufacturerPartTerminalX : IDispatch
38{
39
40
45 LONG getNumber ();
46
47
53
54
62 BSTR getText (EwErrorCode* errorCode);
63
64
72 EwErrorCode setText (BSTR strText);
73
74
82 BSTR getMnemonic (EwErrorCode* errorCode);
83
84
92 EwErrorCode setMnemonic (BSTR strMnemonic);
93
94
102 DOUBLE getMaxWireSection (EwErrorCode* errorCode);
103
104
113 EwErrorCode setMaxWireSection (DOUBLE dMaxWireSection);
114
115
123 LONG getMaxWireNumber (EwErrorCode* errorCode);
124
125
134 EwErrorCode setMaxWireNumber (LONG lMaxWireNumber);
135
136
144 BSTR getMaxWireGauge (EwErrorCode* errorCode);
145
146
155 EwErrorCode setMaxWireGauge (BSTR strMaxWireGauge);
156
157
167
168
177 EwErrorCode setTerminationTypeCode (BSTR strTerminationTypeCode);
178
179};
180
185[
186 object,
187 uuid(3AA64D24-E0F0-43D4-AC82-B4D5E804ADAB),
188 dual,
189 oleautomation,
190 nonextensible,
191 helpstring("IEwManufacturerPartCircuitX Interface"),
192 pointer_default(unique)
193]
194interface IEwManufacturerPartCircuitX : IDispatch
195{
196
197
206
207
216
217
223
224
234
235
240 LONG getNumber ();
241
242
250 BSTR getGroup (EwErrorCode* errorCode);
251
252
260 EwErrorCode setGroup (BSTR strGroup);
261
262
270 BSTR getChannelGroup (EwErrorCode* errorCode);
271
272
280 EwErrorCode setChannelGroup (BSTR strChannelGroup);
281
282
291
292
300 EwErrorCode setChannelAddress (BSTR strChannelAddress);
301
302
310 BSTR getSymbolName (EwErrorCode* errorCode);
311
312
320 EwErrorCode setSymbolName (BSTR strSymbolName);
321
322
330 LONG getSymbolNumber (EwErrorCode* errorCode);
331
332
340 EwErrorCode setSymbolNumber (LONG lSymbolNumber);
341
342
351
352
361
362
370 BSTR getType (EwErrorCode* errorCode);
371
372
380 EwErrorCode setType (BSTR strType);
381
382};
383
384
389[
390 object,
391 uuid(8961A429-4144-4A41-8C8B-B2414EC74DDD),
392 dual,
393 oleautomation,
394 nonextensible,
395 helpstring("IEwManufacturerPartX Interface"),
396 pointer_default(unique)
397]
399{
410
411
422
423
429
430
442
443
454 BSTR getDescription (BSTR lgCode, EwErrorCode* errorCode);
455
456
467 EwErrorCode setDescription (BSTR lgCode, BSTR strValue);
468
469
480 BSTR getCommercialReference (BSTR lgCode, EwErrorCode* errorCode);
481
482
493 EwErrorCode setCommercialReference (BSTR lgCode, BSTR strValue);
494
495
503 BSTR getReference (EwErrorCode* errorCode);
504
505
515 EwErrorCode setReference (BSTR strReference);
516
517
525 BSTR getManufacturer (EwErrorCode* errorCode);
526
527
537 EwErrorCode setManufacturer (BSTR strManufacturer);
538
539
548 LONG getClassNodeID (EwErrorCode* errorCode);
549
550
561
562
570 BSTR getLibraryCode (EwErrorCode* errorCode);
571
572
581 EwErrorCode setLibraryCode (BSTR strLibraryCode);
582
583
591 BSTR getArticleNumber (EwErrorCode* errorCode);
592
593
602 EwErrorCode setArticleNumber (BSTR strArticleNumber);
603
604
612 BSTR getRootMark (EwErrorCode* errorCode);
613
614
623 EwErrorCode setRootMark (BSTR strRootMark);
624
625
633 BSTR getSerie (EwErrorCode* errorCode);
634
635
643 BSTR getSupplierName (EwErrorCode* errorCode);
644
645
654 EwErrorCode setSupplierName (BSTR strSupplierName);
655
656
664 BSTR getStockNumber (EwErrorCode* errorCode);
665
666
675 EwErrorCode setStockNumber (BSTR strStockNumber);
676
677
686
687
696 EwErrorCode setLineDiagramSymbolName (BSTR strLineDiagramSymbolName);
697
698
707
708
717 EwErrorCode setSchemeSymbolName (BSTR strSchemeSymbolName);
718
719
727 BSTR get3DPartPath (EwErrorCode* errorCode);
728
729
739 EwErrorCode set3DPartPath (BSTR str3DPartPath);
740
741
750
751
760 EwErrorCode set2DFootprintSymbolName (BSTR str2DFootprintSymbolName);
761
762
771
772
781 EwErrorCode set2DConnectionLabelSymbolName (BSTR str2DConnectionLabelSymbolName);
782
783
792 EwErrorCode setWidth (DOUBLE dWidth);
793
794
803 EwErrorCode setHeight (DOUBLE dHeight);
804
805
814 EwErrorCode setDepth (DOUBLE dDepth);
815
816
825 EwErrorCode setUseVoltage (BSTR strUseVoltage);
826
827
836 EwErrorCode setUseFrequency (BSTR strUseFrequency);
837
838
847 EwErrorCode setControlVoltage (BSTR strControlVoltage);
848
849
858 EwErrorCode setControlFrequency (BSTR strControlFrequency);
859
860
871 BSTR getValue (LONG lValueId,EwErrorCode* errorCode);
872
873
884 EwErrorCode setValue (LONG lValueId, BSTR strValue);
885
886
896
897
907
908
917 EwErrorCode setSerie (BSTR strSeries);
918
919
928 DOUBLE getWidth (EwErrorCode * ewErrorCode);
929
930
939 DOUBLE getHeight (EwErrorCode* errorCode);
940
941
950 DOUBLE getDepth (EwErrorCode* errorCode);
951
952
961 BSTR getUseVoltage (EwErrorCode * ewErrorCode);
962
963
972 BSTR getUseFrequency (EwErrorCode * ewErrorCode);
973
974
984
985
994 BSTR getControlFrequency (EwErrorCode * ewErrorCode);
995
996
1005 BSTR getExternalID (EwErrorCode* errorCode);
1006
1007
1017 EwErrorCode setExternalID (BSTR strExternalID);
1018
1019
1030 EwErrorCode setUserData (LONG nUserDataNumber, BSTR strValue);
1031
1032
1043 BSTR getUserData (LONG nUserDataNumber, EwErrorCode* errorCode);
1044
1045
1056
1057
1067 EwErrorCode setExcludeFromBillOfMaterials (VARIANT_BOOL bIsExcludeFromBOM);
1068
1069
1081
1082
1083 // Electrical Assembly function.
1084
1096
1097
1110
1111
1126
1127
1142
1143
1155
1156
1169
1170
1181
1182
1183
1194 EwErrorCode setWeight (DOUBLE dWeight);
1195
1196
1206 DOUBLE getWeight (EwErrorCode* errorCode);
1207
1208
1220 LONG getClassID (EwErrorCode* errorCode);
1221
1222
1234
1235
1248
1249};
1250
1254[
1255 object,
1256 uuid(A35D4915-A636-405E-BEAD-FB0A5954DCCF),
1257 dual,
1258 oleautomation,
1259 nonextensible,
1260 helpstring("IEwManufacturerPartManagerX Interface"),
1261 pointer_default(unique)
1262]
1263interface IEwManufacturerPartManagerX : IDispatch
1264{
1270
1271
1275 LONG getCount ();
1276
1277
1282
1283
1288 IEwManufacturerPartFiltersX newEwManufacturerPartFilters ();
1289
1290
1300 IEwManufacturerPartX findByManufacturerAndReference (BSTR strManufacturer, BSTR strReference , EwErrorCode* errorCode);
1301
1302};
EwErrorCode
All errors codes for this API.
Definition: EnumDefinition.idl:24
EwManufacturerPartType
Manufacturer part type.
Definition: EwEnumeration.idl:667
Use this interface to manage an IEwClassificationX object.
Definition: EwClassificationObjects.idl:228
This interface is a generic interface for environment object methods.
Definition: EwObjectBaseObjects.idl:307
Use this interface to manage a circuit inside a manufacturer part.
Definition: EwManufacturerPartObjects.idl:195
EwErrorCode setGroup(BSTR strGroup)
Set a group of this circuit.
IEwManufacturerPartTerminalX getEwManufacturerPartTerminalAt(LONG index, EwErrorCode *errorCode)
Get terminal inside this circuit.
EwErrorCode setType(BSTR strType)
Set a type of this circuit.
LONG getSymbolCircuitNumber(EwErrorCode *errorCode)
Get the circuit number associated to this object inside the associated symbol.
LONG getEwManufacturerPartTerminalCount()
Count the number of terminals in this circuits.
BSTR getChannelGroup(EwErrorCode *errorCode)
Get a channel group of this circuit.
BSTR getGroup(EwErrorCode *errorCode)
Get a group of this circuit.
EwErrorCode setChannelGroup(BSTR strChannelGroup)
Set a channel group of this circuit.
BSTR getChannelAddress(EwErrorCode *errorCode)
Get a channel address of this circuit.
LONG getNumber()
Get number of this circuit.
EwErrorCode setSymbolName(BSTR strSymbolName)
Set a symbol name of this circuit.
EwErrorCode setSymbolNumber(LONG lSymbolNumber)
Set a symbol number of this circuit.
EwErrorCode deleteEwManufacturerPartTerminalAt(LONG index)
Delete a terminal from this circuit.
BSTR getType(EwErrorCode *errorCode)
Get a type of this circuit.
EwErrorCode setChannelAddress(BSTR strChannelAddress)
Set a channel address of this circuit.
BSTR getSymbolName(EwErrorCode *errorCode)
Get a symbol name of this circuit.
EwErrorCode setSymbolCircuitNumber(LONG lSyCircuitNo)
Set the circuit number associated to this object inside the associated symbol.
IEwManufacturerPartTerminalX addEwManufacturerPartTerminal(EwErrorCode *errorCode)
Create and add a terminal inside this circuit.
LONG getSymbolNumber(EwErrorCode *errorCode)
Get a symbol number of this circuit.
Use this interface to manage IEwManufacturerPartX objects.
Definition: EwManufacturerPartObjects.idl:1264
VARIANT getEwManufacturerPartArray(EwErrorCode *errorCode)
return the array of IEwManufacturerPartX of associated environment
IEwManufacturerPartX newEwManufacturerPart()
Create a IEwManufacturerPartX object from the associated environnement.
IEwManufacturerPartFiltersX newEwManufacturerPartFilters()
Create an IEwManufacturerPartFiltersX interface to filter on manufacturer parts (IEwManufacturerPartX...
IEwManufacturerPartX findByManufacturerAndReference(BSTR strManufacturer, BSTR strReference, EwErrorCode *errorCode)
return a Manufacturer part according to the manufacturer name and the reference
Use this interface to manage a terminal inside a manufacturer part.
Definition: EwManufacturerPartObjects.idl:38
EwErrorCode setText(BSTR strText)
Set a text of this terminal.
EwErrorCode setMnemonic(BSTR strMnemonic)
Set a mnemonic of this terminal.
BSTR getText(EwErrorCode *errorCode)
Get a text of this terminal.
LONG getMaxWireNumber(EwErrorCode *errorCode)
Get a max wire number of this terminal.
LONG getEwManufacturerPartCircuitNumber()
Get the circuit number where this terminal is present.
EwErrorCode setMaxWireGauge(BSTR strMaxWireGauge)
Set a max wire gauge of this terminal.
BSTR getMnemonic(EwErrorCode *errorCode)
Get a mnemonic of this terminal.
EwErrorCode setTerminationTypeCode(BSTR strTerminationTypeCode)
Set the termination type code of this terminal.
DOUBLE getMaxWireSection(EwErrorCode *errorCode)
Get a max wire section of this terminal.
BSTR getMaxWireGauge(EwErrorCode *errorCode)
Get a max wire gauge of this terminal.
BSTR getTerminationTypeCode(EwErrorCode *errorCode)
Get the termination type code of this terminal.
EwErrorCode setMaxWireSection(DOUBLE dMaxWireSection)
Set a max wire section of this terminal.
LONG getNumber()
Get the number of this terminal.
EwErrorCode setMaxWireNumber(LONG lMaxWireNumber)
Set a max wire number of this terminal.
Use this interface to manage a manufacturer part.
Definition: EwManufacturerPartObjects.idl:399
EwErrorCode setControlVoltage(BSTR strControlVoltage)
Set the control voltage of this manufacturer part.
EwErrorCode setArticleNumber(BSTR strArticleNumber)
Set the article number of this manufacturer part.
EwErrorCode setStockNumber(BSTR strStockNumber)
Set the stock number of this manufacturer part.
VARIANT_BOOL getExcludeFromBillOfMaterials(EwErrorCode *errorCode)
Check if current manufacturer part is to exclude from bill of materials.
BSTR get3DPartPath(EwErrorCode *errorCode)
Get the 3D part associated with this manufacturer part.
VARIANT getManufacturerPartArray(EwErrorCode *errorCode)
Return array of manufacturer parts from a Electrical Assembly.
IEwManufacturerPartX duplicate(EwErrorCode *errorCode)
Duplicate current manufacturer part.
EwErrorCode setReference(BSTR strReference)
Set the reference of this manufacturer part.
BSTR getReference(EwErrorCode *errorCode)
Get the reference of this manufacturer part.
BSTR get2DFootprintSymbolName(EwErrorCode *errorCode)
Get the 2D Footprint Symbol Name.
EwErrorCode setClassNodeID(LONG lNodeId)
BSTR getStockNumber(EwErrorCode *errorCode)
Get the stock number of this manufacturer part.
EwErrorCode set2DFootprintSymbolName(BSTR str2DFootprintSymbolName)
Set the 2D Footprint Symbol Name.
int getEwManufacturerPartCount(EwErrorCode *errorCode)
Return the number of manufacturer parts from the current Electrical Assembly.
BSTR getSchemeSymbolName(EwErrorCode *errorCode)
Get the scheme symbol name.
DOUBLE getWidth(EwErrorCode *ewErrorCode)
Get the width in millimeters of this manufacturer part.
BSTR getLineDiagramSymbolName(EwErrorCode *errorCode)
Get the line diagram symbol name.
BSTR get2DConnectionLabelSymbolName(EwErrorCode *errorCode)
Get the 2D Connection label Symbol Name.
BSTR getCommercialReference(BSTR lgCode, EwErrorCode *errorCode)
Get a commercial reference of this manufacturer part.
EwErrorCode setExternalID(BSTR strExternalID)
Set the external identifier of this manufacturer part.
BSTR getUseVoltage(EwErrorCode *ewErrorCode)
Get the UseVoltage of this manufacturer part.
EwErrorCode deleteEwManufacturerPartCircuitAt(LONG index)
Delete a circuit from this manufacturer part.
IEwClassificationX getClassification(EwErrorCode *errorCode)
Get the classification of the current manufacturer part.
EwManufacturerPartType getEwManufacturerPartType(EwErrorCode *errorCode)
Get the base type of this manufacturer part.
EwErrorCode deleteAllEwManufacturerPart()
Remove all manufacturer parts from the current Electrical Assembly.
EwErrorCode setCommercialReference(BSTR lgCode, BSTR strValue)
Set a commercial reference of this manufacturer part.
BSTR getSupplierName(EwErrorCode *errorCode)
Get the supplier name of this manufacturer part.
EwErrorCode setWidth(DOUBLE dWidth)
Set the width in millimeters of this manufacturer part.
LONG getClassID(EwErrorCode *errorCode)
Get the class ID of manufacturer part.
IEwManufacturerPartCircuitX addEwManufacturerPartCircuit(BSTR strCircuitCode, EwErrorCode *errorCode)
Create and add a circuit for this manufacturer part.
BSTR getRootMark(EwErrorCode *errorCode)
Get the root mark of this manufacturer part.
BSTR getUseFrequency(EwErrorCode *ewErrorCode)
Get the UseFrequency of this manufacturer part.
EwErrorCode setValue(LONG lValueId, BSTR strValue)
Set manufacturer value according to part classification.
IEwManufacturerPartCircuitX getEwManufacturerPartCircuitAt(LONG index, EwErrorCode *errorCode)
Get an object inside this manufacturer part.
EwErrorCode setClassID(LONG lID)
Set the class ID of this manufacturer part.
DOUBLE getWeight(EwErrorCode *errorCode)
Get the weight in grams of this manufacturer part.
EwErrorCode setHeight(DOUBLE dHeight)
Set the height in millimeters of this manufacturer part.
EwErrorCode setRootMark(BSTR strRootMark)
Set the root mark of this manufacturer part.
BSTR getValue(LONG lValueId, EwErrorCode *errorCode)
Get manufacturer value according to part classification.
EwErrorCode setWeight(DOUBLE dWeight)
Set the weight of this manufacturer part.
EwErrorCode setSerie(BSTR strSeries)
Set the series of this manufacturer part.
EwErrorCode setUseFrequency(BSTR strUseFrequency)
Set the use frequency of this manufacturer part.
BSTR getDescription(BSTR lgCode, EwErrorCode *errorCode)
Get a description of this manufacturer parts.
BSTR getControlVoltage(EwErrorCode *errorCode)
Get the ControlVoltage of this manufacturer part.
BSTR getUserData(LONG nUserDataNumber, EwErrorCode *errorCode)
Get user data of the object.
EwErrorCode setManufacturer(BSTR strManufacturer)
Set the manufacturer of this manufacturer part.
EwErrorCode setUserData(LONG nUserDataNumber, BSTR strValue)
Set user data of the object.
EwErrorCode set2DConnectionLabelSymbolName(BSTR str2DConnectionLabelSymbolName)
Set the 2D Connection label Symbol Name.
BSTR getSerie(EwErrorCode *errorCode)
Get the series of this manufacturer part.
EwErrorCode set3DPartPath(BSTR str3DPartPath)
Set the 3D part associated with this manufacturer part.
BSTR getArticleNumber(EwErrorCode *errorCode)
Get the article number of this manufacturer part.
BSTR getLibraryCode(EwErrorCode *errorCode)
Get the library code of this manufacturer part.
EwErrorCode addEwManufacturerPartAt(int iIndex, IEwManufacturerPartX *iManufacturerPartX)
Add a new manufacturer parts from the current Electrical Assembly at the specified position.
DOUBLE getDepth(EwErrorCode *errorCode)
Get the Depth in millimeters of this manufacturer part.
EwErrorCode setEwManufacturerPartType(EwManufacturerPartType eManufacturerPartType)
Set the base type of this manufacturer part.
BSTR getExternalID(EwErrorCode *errorCode)
Get external identifier of this manufacturer part.
EwErrorCode addEwManufacturerPart(IEwManufacturerPartX *iManufacturerPartX)
Add a new manufacturer parts from the current Electrical Assembly.
LONG getClassNodeID(EwErrorCode *errorCode)
BSTR getControlFrequency(EwErrorCode *ewErrorCode)
Get the ControlFrequency of this manufacturer part.
EwErrorCode setSupplierName(BSTR strSupplierName)
Set the supplier name of this manufacturer part.
EwErrorCode setDepth(DOUBLE dDepth)
Set the depth in millimeters of this manufacturer part.
LONG getEwManufacturerPartCircuitCount()
Count the number of circuit in this manufacturer part.
EwErrorCode setSchemeSymbolName(BSTR strSchemeSymbolName)
Set the scheme symbol name.
DOUBLE getHeight(EwErrorCode *errorCode)
Get the Height in millimeters of this manufacturer part.
IEwManufacturerPartX getEwManufacturerPartAt(int iIndex, EwErrorCode *errorCode)
Return the specified manufacturer parts from the current Electrical Assembly.
EwErrorCode setLineDiagramSymbolName(BSTR strLineDiagramSymbolName)
Set the line diagram symbol name.
BSTR getManufacturer(EwErrorCode *errorCode)
Get the manufacturer of this manufacturer part.
EwErrorCode setControlFrequency(BSTR strControlFrequency)
Set the control frequency of this manufacturer part.
EwErrorCode deleteEwManufacturerPartAt(int iIndex)
Remove a manufacturer parts specified by the index from the current Electrical Assembly.
EwErrorCode setLibraryCode(BSTR strLibraryCode)
Set the library code of this manufacturer part.
EwErrorCode setUseVoltage(BSTR strUseVoltage)
Set the use voltage of this manufacturer part.
EwErrorCode setExcludeFromBillOfMaterials(VARIANT_BOOL bIsExcludeFromBOM)
Set if current manufacturer part is to exclude from bill of materials.
EwErrorCode setDescription(BSTR lgCode, BSTR strValue)
Set a description of this manufacturer part.


Provide feedback on this topic

SOLIDWORKS welcomes your feedback concerning the presentation, accuracy, and thoroughness of the documentation. Use the form below to send your comments and suggestions about this topic directly to our documentation team. The documentation team cannot answer technical support questions. Click here for information about technical support.

* Required

 
*Email:  
Subject:   Feedback on Help Topics
Page:   SOLIDWORKS Electrical API: idl_converted/EwManufacturerPartObjects.idl Source File
*Comment:  
*   I acknowledge I have read and I hereby accept the privacy policy under which my Personal Data will be used by Dassault Systèmes

Print Topic

Select the scope of content to print:

x

We have detected you are using a browser version older than Internet Explorer 7. For optimized display, we suggest upgrading your browser to Internet Explorer 7 or newer.

 Never show this message again
x

Web Help Content Version: API Help (English only) 2024 SP05

To disable Web help from within SOLIDWORKS and use local help instead, click Help > Use SOLIDWORKS Web Help.

To report problems encountered with the Web help interface and search, contact your local support representative. To provide feedback on individual help topics, use the “Feedback on this topic” link on the individual topic page.