Hide Table of Contents
SOLIDWORKS Electrical API  2020.0.5
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 
414 
415 
424 
425 
432  EwErrorCode remove ();
433 
434 
444 
445 
455 
456 
462 
463 
474 
475 
485  BSTR getDescription (BSTR lgCode, EwErrorCode* errorCode);
486 
487 
497  EwErrorCode setDescription (BSTR lgCode, BSTR strValue);
498 
499 
509  BSTR getCommercialReference (BSTR lgCode, EwErrorCode* errorCode);
510 
511 
521  EwErrorCode setCommercialReference (BSTR lgCode, BSTR strValue);
522 
523 
531  BSTR getReference (EwErrorCode* errorCode);
532 
533 
541  EwErrorCode setReference (BSTR strReference);
542 
543 
551  BSTR getManufacturer (EwErrorCode* errorCode);
552 
553 
561  EwErrorCode setManufacturer (BSTR strManufacturer);
562 
563 
571  LONG getClassNodeID (EwErrorCode* errorCode);
572 
573 
581  EwErrorCode setClassNodeID (LONG lNodeId);
582 
583 
591  BSTR getLibraryCode (EwErrorCode* errorCode);
592 
593 
601  EwErrorCode setLibraryCode (BSTR strLibraryCode);
602 
603 
611  BSTR getArticleNumber (EwErrorCode* errorCode);
612 
613 
621  EwErrorCode setArticleNumber (BSTR strArticleNumber);
622 
623 
631  BSTR getRootMark (EwErrorCode* errorCode);
632 
633 
641  EwErrorCode setRootMark (BSTR strRootMark);
642 
643 
651  BSTR getSerie (EwErrorCode* errorCode);
652 
653 
661  BSTR getSupplierName (EwErrorCode* errorCode);
662 
663 
671  EwErrorCode setSupplierName (BSTR strSupplierName);
672 
673 
681  BSTR getStockNumber (EwErrorCode* errorCode);
682 
683 
691  EwErrorCode setStockNumber (BSTR strStockNumber);
692 
693 
701  DATE getModificationDate (EwErrorCode* errorCode);
702 
703 
711  DATE getCreationDate (EwErrorCode* errorCode);
712 
713 
722 
723 
732 
733 
741  EwErrorCode setLineDiagramSymbolName (BSTR strLineDiagramSymbolName);
742 
743 
751  BSTR getSchemeSymbolName (EwErrorCode* errorCode);
752 
753 
761  EwErrorCode setSchemeSymbolName (BSTR strSchemeSymbolName);
762 
763 
771  BSTR get3DPartPath (EwErrorCode* errorCode);
772 
773 
782  EwErrorCode set3DPartPath (BSTR str3DPartPath);
783 
784 
793 
794 
802  EwErrorCode set2DFootprintSymbolName (BSTR str2DFootprintSymbolName);
803 
804 
813 
814 
822  EwErrorCode set2DConnectionLabelSymbolName (BSTR str2DConnectionLabelSymbolName);
823 
824 
832  EwErrorCode setWidth (DOUBLE dWidth);
833 
834 
842  EwErrorCode setHeight (DOUBLE dHeight);
843 
844 
852  EwErrorCode setDepth (DOUBLE dDepth);
853 
854 
862  EwErrorCode setUseVoltage (BSTR strUseVoltage);
863 
864 
872  EwErrorCode setUseFrequency (BSTR strUseFrequency);
873 
874 
882  EwErrorCode setControlVoltage (BSTR strControlVoltage);
883 
884 
892  EwErrorCode setControlFrequency (BSTR strControlFrequency);
893 
894 
904  BSTR getValue (LONG lValueId,EwErrorCode* errorCode);
905 
906 
916  EwErrorCode setValue (LONG lValueId, BSTR strValue);
917 
918 
927 
928 
937 
938 
946  EwErrorCode setSerie (BSTR bstrSerie);
947 
948 
956  DOUBLE getWidth (EwErrorCode * ewErrorCode);
957 
958 
966  DOUBLE getHeight (EwErrorCode* errorCode);
967 
968 
976  DOUBLE getDepth (EwErrorCode* errorCode);
977 
978 
986  BSTR getUseVoltage (EwErrorCode * ewErrorCode);
987 
988 
996  BSTR getUseFrequency (EwErrorCode * ewErrorCode);
997 
998 
1006  BSTR getControlVoltage (EwErrorCode* errorCode);
1007 
1008 
1016  BSTR getControlFrequency (EwErrorCode * ewErrorCode);
1017 
1018 
1027  BSTR getExternalID (EwErrorCode* errorCode);
1028 
1029 
1038  EwErrorCode setExternalID (BSTR strExternalID);
1039 
1040 
1050  EwErrorCode setUserData (LONG nUserDataNumber, BSTR strValue);
1051 
1052 
1062  BSTR getUserData (LONG nUserDataNumber, EwErrorCode* errorCode);
1063 
1064 
1076  EwErrorCode setTranslatedData (LONG nUserDataNumber, BSTR strLanguage, BSTR strValue);
1077 
1078 
1090  BSTR getTranslatedData (LONG nUserDataNumber, BSTR strLanguage, EwErrorCode* errorCode);
1091 
1100  BSTR getModifiedBy (EwErrorCode* eErrorCode);
1101 
1102 
1103 };
1104 
1108 [
1109  object,
1110  uuid(A35D4915-A636-405E-BEAD-FB0A5954DCCF),
1111  dual,
1112  oleautomation,
1113  nonextensible,
1114  helpstring("IEwManufacturerPartManagerX Interface"),
1115  pointer_default(unique)
1116 ]
1117 interface IEwManufacturerPartManagerX : IDispatch
1118 {
1124 
1125 
1129  LONG getCount ();
1130 
1131 
1136 
1137 
1142  IEwManufacturerPartFiltersX newEwManufacturerPartFilters ();
1143 
1144 
1154  IEwManufacturerPartX findByManufacturerAndReference (BSTR strManufacturer, BSTR strReference , EwErrorCode* errorCode);
1155 
1156 };
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
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:612
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.
EwErrorCode setSerie(BSTR bstrSerie)
Set the serie of this manufacturer part.
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:1118
BSTR getControlVoltage(EwErrorCode *errorCode)
Get the ControlVoltage of this manufacturer part.
EwErrorCode insert()
Insert this object inside the current environment.
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.
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.
EwErrorCode setEwManufacturerPartType(EwManufacturerPartType ewManufacturerPartType)
Set the base type of this manufacturer part.
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.
EwCreatorType
All creator type.
Definition: EwEnumeration.idl:239
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.
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) 2020 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.