Hide Table of Contents
SOLIDWORKS Electrical API  2022.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 
10 import "EwObjectBase.idl";
11 import "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 ]
37 interface 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 ]
194 interface 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 
290  BSTR getChannelAddress (EwErrorCode* errorCode);
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 
360  EwErrorCode setSymbolCircuitNumber (LONG lSyCircuitNo);
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 
514  EwErrorCode setReference (BSTR strReference);
515 
516 
524  BSTR getManufacturer (EwErrorCode* errorCode);
525 
526 
535  EwErrorCode setManufacturer (BSTR strManufacturer);
536 
537 
545  LONG getClassNodeID (EwErrorCode* errorCode);
546 
547 
556  EwErrorCode setClassNodeID (LONG lNodeId);
557 
558 
566  BSTR getLibraryCode (EwErrorCode* errorCode);
567 
568 
577  EwErrorCode setLibraryCode (BSTR strLibraryCode);
578 
579 
587  BSTR getArticleNumber (EwErrorCode* errorCode);
588 
589 
598  EwErrorCode setArticleNumber (BSTR strArticleNumber);
599 
600 
608  BSTR getRootMark (EwErrorCode* errorCode);
609 
610 
619  EwErrorCode setRootMark (BSTR strRootMark);
620 
621 
629  BSTR getSerie (EwErrorCode* errorCode);
630 
631 
639  BSTR getSupplierName (EwErrorCode* errorCode);
640 
641 
650  EwErrorCode setSupplierName (BSTR strSupplierName);
651 
652 
660  BSTR getStockNumber (EwErrorCode* errorCode);
661 
662 
671  EwErrorCode setStockNumber (BSTR strStockNumber);
672 
673 
682 
683 
692  EwErrorCode setLineDiagramSymbolName (BSTR strLineDiagramSymbolName);
693 
694 
702  BSTR getSchemeSymbolName (EwErrorCode* errorCode);
703 
704 
713  EwErrorCode setSchemeSymbolName (BSTR strSchemeSymbolName);
714 
715 
723  BSTR get3DPartPath (EwErrorCode* errorCode);
724 
725 
735  EwErrorCode set3DPartPath (BSTR str3DPartPath);
736 
737 
746 
747 
756  EwErrorCode set2DFootprintSymbolName (BSTR str2DFootprintSymbolName);
757 
758 
767 
768 
777  EwErrorCode set2DConnectionLabelSymbolName (BSTR str2DConnectionLabelSymbolName);
778 
779 
788  EwErrorCode setWidth (DOUBLE dWidth);
789 
790 
799  EwErrorCode setHeight (DOUBLE dHeight);
800 
801 
810  EwErrorCode setDepth (DOUBLE dDepth);
811 
812 
821  EwErrorCode setUseVoltage (BSTR strUseVoltage);
822 
823 
832  EwErrorCode setUseFrequency (BSTR strUseFrequency);
833 
834 
843  EwErrorCode setControlVoltage (BSTR strControlVoltage);
844 
845 
854  EwErrorCode setControlFrequency (BSTR strControlFrequency);
855 
856 
867  BSTR getValue (LONG lValueId,EwErrorCode* errorCode);
868 
869 
880  EwErrorCode setValue (LONG lValueId, BSTR strValue);
881 
882 
892 
893 
903 
904 
913  EwErrorCode setSerie (BSTR strSeries);
914 
915 
924  DOUBLE getWidth (EwErrorCode * ewErrorCode);
925 
926 
935  DOUBLE getHeight (EwErrorCode* errorCode);
936 
937 
946  DOUBLE getDepth (EwErrorCode* errorCode);
947 
948 
957  BSTR getUseVoltage (EwErrorCode * ewErrorCode);
958 
959 
968  BSTR getUseFrequency (EwErrorCode * ewErrorCode);
969 
970 
979  BSTR getControlVoltage (EwErrorCode* errorCode);
980 
981 
990  BSTR getControlFrequency (EwErrorCode * ewErrorCode);
991 
992 
1001  BSTR getExternalID (EwErrorCode* errorCode);
1002 
1003 
1013  EwErrorCode setExternalID (BSTR strExternalID);
1014 
1015 
1026  EwErrorCode setUserData (LONG nUserDataNumber, BSTR strValue);
1027 
1028 
1039  BSTR getUserData (LONG nUserDataNumber, EwErrorCode* errorCode);
1040 
1041 
1051  VARIANT_BOOL getExcludeFromBillOfMaterials (EwErrorCode* errorCode);
1052 
1053 
1063  EwErrorCode setExcludeFromBillOfMaterials (VARIANT_BOOL bIsExcludeFromBOM);
1064 
1065 
1076  IEwClassificationX getClassification (EwErrorCode* errorCode);
1077 
1078 
1079 
1080  // Electrical Assembly function.
1081 
1093 
1094 
1107 
1108 
1122  EwErrorCode addEwManufacturerPartAt (int iIndex, IEwManufacturerPartX * iManufacturerPartX);
1123 
1124 
1125 
1139 
1140 
1152 
1153 
1166 
1167 
1178 
1179 };
1180 
1184 [
1185  object,
1186  uuid(A35D4915-A636-405E-BEAD-FB0A5954DCCF),
1187  dual,
1188  oleautomation,
1189  nonextensible,
1190  helpstring("IEwManufacturerPartManagerX Interface"),
1191  pointer_default(unique)
1192 ]
1193 interface IEwManufacturerPartManagerX : IDispatch
1194 {
1200 
1201 
1205  LONG getCount ();
1206 
1207 
1212 
1213 
1218  IEwManufacturerPartFiltersX newEwManufacturerPartFilters ();
1219 
1220 
1230  IEwManufacturerPartX findByManufacturerAndReference (BSTR strManufacturer, BSTR strReference , EwErrorCode* errorCode);
1231 
1232 };
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.
BSTR getSerie(EwErrorCode *errorCode)
Get the series of this manufacturer part.
BSTR getUseFrequency(EwErrorCode *ewErrorCode)
Get the UseFrequency of this manufacturer part.
int getEwManufacturerPartCount(EwErrorCode *errorCode)
Return the number of manufacturer parts from the current Electrical Assembly.
EwErrorCode setChannelGroup(BSTR strChannelGroup)
Set a channel group of this circuit.
EwErrorCode setArticleNumber(BSTR strArticleNumber)
Set the article number of this manufacturer part.
EwErrorCode setStockNumber(BSTR strStockNumber)
Set the stock number of this manufacturer part.
DOUBLE getWidth(EwErrorCode *ewErrorCode)
Get the width of this manufacturer part.
BSTR getExternalID(EwErrorCode *errorCode)
Get external identifier of this manufacturer part.
LONG getNumber()
Get the number of this terminal.
EwErrorCode setControlFrequency(BSTR strControlFrequency)
Set the control frequency of this manufacturer part.
BSTR getStockNumber(EwErrorCode *errorCode)
Get the stock number of this manufacturer part.
IEwManufacturerPartX newEwManufacturerPart()
Create a IEwManufacturerPartX object from the associated environnement.
IEwManufacturerPartTerminalX addEwManufacturerPartTerminal(EwErrorCode *errorCode)
Create and add a terminal inside this circuit.
IEwManufacturerPartX findByManufacturerAndReference(BSTR strManufacturer, BSTR strReference, EwErrorCode *errorCode)
return a Manufacturer part according to the manufacturer name and the reference
LONG getEwManufacturerPartCircuitCount()
Count the number of circuit in this manufacturer part.
LONG getSymbolNumber(EwErrorCode *errorCode)
Get a symbol number of this circuit.
EwErrorCode set2DConnectionLabelSymbolName(BSTR str2DConnectionLabelSymbolName)
Set the 2D Connection label Symbol Name.
EwErrorCode setRootMark(BSTR strRootMark)
Set the root mark of this manufacturer part.
Use this interface to manage a manufacturer part.
Definition: EwManufacturerPartObjects.idl:399
BSTR getLibraryCode(EwErrorCode *errorCode)
Get the library code of this manufacturer part.
BSTR getCommercialReference(BSTR lgCode, EwErrorCode *errorCode)
Get a commercial reference of this manufacturer part.
EwErrorCode setSymbolNumber(LONG lSymbolNumber)
Set a symbol number of this circuit.
EwErrorCode setUserData(LONG nUserDataNumber, BSTR strValue)
Set user data of the object.
EwErrorCode setExcludeFromBillOfMaterials(VARIANT_BOOL bIsExcludeFromBOM)
Set if current manufacturer part is to exclude from bill of materials.
EwErrorCode
All errors codes for this API.
Definition: EnumDefinition.idl:21
BSTR getDescription(BSTR lgCode, EwErrorCode *errorCode)
Get a description of this manufacturer parts.
EwErrorCode setUseFrequency(BSTR strUseFrequency)
Set the use frequency of this manufacturer part.
BSTR getText(EwErrorCode *errorCode)
Get a text of this terminal.
EwErrorCode setText(BSTR strText)
Set a text of this terminal.
BSTR getUseVoltage(EwErrorCode *ewErrorCode)
Get the UseVoltage of this manufacturer part.
BSTR getValue(LONG lValueId, EwErrorCode *errorCode)
Get manufacturer value according to part classification.
LONG getNumber()
Get number of this circuit.
EwErrorCode set3DPartPath(BSTR str3DPartPath)
Set the 3D part associated with this manufacturer part.
BSTR getReference(EwErrorCode *errorCode)
Get the reference of this manufacturer part.
EwErrorCode setSchemeSymbolName(BSTR strSchemeSymbolName)
Set the scheme symbol name.
EwManufacturerPartType
Manufacturer part type.
Definition: EwEnumeration.idl:638
EwErrorCode setTerminationTypeCode(BSTR strTerminationTypeCode)
Set the termination type code of this terminal.
BSTR getMaxWireGauge(EwErrorCode *errorCode)
Get a max wire gauge of this terminal.
DOUBLE getDepth(EwErrorCode *errorCode)
Get the Depth of this manufacturer part.
This interface is a generic interface for environment object methods.
Definition: EwObjectBase.idl:278
BSTR getChannelGroup(EwErrorCode *errorCode)
Get a channel group of this circuit.
LONG getClassNodeID(EwErrorCode *errorCode)
Get the classification node ID of this manufacturer part.
EwErrorCode setValue(LONG lValueId, BSTR strValue)
Set manufacturer value according to part classification.
Use this interface to manage a circuit inside a manufacturer part.
Definition: EwManufacturerPartObjects.idl:195
EwErrorCode setManufacturer(BSTR strManufacturer)
Set the manufacturer of this manufacturer part.
BSTR getSchemeSymbolName(EwErrorCode *errorCode)
Get the scheme symbol name.
LONG getSymbolCircuitNumber(EwErrorCode *errorCode)
Get the circuit number associated to this object inside the associated symbol.
LONG getMaxWireNumber(EwErrorCode *errorCode)
Get a max wire number of this terminal.
EwErrorCode setReference(BSTR strReference)
Set the reference of this manufacturer part.
EwManufacturerPartType getEwManufacturerPartType(EwErrorCode *errorCode)
Get the base type of this manufacturer part.
BSTR getRootMark(EwErrorCode *errorCode)
Get the root mark of this manufacturer part.
BSTR getGroup(EwErrorCode *errorCode)
Get a group of this circuit.
EwErrorCode setType(BSTR strType)
Set a type of this circuit.
DOUBLE getHeight(EwErrorCode *errorCode)
Get the Height of this manufacturer part.
BSTR getSupplierName(EwErrorCode *errorCode)
Get the supplier name of this manufacturer part.
BSTR getType(EwErrorCode *errorCode)
Get a type of this circuit.
BSTR get2DConnectionLabelSymbolName(EwErrorCode *errorCode)
Get the 2D Connection label Symbol Name.
EwErrorCode setMaxWireGauge(BSTR strMaxWireGauge)
Set a max wire gauge of this terminal.
LONG getEwManufacturerPartCircuitNumber()
Get the circuit number where this terminal is present.
EwErrorCode setControlVoltage(BSTR strControlVoltage)
Set the control voltage of this manufacturer part.
EwErrorCode setLineDiagramSymbolName(BSTR strLineDiagramSymbolName)
Set the line diagram symbol name.
Use this interface to manage IEwManufacturerPartX objects.
Definition: EwManufacturerPartObjects.idl:1194
BSTR getControlVoltage(EwErrorCode *errorCode)
Get the ControlVoltage of this manufacturer part.
VARIANT_BOOL getExcludeFromBillOfMaterials(EwErrorCode *errorCode)
Check if current manufacturer part is to exclude from bill of materials.
IEwManufacturerPartFiltersX newEwManufacturerPartFilters()
Create an IEwManufacturerPartFiltersX interface to filter on manufacturer parts (IEwManufacturerPartX...
BSTR getMnemonic(EwErrorCode *errorCode)
Get a mnemonic of this terminal.
EwErrorCode setSupplierName(BSTR strSupplierName)
Set the supplier name of this manufacturer part.
EwErrorCode setHeight(DOUBLE dHeight)
Set the height of this manufacturer part.
IEwManufacturerPartCircuitX getEwManufacturerPartCircuitAt(LONG index, EwErrorCode *errorCode)
Get an object inside this manufacturer part.
IEwClassificationX getClassification(EwErrorCode *errorCode)
Get the classification of the current manufacturer part.
EwErrorCode setDescription(BSTR lgCode, BSTR strValue)
Set a description of this manufacturer part.
DOUBLE getMaxWireSection(EwErrorCode *errorCode)
Get a max wire section of this terminal.
BSTR getTerminationTypeCode(EwErrorCode *errorCode)
Get the termination type code of this terminal.
BSTR getLineDiagramSymbolName(EwErrorCode *errorCode)
Get the line diagram symbol name.
IEwManufacturerPartCircuitX addEwManufacturerPartCircuit(BSTR strCircuitCode, EwErrorCode *errorCode)
Create and add a circuit for this manufacturer part.
EwErrorCode setCommercialReference(BSTR lgCode, BSTR strValue)
Set a commercial reference of this manufacturer part.
EwErrorCode setMnemonic(BSTR strMnemonic)
Set a mnemonic of this terminal.
EwErrorCode setClassNodeID(LONG lNodeId)
Set the classification node ID of this manufacturer part.
LONG getEwManufacturerPartTerminalCount()
Count the number of terminals in this circuits.
EwErrorCode setEwManufacturerPartType(EwManufacturerPartType eManufacturerPartType)
Set the base type of this manufacturer part.
VARIANT getEwManufacturerPartArray(EwErrorCode *errorCode)
return the array of IEwManufacturerPartX of associated environment
EwErrorCode setWidth(DOUBLE dWidth)
Set the width of this manufacturer part.
EwErrorCode deleteEwManufacturerPartAt(int iIndex)
Remove a manufacturer parts specified by the index from the current Electrical Assembly.
BSTR getChannelAddress(EwErrorCode *errorCode)
Get a channel address of this circuit.
EwErrorCode setDepth(DOUBLE dDepth)
Set the depth of this manufacturer part.
EwErrorCode deleteEwManufacturerPartCircuitAt(LONG index)
Delete a circuit from this manufacturer part.
EwErrorCode deleteEwManufacturerPartTerminalAt(LONG index)
Delete a terminal from this circuit.
IEwManufacturerPartTerminalX getEwManufacturerPartTerminalAt(LONG index, EwErrorCode *errorCode)
Get terminal inside this circuit.
EwErrorCode setSerie(BSTR strSeries)
Set the series of this manufacturer part.
EwErrorCode deleteAllEwManufacturerPart()
Remove all manufacturer parts from the current Electrical Assembly.
Use this interface to manage a terminal inside a manufacturer part.
Definition: EwManufacturerPartObjects.idl:38
EwErrorCode setMaxWireNumber(LONG lMaxWireNumber)
Set a max wire number of this terminal.
EwErrorCode addEwManufacturerPart(IEwManufacturerPartX *iManufacturerPartX)
Add a new manufacturer parts from the current Electrical Assembly.
EwErrorCode setSymbolName(BSTR strSymbolName)
Set a symbol name of this circuit.
BSTR getManufacturer(EwErrorCode *errorCode)
Get the manufacturer of this manufacturer part.
EwErrorCode setUseVoltage(BSTR strUseVoltage)
Set the use voltage of this manufacturer part.
BSTR getUserData(LONG nUserDataNumber, EwErrorCode *errorCode)
Get user data of the object.
EwErrorCode setGroup(BSTR strGroup)
Set a group 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.
BSTR getArticleNumber(EwErrorCode *errorCode)
Get the article number of this manufacturer part.
IEwManufacturerPartX getEwManufacturerPartAt(int iIndex, EwErrorCode *errorCode)
Return the specified manufacturer parts from the current Electrical Assembly.
EwErrorCode addEwManufacturerPartAt(int iIndex, IEwManufacturerPartX *iManufacturerPartX)
Add a new manufacturer parts from the current Electrical Assembly at the specified position.
EwErrorCode setMaxWireSection(DOUBLE dMaxWireSection)
Set a max wire section of this terminal.
BSTR get2DFootprintSymbolName(EwErrorCode *errorCode)
Get the 2D Footprint Symbol Name.
BSTR getControlFrequency(EwErrorCode *ewErrorCode)
Get the ControlFrequency of this manufacturer part.
EwErrorCode setExternalID(BSTR strExternalID)
Set the external identifier of this manufacturer part.
EwErrorCode setLibraryCode(BSTR strLibraryCode)
Set the library code of this manufacturer part.
EwErrorCode set2DFootprintSymbolName(BSTR str2DFootprintSymbolName)
Set the 2D Footprint Symbol Name.
EwErrorCode setSymbolCircuitNumber(LONG lSyCircuitNo)
Set the circuit number associated to this object inside the associated symbol.


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) 2022 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.