Hide Table of Contents
SOLIDWORKS Electrical API  2022.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 
7 import "oaidl.idl";
8 import "ocidl.idl";
9 
10 import "EnumDefinition.idl";
11 import "EwObjectBase.idl";
12 import "EnumDefinition.idl";
13 import "EwClassificationObjects.idl";
14 
19 [
20  object,
21  uuid(2097bc6a-03c3-11e5-8418-1697f925ec7b),
22  dual,
23  oleautomation,
24  nonextensible,
25  helpstring("IEwProjectComponentTerminalX Interface"),
26  pointer_default(unique)
27 ]
28 interface IEwProjectComponentTerminalX : IDispatch
29 {
30 
31 
32 };
33 
38 [
39  object,
40  uuid(e8994c3e-03c2-11e5-8418-1697f925ec7b),
41  dual,
42  oleautomation,
43  nonextensible,
44  helpstring("IEwProjectComponentCircuitX Interface"),
45  pointer_default(unique)
46 ]
47 interface IEwProjectComponentCircuitX : IEwObjectX
48 {
49 
57  IEwProjectComponentTerminalX addEwProjectComponentTerminal (EwErrorCode* errorCode);
58 
59 
68  EwErrorCode deleteEwProjectComponentTerminalAt (LONG index);
69 
70 
75  LONG getEwProjectComponentTerminalCount ();
76 
77 
87  IEwProjectComponentTerminalX getEwProjectComponentTerminalAt (LONG index, EwErrorCode* errorCode);
88 
89 
99  BSTR getKeyCode (EwErrorCode* errorCode);
100 
101 
118  EwErrorCode setKeyCode (BSTR strKey);
119 
120 
130  EwErrorCode setChannelAddress (BSTR strChannelAddress);
131 
132 
141  BSTR getChannelAddress (EwErrorCode* errorCode);
142 
143 
153  EwErrorCode setChannelGroup (BSTR strChannelGroup);
154 
155 
164  BSTR getChannelGroup (EwErrorCode* errorCode);
165 
166 
176  VARIANT_BOOL hasBreakPage (EwErrorCode* errorCode);
177 
178 
187  EwErrorCode setBreakPage (VARIANT_BOOL bBreakPage);
188 
189 
190 
191 
200  VARIANT_BOOL isAutomaticAddress (EwErrorCode* errorCode);
201 
202 
211  EwErrorCode setAutomaticAddress (VARIANT_BOOL bIsAutomaticAddress);
212 
213 
214 
223  EwErrorCode setHidden (VARIANT_BOOL bIsHidden);
224 
225 
233  long getManufacturerPartID (EwErrorCode* errorCode);
234 
235 
236 
244  long getCircuitManufacturerPartID (EwErrorCode* errorCode);
245 
246 
247 
255  long getSymbolID (EwErrorCode* errorCode);
256 
257 
258 
266  long getCircuitSymbolID (EwErrorCode* errorCode);
267 
268 
269 
277  long getComponentID (EwErrorCode* errorCode);
278 
279 
280 
281 
282 };
283 
288 [
289  object,
290  uuid(a6c4df3a-03c2-11e5-8418-1697f925ec7b),
291  dual,
292  oleautomation,
293  nonextensible,
294  helpstring("IEwProjectComponentX Interface"),
295  pointer_default(unique)
296 ]
297 interface IEwProjectComponentX : IEwProjectTagObjectX
298 {
299 
308  BSTR getTagPath (EwErrorCode* errorCode);
309 
310 
321  VARIANT_BOOL getToDraw (EwErrorCode* errorCode);
322 
323 
334  EwErrorCode setToDraw (VARIANT_BOOL bToDraw);
335 
336 
345  EwComponentType getType (EwErrorCode* errorCode);
346 
347 
357  EwErrorCode setType (EwComponentType eComponentType);
358 
359 
372  EwErrorCode setClassNodeID (LONG lNodeId);
373 
374 
384  LONG getClassNodeID (EwErrorCode* errorCode);
385 
386 
387 
397  LONG getLocationID (EwErrorCode* errorCode);
398 
399 
400 
410  LONG getFunctionID (EwErrorCode* errorCode);
411 
412 
424  EwErrorCode setPropagateData (VARIANT_BOOL bPropogateData);
425 
426 
438  VARIANT_BOOL getPropagateData (EwErrorCode* errorCode);
439 
440 
452  EwErrorCode setBridgeConnection (EwAutoBridge eAutoBridge);
453 
454 
466  EwAutoBridge getBridgeConnection (EwErrorCode* errorCode);
467 
468 
480  EwErrorCode setPermanentComponent (VARIANT_BOOL bPermanent);
481 
482 
492  VARIANT_BOOL getPermanentComponent (EwErrorCode* errorCode);
493 
494 
506  LONG getChildrenCount (EwErrorCode* errorCode);
507 
508 
519  EwErrorCode setParentID (LONG lParenID);
520 
521 
531  LONG getParentID (EwErrorCode* errorCode);
532 
533 
545  EwErrorCode setConfigurationFileName (BSTR strConfigName);
546 
547 
559  BSTR getConfigurationFileName (EwErrorCode* pErrorCode);
560 
561 
572  IEwClassificationX getClassification (EwErrorCode* errorCode);
573 
574 };
575 
580 [
581  object,
582  uuid(b16df1f6-260e-11e5-b345-feff819cdc9f),
583  dual,
584  oleautomation,
585  nonextensible,
586  helpstring("IEwProjectComponentManagerX Interface"),
587  pointer_default(unique)
588 ]
589 interface IEwProjectComponentManagerX : IDispatch
590 {
594  LONG getCount ();
595 
596 
601  IEwProjectComponentX newEwProjectComponent ();
602 
603 
611  VARIANT getEwProjectComponentArray (EwErrorCode* errorCode);
612 
613 
624  IEwProjectComponentX findEwProjectComponentByID (LONG lID, EwErrorCode* errorCode);
625 
626 
637  IEwProjectComponentCircuitX findEwProjectComponentCircuitByID (LONG lID, EwErrorCode* errorCode);
638 
639 
648  VARIANT getEwProjectComponentCircuitArray (EwErrorCode* errorCode);
649 
650 
656  IEwProjectComponentCircuitX newEwProjectComponentCircuitX ();
657 
658 };
IEwProjectComponentX::setPermanentComponent
EwErrorCode setPermanentComponent(VARIANT_BOOL bPermanent)
Set permanent the component.
IEwProjectComponentX::getBridgeConnection
EwAutoBridge getBridgeConnection(EwErrorCode *errorCode)
Return the bridge connection enum type of the component.
IEwProjectComponentX::getPropagateData
VARIANT_BOOL getPropagateData(EwErrorCode *errorCode)
Return the Propagate Data of the component.
IEwProjectComponentX::setType
EwErrorCode setType(EwComponentType eComponentType)
Set the EwComponentType enum type of the component.
IEwProjectTagObjectX
Generic interface for an object that belongs to a project.
Definition: EwObjectBase.idl:103
IEwProjectComponentX::setPropagateData
EwErrorCode setPropagateData(VARIANT_BOOL bPropogateData)
Set the propagate data of Component.
IEwProjectComponentCircuitX::hasBreakPage
VARIANT_BOOL hasBreakPage(EwErrorCode *errorCode)
Return if this circuit component has a break page.
IEwProjectComponentCircuitX::setAutomaticAddress
EwErrorCode setAutomaticAddress(VARIANT_BOOL bIsAutomaticAddress)
Sets to fill in automatic the channel address.
IEwProjectComponentCircuitX::getSymbolID
long getSymbolID(EwErrorCode *errorCode)
Return the Symbol ID associated with the circuit component.
IEwProjectComponentX::getToDraw
VARIANT_BOOL getToDraw(EwErrorCode *errorCode)
Return true if it is drawable.
IEwProjectComponentCircuitX::getCircuitSymbolID
long getCircuitSymbolID(EwErrorCode *errorCode)
Return the Circuit Symbol ID associated with the circuit component.
IEwProjectComponentX::getLocationID
LONG getLocationID(EwErrorCode *errorCode)
Return the location ID of the component.
IEwProjectComponentX::getClassNodeID
LONG getClassNodeID(EwErrorCode *errorCode)
Get the classification node ID of this component class.
IEwProjectComponentTerminalX
Use this interface to manage ComponentTerminal inside a project.
Definition: EwProjectComponentObjects.idl:29
IEwObjectX
This interface is a generic interface for standard methods.
Definition: EwObjectBase.idl:82
EwErrorCode
EwErrorCode
All errors codes for this API.
Definition: EnumDefinition.idl:21
IEwProjectComponentX::getParentID
LONG getParentID(EwErrorCode *errorCode)
Return the parent ID.
IEwProjectComponentX::getConfigurationFileName
BSTR getConfigurationFileName(EwErrorCode *pErrorCode)
Return the configuration filename of Component use for terminals strip drawings, connector insertion ...
IEwProjectComponentX::getTagPath
BSTR getTagPath(EwErrorCode *errorCode)
Get the Mark path of the component, example: -N1-R1-M1.
IEwProjectComponentCircuitX::setKeyCode
EwErrorCode setKeyCode(BSTR strKey)
Sets the Key for the cross reference.
IEwProjectComponentCircuitX::setChannelGroup
EwErrorCode setChannelGroup(BSTR strChannelGroup)
Sets the new Channel Group.
EwComponentType
EwComponentType
All types of component type.
Definition: EwEnumeration.idl:936
IEwProjectComponentManagerX::findEwProjectComponentByID
IEwProjectComponentX findEwProjectComponentByID(LONG lID, EwErrorCode *errorCode)
Find a Component object in the project with the target ID.
IEwProjectComponentCircuitX::getEwProjectComponentTerminalCount
LONG getEwProjectComponentTerminalCount()
Count the number of terminals.
IEwProjectComponentX::getType
EwComponentType getType(EwErrorCode *errorCode)
Return the EwComponentType enum type of the component.
IEwProjectComponentCircuitX::getChannelGroup
BSTR getChannelGroup(EwErrorCode *errorCode)
Return the Channel Group.
IEwProjectComponentCircuitX::getComponentID
long getComponentID(EwErrorCode *errorCode)
Return the Component ID associated with the circuit component.
IEwProjectComponentCircuitX::getChannelAddress
BSTR getChannelAddress(EwErrorCode *errorCode)
Return the Channel Address.
IEwProjectComponentX
Use this interface to manage a component inside a project.
Definition: EwProjectComponentObjects.idl:298
IEwProjectComponentManagerX
Use this interface to manage the components inside a project.
Definition: EwProjectComponentObjects.idl:590
IEwProjectComponentCircuitX::addEwProjectComponentTerminal
IEwProjectComponentTerminalX addEwProjectComponentTerminal(EwErrorCode *errorCode)
Create and add a terminal.
IEwProjectComponentX::getPermanentComponent
VARIANT_BOOL getPermanentComponent(EwErrorCode *errorCode)
Return true if the component is permanent.
IEwProjectComponentX::setToDraw
EwErrorCode setToDraw(VARIANT_BOOL bToDraw)
Set this value to true to draw the terminal strip drawing of this component.
IEwProjectComponentCircuitX::setHidden
EwErrorCode setHidden(VARIANT_BOOL bIsHidden)
Sets to Hide this circuit component.
IEwProjectComponentManagerX::getEwProjectComponentArray
VARIANT getEwProjectComponentArray(EwErrorCode *errorCode)
Get all the Component objects ID in the project.
IEwProjectComponentCircuitX::setChannelAddress
EwErrorCode setChannelAddress(BSTR strChannelAddress)
Sets the new Channel Address.
IEwProjectComponentX::getChildrenCount
LONG getChildrenCount(EwErrorCode *errorCode)
Return the number of children components.
IEwProjectComponentCircuitX::isAutomaticAddress
VARIANT_BOOL isAutomaticAddress(EwErrorCode *errorCode)
Return if the channel address is fill in automatic.
IEwProjectComponentManagerX::getEwProjectComponentCircuitArray
VARIANT getEwProjectComponentCircuitArray(EwErrorCode *errorCode)
Get the array of IEwProjectComponentCircuitX ID of the current project.
IEwProjectComponentX::getClassification
IEwClassificationX getClassification(EwErrorCode *errorCode)
Get the classification of the current component.
IEwProjectComponentX::setBridgeConnection
EwErrorCode setBridgeConnection(EwAutoBridge eAutoBridge)
Set the bridge connection enum type of Component.
IEwProjectComponentCircuitX::getEwProjectComponentTerminalAt
IEwProjectComponentTerminalX getEwProjectComponentTerminalAt(LONG index, EwErrorCode *errorCode)
Get a terminal.
IEwProjectComponentCircuitX
Use this interface to manage component element inside a project.
Definition: EwProjectComponentObjects.idl:48
IEwProjectComponentCircuitX::getCircuitManufacturerPartID
long getCircuitManufacturerPartID(EwErrorCode *errorCode)
Return the Circuit ManufacturerPart ID associated with the circuit component.
IEwProjectComponentCircuitX::setBreakPage
EwErrorCode setBreakPage(VARIANT_BOOL bBreakPage)
Add/Remove break page.
IEwProjectComponentX::setConfigurationFileName
EwErrorCode setConfigurationFileName(BSTR strConfigName)
Set the configuration filename of Component.
IEwProjectComponentX::setClassNodeID
EwErrorCode setClassNodeID(LONG lNodeId)
Set the classification node ID of this component.
IEwProjectComponentManagerX::findEwProjectComponentCircuitByID
IEwProjectComponentCircuitX findEwProjectComponentCircuitByID(LONG lID, EwErrorCode *errorCode)
return an EwProjectComponentCircuitX according to an Id
IEwProjectComponentCircuitX::deleteEwProjectComponentTerminalAt
EwErrorCode deleteEwProjectComponentTerminalAt(LONG index)
Delete a terminal.
IEwProjectComponentManagerX::newEwProjectComponentCircuitX
IEwProjectComponentCircuitX newEwProjectComponentCircuitX()
Create an interface for a new Component Circuit object in the current project.
IEwProjectComponentX::getFunctionID
LONG getFunctionID(EwErrorCode *errorCode)
Return the function ID of the component.
IEwProjectComponentCircuitX::getManufacturerPartID
long getManufacturerPartID(EwErrorCode *errorCode)
Return the ManufacturerPart ID associated with the circuit component.
IEwProjectComponentManagerX::newEwProjectComponent
IEwProjectComponentX newEwProjectComponent()
Create an interface for a new Component object in the current project.
IEwProjectComponentX::setParentID
EwErrorCode setParentID(LONG lParenID)
Set the parent ID.
IEwProjectComponentCircuitX::getKeyCode
BSTR getKeyCode(EwErrorCode *errorCode)
Return the Key for the cross reference.
Generated on Wed Aug 18 2021 10:34:10 for SOLIDWORKS Electrical API by   doxygen 1.8.18


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

0.20.21