Hide Table of Contents
SOLIDWORKS Electrical API 2024.0.0
Electrical API
EwProjectComponentObjects.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
7import "oaidl.idl";
8import "ocidl.idl";
9
10import "EnumDefinition.idl";
11import "EwObjectBaseObjects.idl";
12import "EnumDefinition.idl";
13import "EwClassificationObjects.idl";
14import "EwTerminalObjects.idl";
15import "EwProjectLocationObjects.idl";
16import "EwProjectFunctionObjects.idl";
17
22[
23 object,
24 uuid(2097bc6a-03c3-11e5-8418-1697f925ec7b),
25 dual,
26 oleautomation,
27 nonextensible,
28 helpstring("IEwProjectComponentTerminalX Interface"),
29 pointer_default(unique)
30]
32{
42 LONG getCircuitID (EwErrorCode* errorCode);
43
44
54 LONG getIndex (EwErrorCode* errorCode);
55
56
66 BSTR getMark (EwErrorCode* errorCode);
67
68
79 EwErrorCode setMark (BSTR sTerminalMark);
80
81
92
93
104
105
117
118
129 EwErrorCode setWireTerminationType (LONG lWireTerminationTypeID);
130
131
142
143
155
156
166 BSTR getMnemonic (EwErrorCode* errorCode);
167
168
179 EwErrorCode setMnemonic (BSTR strMnemonic);
180
181
191 BSTR getUtilization (EwErrorCode* errorCode);
192
193
204 EwErrorCode setUtilization (BSTR strUtilization);
205
206
217
218
229 EwErrorCode setMaximumWireSection (DOUBLE dMaxSection);
230
231
242
243
254 EwErrorCode setMinimumWireSection (DOUBLE dMinSection);
255
256};
257
262[
263 object,
264 uuid(e8994c3e-03c2-11e5-8418-1697f925ec7b),
265 dual,
266 oleautomation,
267 nonextensible,
268 helpstring("IEwProjectComponentCircuitX Interface"),
269 pointer_default(unique)
270]
272{
281
282
292
293
299
300
311
312
322 BSTR getKeyCode (EwErrorCode* errorCode);
323
324
341 EwErrorCode setKeyCode (BSTR strKey);
342
343
353 EwErrorCode setChannelAddress (BSTR strChannelAddress);
354
355
365
366
376 EwErrorCode setChannelGroup (BSTR strChannelGroup);
377
378
387 BSTR getChannelGroup (EwErrorCode* errorCode);
388
389
399 VARIANT_BOOL hasBreakPage (EwErrorCode* errorCode);
400
401
410 EwErrorCode setBreakPage (VARIANT_BOOL bBreakPage);
411
412
413
414
423 VARIANT_BOOL isAutomaticAddress (EwErrorCode* errorCode);
424
425
434 EwErrorCode setAutomaticAddress (VARIANT_BOOL bIsAutomaticAddress);
435
436
437
446 EwErrorCode setHidden (VARIANT_BOOL bIsHidden);
447
448
457
458
459
468
469
470
478 long getSymbolID (EwErrorCode* errorCode);
479
480
481
490
491
492
500 long getComponentID (EwErrorCode* errorCode);
501
502
503
512 BSTR getTag (EwErrorCode* errorCode);
513
514};
515
520[
521 object,
522 uuid(a6c4df3a-03c2-11e5-8418-1697f925ec7b),
523 dual,
524 oleautomation,
525 nonextensible,
526 helpstring("IEwProjectComponentX Interface"),
527 pointer_default(unique)
528]
530{
531
540 BSTR getTagPath (EwErrorCode* errorCode);
541
542
553 VARIANT_BOOL getToDraw (EwErrorCode* errorCode);
554
555
566 EwErrorCode setToDraw (VARIANT_BOOL bToDraw);
567
568
578
579
590
591
605
606
616 LONG getClassNodeID (EwErrorCode* errorCode);
617
618
619
629 LONG getLocationID (EwErrorCode* errorCode);
630
631
632
642 LONG getFunctionID (EwErrorCode* errorCode);
643
644
656 EwErrorCode setPropagateData (VARIANT_BOOL bPropogateData);
657
658
670 VARIANT_BOOL getPropagateData (EwErrorCode* errorCode);
671
672
685
686
699
700
712 EwErrorCode setPermanentComponent (VARIANT_BOOL bPermanent);
713
714
724 VARIANT_BOOL getPermanentComponent (EwErrorCode* errorCode);
725
726
738 LONG getChildrenCount (EwErrorCode* errorCode);
739
740
751 EwErrorCode setParentID (LONG lParenID);
752
753
763 LONG getParentID (EwErrorCode* errorCode);
764
765
778
779
792
793
805
806
820 EwErrorCode assignManufacturerPart (BSTR strManufacturer, BSTR strReference);
821
822
837
838
852 EwErrorCode setManufacturerDataValue (EwManufacturerDataIndex eIndexValue, BSTR strManufacturerDataValue);
853
854
866 LONG getClassID (EwErrorCode* errorCode);
867
868
880
881
894
895
908
909
921
922
935
936};
937
942[
943 object,
944 uuid(b16df1f6-260e-11e5-b345-feff819cdc9f),
945 dual,
946 oleautomation,
947 nonextensible,
948 helpstring("IEwProjectComponentManagerX Interface"),
949 pointer_default(unique)
950]
951interface IEwProjectComponentManagerX : IDispatch
952{
956 LONG getCount ();
957
958
964
965
974
975
987
988
1000
1001
1011
1012
1019
1020};
EwManufacturerDataIndex
Enumeration of the manufacturer data indexes.
Definition: EnumDefinition.idl:469
EwErrorCode
All errors codes for this API.
Definition: EnumDefinition.idl:24
EwComponentType
All types of component type.
Definition: EwEnumeration.idl:987
EwPointOrientation
Flow direction of symbol connexion point type.
Definition: EwEnumeration.idl:687
EwAutoBridge
autobrige of component
Definition: EwEnumeration.idl:1162
Use this interface to manage an IEwClassificationX object.
Definition: EwClassificationObjects.idl:228
This interface is the first entry point for the Object.
Definition: EwObjectBaseObjects.idl:26
This interface is a generic interface for standard object methods.
Definition: EwObjectBaseObjects.idl:97
Use this interface to manage component element inside a project.
Definition: EwProjectComponentObjects.idl:272
long getComponentID(EwErrorCode *errorCode)
Return the Component ID associated with the circuit component.
EwErrorCode setKeyCode(BSTR strKey)
Sets the Key for the cross reference.
IEwProjectComponentTerminalX getEwProjectComponentTerminalAt(LONG index, EwErrorCode *errorCode)
Get a terminal.
EwErrorCode deleteEwProjectComponentTerminalAt(LONG index)
Delete a terminal.
BSTR getChannelGroup(EwErrorCode *errorCode)
Return the Channel Group.
EwErrorCode setBreakPage(VARIANT_BOOL bBreakPage)
Add/Remove break page.
long getManufacturerPartID(EwErrorCode *errorCode)
Return the ManufacturerPart ID associated with the circuit component.
long getCircuitSymbolID(EwErrorCode *errorCode)
Return the Circuit Symbol ID associated with the circuit component.
BSTR getChannelAddress(EwErrorCode *errorCode)
Return the Channel Address.
VARIANT_BOOL isAutomaticAddress(EwErrorCode *errorCode)
Return if the channel address is fill in automatic.
LONG getEwProjectComponentTerminalCount()
Count the number of terminals.
EwErrorCode setChannelGroup(BSTR strChannelGroup)
Sets the new Channel Group.
BSTR getTag(EwErrorCode *errorCode)
Get the mark of this object.
VARIANT_BOOL hasBreakPage(EwErrorCode *errorCode)
Return if this circuit component has a break page.
BSTR getKeyCode(EwErrorCode *errorCode)
Return the Key for the cross reference.
IEwProjectComponentTerminalX addEwProjectComponentTerminal(EwErrorCode *errorCode)
Create and add a terminal.
EwErrorCode setHidden(VARIANT_BOOL bIsHidden)
Sets to Hide this circuit component.
EwErrorCode setAutomaticAddress(VARIANT_BOOL bIsAutomaticAddress)
Sets to fill in automatic the channel address.
long getSymbolID(EwErrorCode *errorCode)
Return the Symbol ID associated with the circuit component.
EwErrorCode setChannelAddress(BSTR strChannelAddress)
Sets the new Channel Address.
long getCircuitManufacturerPartID(EwErrorCode *errorCode)
Return the Circuit ManufacturerPart ID associated with the circuit component.
Use this interface to manage the components inside a project.
Definition: EwProjectComponentObjects.idl:952
VARIANT getEwProjectComponentCircuitArray(EwErrorCode *errorCode)
Get the array of IEwProjectComponentCircuitX ID of the current project.
IEwProjectComponentX newEwProjectComponent()
Create an interface for a new Component object in the current project.
VARIANT getEwProjectComponentArray(EwErrorCode *errorCode)
Get all the Component objects ID in the project.
IEwProjectComponentX findEwProjectComponentByID(LONG lID, EwErrorCode *errorCode)
Find a Component object in the project with the target ID.
IEwProjectComponentCircuitX newEwProjectComponentCircuitX()
Create an interface for a new Component Circuit object in the current project.
IEwProjectComponentCircuitX findEwProjectComponentCircuitByID(LONG lID, EwErrorCode *errorCode)
return an EwProjectComponentCircuitX according to an Id
Use this interface to manage ComponentTerminal inside a project.
Definition: EwProjectComponentObjects.idl:32
EwPointOrientation getOrientation(EwErrorCode *errorCode)
Get the EwPointOrientation enum type of the current terminal.
LONG getIndex(EwErrorCode *errorCode)
Get the index of the current terminal.
EwErrorCode setWireTerminationType(LONG lWireTerminationTypeID)
Set a termination type to the current terminal.
EwErrorCode setMark(BSTR sTerminalMark)
Set the mark of the current terminal.
LONG getMaximumWireNumber(EwErrorCode *errorCode)
Get the maximum number of wires than can be connected to the current terminal.
BSTR getMnemonic(EwErrorCode *errorCode)
Get the mnemonic of the current terminal.
IEwWireTerminationTypeX getWireTerminationType(EwErrorCode *errorCode)
Get the termination type of the current terminal.
EwErrorCode setUtilization(BSTR strUtilization)
Set the utilization text of the current terminal.
EwErrorCode setMnemonic(BSTR strMnemonic)
Set the mnemonic of the current terminal.
BSTR getMark(EwErrorCode *errorCode)
Get the mark of the current terminal.
BSTR getUtilization(EwErrorCode *errorCode)
Get the utilization text of the current terminal.
LONG getCircuitID(EwErrorCode *errorCode)
Return the circuit ID of the current terminal.
EwErrorCode setOrientation(EwPointOrientation ePointOrientation)
Set the EwPointOrientation enum type of the current terminal.
EwErrorCode setMinimumWireSection(DOUBLE dMinSection)
Set the minimum wire section of the current terminal in square millimeter (mm²).
DOUBLE getMaximumWireSection(EwErrorCode *errorCode)
Get the maximum wire section of the current terminal in square millimeter (mm²).
EwErrorCode setMaximumWireSection(DOUBLE dMaxSection)
Set the maximum wire section of the current terminal in square millimeter (mm²).
DOUBLE getMinimumWireSection(EwErrorCode *errorCode)
Get the minimum wire section of the current terminal in square millimeter (mm²).
EwErrorCode setMaximumWireNumber(LONG lMaxWire)
Set the maximum number of wires than can be connected to the current terminal.
Use this interface to manage a component inside a project.
Definition: EwProjectComponentObjects.idl:530
EwErrorCode setClassNodeID(LONG lNodeId)
Set the classification node ID of this component.
EwErrorCode setToDraw(VARIANT_BOOL bToDraw)
Set this value to true to draw the terminal strip drawing of this component.
EwComponentType getType(EwErrorCode *errorCode)
Return the EwComponentType enum type of the component.
LONG getLocationID(EwErrorCode *errorCode)
Return the location ID of the component.
BSTR getManufacturerDataValue(EwManufacturerDataIndex eIndexValue, EwErrorCode *errorCode)
Get a manufacturer data value associated to the current component.
LONG getFunctionID(EwErrorCode *errorCode)
Return the function ID of the component.
EwErrorCode setBridgeConnection(EwAutoBridge eAutoBridge)
Set the bridge connection enum type of Component.
EwErrorCode setPropagateData(VARIANT_BOOL bPropogateData)
Set the propagate data of Component.
LONG getParentID(EwErrorCode *errorCode)
Return the parent ID.
EwErrorCode setPermanentComponent(VARIANT_BOOL bPermanent)
Set permanent the component.
IEwClassificationX getClassification(EwErrorCode *errorCode)
Get the classification of the current component.
EwErrorCode setParentID(LONG lParenID)
Set the parent ID.
LONG getChildrenCount(EwErrorCode *errorCode)
Return the number of children components.
VARIANT_BOOL getToDraw(EwErrorCode *errorCode)
Return true if it is drawable.
BSTR getTagPath(EwErrorCode *errorCode)
Get the Mark path of the component, example: -N1-R1-M1.
EwAutoBridge getBridgeConnection(EwErrorCode *errorCode)
Return the bridge connection enum type of the component.
EwErrorCode setClassID(LONG lID)
Set the class ID of this component.
EwErrorCode setType(EwComponentType eComponentType)
Set the EwComponentType enum type of the component.
EwErrorCode setConfigurationFileName(BSTR strConfigName)
Set the configuration filename of Component.
EwErrorCode assignManufacturerPart(BSTR strManufacturer, BSTR strReference)
Assign a Manufacturer Part to the current component.
LONG getClassNodeID(EwErrorCode *errorCode)
Get the classification node ID of this component class.
EwErrorCode setEwProjectFunctionID(long lID)
Set the EwProjectFunctionX associated ID to the component.
VARIANT_BOOL getPropagateData(EwErrorCode *errorCode)
Return the Propagate Data of the component.
VARIANT_BOOL getPermanentComponent(EwErrorCode *errorCode)
Return true if the component is permanent.
LONG getClassID(EwErrorCode *errorCode)
Get the class ID of component.
EwErrorCode setManufacturerDataValue(EwManufacturerDataIndex eIndexValue, BSTR strManufacturerDataValue)
Set a manufacturer data value associated to the current component.
long getEwProjectFunctionID(EwErrorCode *errorCode)
Get the ID of EwProjectFunctionX associated at the component.
long getEwProjectLocationID(EwErrorCode *errorCode)
Get the ID of EwProjectLocationX associated at component.
EwErrorCode setEwProjectLocationID(long lID)
Set the EwProjectLocationX ID associated to the component.
BSTR getConfigurationFileName(EwErrorCode *errorCode)
Return the configuration filename of Component use for terminals strip drawings, connector insertion ...
Generic interface for an object that belongs to a project.
Definition: EwObjectBaseObjects.idl:118
Use this interface to manage a definition of a termination Type.
Definition: EwTerminalObjects.idl:30


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/EwProjectComponentObjects.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.