Hide Table of Contents
SOLIDWORKS Electrical API 2023.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";
15
20[
21 object,
22 uuid(2097bc6a-03c3-11e5-8418-1697f925ec7b),
23 dual,
24 oleautomation,
25 nonextensible,
26 helpstring("IEwProjectComponentTerminalX Interface"),
27 pointer_default(unique)
28]
30{
40 LONG getCircuitID (EwErrorCode* errorCode);
41
42
52 LONG getIndex (EwErrorCode* errorCode);
53
54
64 BSTR getMark (EwErrorCode* errorCode);
65
66
77 EwErrorCode setMark (BSTR sTerminalMark);
78
79
90
91
102
103
115
116
127 EwErrorCode setWireTerminationType (LONG lWireTerminationTypeID);
128
129
140
141
153
154
164 BSTR getMnemonic (EwErrorCode* errorCode);
165
166
177 EwErrorCode setMnemonic (BSTR strMnemonic);
178
179
189 BSTR getUtilization (EwErrorCode* errorCode);
190
191
202 EwErrorCode setUtilization (BSTR strUtilization);
203
204
215
216
227 EwErrorCode setMaximumWireSection (DOUBLE dMaxSection);
228
229
240
241
252 EwErrorCode setMinimumWireSection (DOUBLE dMinSection);
253
254
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{
273
282
283
293
294
300
301
312
313
323 BSTR getKeyCode (EwErrorCode* errorCode);
324
325
342 EwErrorCode setKeyCode (BSTR strKey);
343
344
354 EwErrorCode setChannelAddress (BSTR strChannelAddress);
355
356
366
367
377 EwErrorCode setChannelGroup (BSTR strChannelGroup);
378
379
388 BSTR getChannelGroup (EwErrorCode* errorCode);
389
390
400 VARIANT_BOOL hasBreakPage (EwErrorCode* errorCode);
401
402
411 EwErrorCode setBreakPage (VARIANT_BOOL bBreakPage);
412
413
414
415
424 VARIANT_BOOL isAutomaticAddress (EwErrorCode* errorCode);
425
426
435 EwErrorCode setAutomaticAddress (VARIANT_BOOL bIsAutomaticAddress);
436
437
438
447 EwErrorCode setHidden (VARIANT_BOOL bIsHidden);
448
449
458
459
460
469
470
471
479 long getSymbolID (EwErrorCode* errorCode);
480
481
482
491
492
493
501 long getComponentID (EwErrorCode* errorCode);
502
503
504
505
506};
507
512[
513 object,
514 uuid(a6c4df3a-03c2-11e5-8418-1697f925ec7b),
515 dual,
516 oleautomation,
517 nonextensible,
518 helpstring("IEwProjectComponentX Interface"),
519 pointer_default(unique)
520]
522{
523
532 BSTR getTagPath (EwErrorCode* errorCode);
533
534
545 VARIANT_BOOL getToDraw (EwErrorCode* errorCode);
546
547
558 EwErrorCode setToDraw (VARIANT_BOOL bToDraw);
559
560
570
571
582
583
597
598
608 LONG getClassNodeID (EwErrorCode* errorCode);
609
610
611
621 LONG getLocationID (EwErrorCode* errorCode);
622
623
624
634 LONG getFunctionID (EwErrorCode* errorCode);
635
636
648 EwErrorCode setPropagateData (VARIANT_BOOL bPropogateData);
649
650
662 VARIANT_BOOL getPropagateData (EwErrorCode* errorCode);
663
664
677
678
691
692
704 EwErrorCode setPermanentComponent (VARIANT_BOOL bPermanent);
705
706
716 VARIANT_BOOL getPermanentComponent (EwErrorCode* errorCode);
717
718
730 LONG getChildrenCount (EwErrorCode* errorCode);
731
732
743 EwErrorCode setParentID (LONG lParenID);
744
745
755 LONG getParentID (EwErrorCode* errorCode);
756
757
770
771
784
785
797
798
812 EwErrorCode assignManufacturerPart (BSTR strManufacturer, BSTR strReference);
813
814
829
830
844 EwErrorCode setManufacturerDataValue (EwManufacturerDataIndex eIndexValue, BSTR strManufacturerDataValue);
845
846
858 LONG getClassID (EwErrorCode* errorCode);
859
860
872
873};
874
879[
880 object,
881 uuid(b16df1f6-260e-11e5-b345-feff819cdc9f),
882 dual,
883 oleautomation,
884 nonextensible,
885 helpstring("IEwProjectComponentManagerX Interface"),
886 pointer_default(unique)
887]
888interface IEwProjectComponentManagerX : IDispatch
889{
893 LONG getCount ();
894
895
901
902
911
912
924
925
937
938
948
949
956
957};
EwManufacturerDataIndex
Enumeration of the manufacturer data indexes.
Definition: EnumDefinition.idl:459
EwErrorCode
All errors codes for this API.
Definition: EnumDefinition.idl:21
EwComponentType
All types of component type.
Definition: EwEnumeration.idl:982
EwPointOrientation
Flow direction of symbol connexion point type.
Definition: EwEnumeration.idl:684
EwAutoBridge
autobrige of compoment
Definition: EwEnumeration.idl:1157
Use this interface to manage an IEwClassificationX object.
Definition: EwClassificationObjects.idl:214
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.
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:889
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:30
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:522
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.
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.
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) 2023 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.