Hide Table of Contents
SOLIDWORKS Electrical API  2021.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 "EnumDefinition.idl";
11 
12 /************************************************************************/
13 /* In his file, all MANUFACTURER PART object */
14 /************************************************************************/
15 
16 /************************************************************************/
17 /* ENUMERATION */
18 /************************************************************************/
19 
20 /************************************************************************/
21 /* INTERFACES */
22 /************************************************************************/
27 [
28  object,
29  uuid(DABCB1C7-AC49-4B1A-9460-F0AF4BF05B18),
30  dual,
31  oleautomation,
32  nonextensible,
33  helpstring("IEwManufacturerPartTerminalX Interface"),
34  pointer_default(unique)
35 ]
36 interface IEwManufacturerPartTerminalX : IDispatch{
37 
38 
39 
44  LONG getNumber ();
45 
46 
52 
53 
61  BSTR getText (EwErrorCode* errorCode);
62 
63 
71  EwErrorCode setText (BSTR strText);
72 
73 
81  BSTR getMnemonic (EwErrorCode* errorCode);
82 
83 
91  EwErrorCode setMnemonic (BSTR strMnemonic);
92 
93 
101  DOUBLE getMaxWireSection (EwErrorCode* errorCode);
102 
103 
112  EwErrorCode setMaxWireSection (DOUBLE dMaxWireSection);
113 
114 
122  LONG getMaxWireNumber (EwErrorCode* errorCode);
123 
124 
133  EwErrorCode setMaxWireNumber (LONG lMaxWireNumber);
134 
135 
143  BSTR getMaxWireGauge (EwErrorCode* errorCode);
144 
145 
154  EwErrorCode setMaxWireGauge (BSTR strMaxWireGauge);
155 
156 
166 
167 
176  EwErrorCode setTerminationTypeCode (BSTR strTerminationTypeCode);
177 
178 };
179 
180 
181 
186 [
187  object,
188  uuid(3AA64D24-E0F0-43D4-AC82-B4D5E804ADAB),
189  dual,
190  oleautomation,
191  nonextensible,
192  helpstring("IEwManufacturerPartCircuitX Interface"),
193  pointer_default(unique)
194 ]
195 interface IEwManufacturerPartCircuitX : IDispatch{
196 
197 
198 
207 
208 
217 
218 
224 
225 
235 
236 
241  LONG getNumber ();
242 
243 
251  BSTR getGroup (EwErrorCode* errorCode);
252 
253 
261  EwErrorCode setGroup (BSTR strGroup);
262 
263 
271  BSTR getChannelGroup (EwErrorCode* errorCode);
272 
273 
281  EwErrorCode setChannelGroup (BSTR strChannelGroup);
282 
283 
291  BSTR getChannelAddress (EwErrorCode* errorCode);
292 
293 
301  EwErrorCode setChannelAddress (BSTR strChannelAddress);
302 
303 
311  BSTR getSymbolName (EwErrorCode* errorCode);
312 
313 
321  EwErrorCode setSymbolName (BSTR strSymbolName);
322 
323 
331  LONG getSymbolNumber (EwErrorCode* errorCode);
332 
333 
341  EwErrorCode setSymbolNumber (LONG lSymbolNumber);
342 
343 
352 
353 
361  EwErrorCode setSymbolCircuitNumber (LONG lSyCircuitNo);
362 
363 
371  BSTR getType (EwErrorCode* errorCode);
372 
373 
381  EwErrorCode setType (BSTR strType);
382 
383 };
384 
385 
390 [
391  object,
392  uuid(8961A429-4144-4A41-8C8B-B2414EC74DDD),
393  dual,
394  oleautomation,
395  nonextensible,
396  helpstring("IEwManufacturerPartX Interface"),
397  pointer_default(unique)
398 ]
399 interface IEwManufacturerPartX : IDispatch
400 {
401 
402 
403 
415 
416 
426 
427 
435  EwErrorCode remove ();
436 
437 
448 
449 
460 
461 
467 
468 
480 
481 
492  BSTR getDescription (BSTR lgCode, EwErrorCode* errorCode);
493 
494 
505  EwErrorCode setDescription (BSTR lgCode, BSTR strValue);
506 
507 
518  BSTR getCommercialReference (BSTR lgCode, EwErrorCode* errorCode);
519 
520 
531  EwErrorCode setCommercialReference (BSTR lgCode, BSTR strValue);
532 
533 
541  BSTR getReference (EwErrorCode* errorCode);
542 
543 
552  EwErrorCode setReference (BSTR strReference);
553 
554 
562  BSTR getManufacturer (EwErrorCode* errorCode);
563 
564 
573  EwErrorCode setManufacturer (BSTR strManufacturer);
574 
575 
583  LONG getClassNodeID (EwErrorCode* errorCode);
584 
585 
594  EwErrorCode setClassNodeID (LONG lNodeId);
595 
596 
604  BSTR getLibraryCode (EwErrorCode* errorCode);
605 
606 
615  EwErrorCode setLibraryCode (BSTR strLibraryCode);
616 
617 
625  BSTR getArticleNumber (EwErrorCode* errorCode);
626 
627 
636  EwErrorCode setArticleNumber (BSTR strArticleNumber);
637 
638 
646  BSTR getRootMark (EwErrorCode* errorCode);
647 
648 
657  EwErrorCode setRootMark (BSTR strRootMark);
658 
659 
667  BSTR getSerie (EwErrorCode* errorCode);
668 
669 
677  BSTR getSupplierName (EwErrorCode* errorCode);
678 
679 
688  EwErrorCode setSupplierName (BSTR strSupplierName);
689 
690 
698  BSTR getStockNumber (EwErrorCode* errorCode);
699 
700 
709  EwErrorCode setStockNumber (BSTR strStockNumber);
710 
711 
719  DATE getModificationDate (EwErrorCode* errorCode);
720 
721 
729  DATE getCreationDate (EwErrorCode* errorCode);
730 
731 
740 
741 
750 
751 
760  EwErrorCode setLineDiagramSymbolName (BSTR strLineDiagramSymbolName);
761 
762 
770  BSTR getSchemeSymbolName (EwErrorCode* errorCode);
771 
772 
781  EwErrorCode setSchemeSymbolName (BSTR strSchemeSymbolName);
782 
783 
791  BSTR get3DPartPath (EwErrorCode* errorCode);
792 
793 
803  EwErrorCode set3DPartPath (BSTR str3DPartPath);
804 
805 
814 
815 
824  EwErrorCode set2DFootprintSymbolName (BSTR str2DFootprintSymbolName);
825 
826 
835 
836 
845  EwErrorCode set2DConnectionLabelSymbolName (BSTR str2DConnectionLabelSymbolName);
846 
847 
856  EwErrorCode setWidth (DOUBLE dWidth);
857 
858 
867  EwErrorCode setHeight (DOUBLE dHeight);
868 
869 
878  EwErrorCode setDepth (DOUBLE dDepth);
879 
880 
889  EwErrorCode setUseVoltage (BSTR strUseVoltage);
890 
891 
900  EwErrorCode setUseFrequency (BSTR strUseFrequency);
901 
902 
911  EwErrorCode setControlVoltage (BSTR strControlVoltage);
912 
913 
922  EwErrorCode setControlFrequency (BSTR strControlFrequency);
923 
924 
935  BSTR getValue (LONG lValueId,EwErrorCode* errorCode);
936 
937 
948  EwErrorCode setValue (LONG lValueId, BSTR strValue);
949 
950 
960 
961 
971 
972 
981  EwErrorCode setSerie (BSTR strSerie);
982 
983 
992  DOUBLE getWidth (EwErrorCode * ewErrorCode);
993 
994 
1003  DOUBLE getHeight (EwErrorCode* errorCode);
1004 
1005 
1014  DOUBLE getDepth (EwErrorCode* errorCode);
1015 
1016 
1025  BSTR getUseVoltage (EwErrorCode * ewErrorCode);
1026 
1027 
1036  BSTR getUseFrequency (EwErrorCode * ewErrorCode);
1037 
1038 
1047  BSTR getControlVoltage (EwErrorCode* errorCode);
1048 
1049 
1058  BSTR getControlFrequency (EwErrorCode * ewErrorCode);
1059 
1060 
1069  BSTR getExternalID (EwErrorCode* errorCode);
1070 
1071 
1081  EwErrorCode setExternalID (BSTR strExternalID);
1082 
1083 
1094  EwErrorCode setUserData (LONG nUserDataNumber, BSTR strValue);
1095 
1096 
1107  BSTR getUserData (LONG nUserDataNumber, EwErrorCode* errorCode);
1108 
1109 
1122  EwErrorCode setTranslatedData (LONG nUserDataNumber, BSTR strLanguage, BSTR strValue);
1123 
1124 
1137  BSTR getTranslatedData (LONG nUserDataNumber, BSTR strLanguage, EwErrorCode* errorCode);
1138 
1148  BSTR getModifiedBy (EwErrorCode* eErrorCode);
1149 
1150 
1160  VARIANT_BOOL getExcludeFromBillOfMaterials (EwErrorCode* errorCode);
1161 
1162 
1172  EwErrorCode setExcludeFromBillOfMaterials (VARIANT_BOOL bIsExcludeFromBOM);
1173 
1174 
1184  BSTR getCreatedBy (EwErrorCode* eErrorCode);
1185 
1186 
1187 
1188 };
1189 
1193 [
1194  object,
1195  uuid(A35D4915-A636-405E-BEAD-FB0A5954DCCF),
1196  dual,
1197  oleautomation,
1198  nonextensible,
1199  helpstring("IEwManufacturerPartManagerX Interface"),
1200  pointer_default(unique)
1201 ]
1202 interface IEwManufacturerPartManagerX : IDispatch
1203 {
1209 
1210 
1214  LONG getCount ();
1215 
1216 
1221 
1222 
1227  IEwManufacturerPartFiltersX newEwManufacturerPartFilters ();
1228 
1229 
1239  IEwManufacturerPartX findByManufacturerAndReference (BSTR strManufacturer, BSTR strReference , EwErrorCode* errorCode);
1240 
1241 };
BSTR getModifiedBy(EwErrorCode *eErrorCode)
Get the last user name that modified the current object.
BSTR get3DPartPath(EwErrorCode *errorCode)
Get the 3D part associated with this manufacturer part.
BSTR getSerie(EwErrorCode *errorCode)
Get the serie of this manufacturer part.
BSTR getUseFrequency(EwErrorCode *ewErrorCode)
Get the UseFrequency of this manufacturer part.
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.
EwErrorCode update()
Update this object inside the current environment.
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:400
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:621
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.
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.
DATE getModificationDate(EwErrorCode *errorCode)
Get the last modification date of this manufacturer part.
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:1203
BSTR getControlVoltage(EwErrorCode *errorCode)
Get the ControlVoltage of this manufacturer part.
EwErrorCode insert()
Insert this object inside the current environment.
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.
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.
BSTR getTranslatedData(LONG nUserDataNumber, BSTR strLanguage, EwErrorCode *errorCode)
Get the value of a translated text.
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.
EwCreatorType getEwCreatorType(EwErrorCode *errorCode)
Get the creator of this manufacturer part.
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.
Use this interface to manage a terminal inside a manufacturer part.
Definition: EwManufacturerPartObjects.idl:36
EwErrorCode setMaxWireNumber(LONG lMaxWireNumber)
Set a max wire number of this terminal.
EwErrorCode setSymbolName(BSTR strSymbolName)
Set a symbol name of this circuit.
BSTR getManufacturer(EwErrorCode *errorCode)
Get the manufacturer of this manufacturer part.
DATE getCreationDate(EwErrorCode *errorCode)
Get the creation date 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 setTranslatedData(LONG nUserDataNumber, BSTR strLanguage, BSTR strValue)
Set the value of a translated text.
EwErrorCode setSerie(BSTR strSerie)
Set the serie of this manufacturer part.
EwCreatorType
All creator type.
Definition: EwEnumeration.idl:246
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.
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.
BSTR getCreatedBy(EwErrorCode *eErrorCode)
Get the user name that created the current object.
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) 2021 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.