Hide Table of Contents
SOLIDWORKS Electrical API 2023.0.0
Electrical API
EwProjectWireObjects.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
8import "oaidl.idl";
9import "ocidl.idl";
10
11import "EnumDefinition.idl";
12import "EwObjectBaseObjects.idl";
13
14
19[
20 object,
21 uuid(61f18da4-03bd-11e5-8418-1697f925ec7b),
22 dual,
23 oleautomation,
24 nonextensible,
25 helpstring("IEwProjectWireX Interface"),
26 pointer_default(unique)
27]
28interface IEwProjectWireX : IEwObjectX
29{
40 EwErrorCode setUserData (LONG nUserDataNumber , BSTR strValue);
41
42
53 BSTR getUserData (LONG nUserDataNumber , EwErrorCode* errorCode);
54
55
64 BSTR getTag (EwErrorCode* errorCode);
65
66
78 EwErrorCode setTag (BSTR strValue);
79
80
89 BSTR getTagRoot (EwErrorCode* errorCode);
90
91
102 EwErrorCode setTagRoot (BSTR strValue);
103
104
113 EwTagMode getTagMode (EwErrorCode* errorCode);
114
115
125 EwErrorCode setTagMode (EwTagMode eTagMode);
126
127
136 long getTagNumber (EwErrorCode* errorCode);
137
138
150 EwErrorCode setTagNumber (long lValue);
151
152
161 EwErrorCode setNextTagNumber ();
162
163
172 VARIANT_BOOL isTagUnique (EwErrorCode* errorCode);
173
174
175 /*
176 * Set the wire length value
177 * \return EwErrorCode enum type, can be:
178 * \li EW_NO_ERROR if no error detected
179 * \li EW_UNDEFINED_ERROR if another error occurred
180 */
181 EwErrorCode setLength (DOUBLE dLength);
182
183
192 BSTR getLinearMass (EwErrorCode* errorCode);
193
194
204 EwErrorCode setLinearMass (BSTR strLinearMass);
205
206
220 EwErrorCode setHarnessID (long lHarnessID);
221
222
233 LONG getHarnessID (EwErrorCode* errorCode);
234
235
245 DOUBLE getLength (EwErrorCode* errorCode);
246
247
257 EwErrorCode setDiameter (DOUBLE dValue);
258
259
269 DOUBLE getDiameter (EwErrorCode* errorCode);
270
271
272
282 EwErrorCode setSectionOrGauge (BSTR strValue);
283
284
294 BSTR getSectionOrGauge (EwErrorCode* errorCode);
295
296
306 EwErrorCode setWireSizeStandard (EwWireSizeStandard eWireSizeStandard);
307
308
318 EwWireSizeStandard getWireSizeStandard (EwErrorCode* errorCode);
319
320
330 EwErrorCode setSignal (BSTR strValue);
331
332
342 BSTR getSignal (EwErrorCode* errorCode);
343
344
354 BSTR getColorCode (EwErrorCode* errorCode);
355
356
366 EwErrorCode setColorCode (BSTR strColorCode);
367
368
380 EwErrorCode setBendRadiusFactor (DOUBLE dBendRadiusFactor);
381
382
392 DOUBLE getBendRadiusFactor (EwErrorCode* errorCode);
393
394
405 EwErrorCode setBendRadius (DOUBLE dBendRadius);
406
407
417 DOUBLE getBendRadius (EwErrorCode* errorCode);
418
419
420
430 BSTR getPath (EwErrorCode* errorCode);
431
432
442 LONG getWireStyleID (EwErrorCode* errorCode);
443
444
454 BSTR getEquipotential (EwErrorCode* errorCode);
455
456
466 LONG getCableWireOrder (EwErrorCode* errorCode);
467
468
478 LONG getCableID (EwErrorCode* errorCode);
479
480
490 BSTR getOrigin (EwErrorCode* errorCode);
491
492
502 BSTR getDestination (EwErrorCode* errorCode);
503
504
514 BSTR getCableCoreDescription (EwErrorCode* errorCode);
515
516
517};
518
519
524[
525 object,
526 uuid(FC6A488D-6EA7-4800-9035-2F7F4FEA6E61),
527 dual,
528 nonextensible,
529 pointer_default(unique)
530]
531interface IEwProjectWireManagerX : IDispatch{
540 IEwProjectWireX findEwProjectWireByID (LONG lWireID, EwErrorCode* errorCode);
541
542
548 VARIANT getEwProjectWireArray (EwErrorCode* errorCode);
549
550
559 IEwProjectWireX newEwProjectWire (EwErrorCode* errorCode);
560
561};
EwErrorCode
EwErrorCode
All errors codes for this API.
Definition: EnumDefinition.idl:21
EwTagMode
EwTagMode
All Mark mode type.
Definition: EwEnumeration.idl:798
EwWireSizeStandard
EwWireSizeStandard
Wire size standard type.
Definition: EwEnumeration.idl:636
IEwObjectX
This interface is a generic interface for standard object methods.
Definition: EwObjectBaseObjects.idl:97
IEwProjectWireManagerX
Use this interface to manage IEwProjectWireX objects.
Definition: EwProjectWireObjects.idl:531
IEwProjectWireManagerX::newEwProjectWire
IEwProjectWireX newEwProjectWire(EwErrorCode *errorCode)
Create an interface for a new wire in the current project.
IEwProjectWireManagerX::getEwProjectWireArray
VARIANT getEwProjectWireArray(EwErrorCode *errorCode)
Get all the wires in the project of the manager.
IEwProjectWireManagerX::findEwProjectWireByID
IEwProjectWireX findEwProjectWireByID(LONG lWireID, EwErrorCode *errorCode)
Find a wire in the project with the target ID.
IEwProjectWireX
Use this interface to manage wire inside a project.
Definition: EwProjectWireObjects.idl:29
IEwProjectWireX::getBendRadiusFactor
DOUBLE getBendRadiusFactor(EwErrorCode *errorCode)
Get the bend radius factor associated with the current wire.
IEwProjectWireX::setUserData
EwErrorCode setUserData(LONG nUserDataNumber, BSTR strValue)
Set user data of the object.
IEwProjectWireX::getSignal
BSTR getSignal(EwErrorCode *errorCode)
Get the signal of this wire.
IEwProjectWireX::setBendRadius
EwErrorCode setBendRadius(DOUBLE dBendRadius)
Set the bend radius in millimeter associated with the current wire.
IEwProjectWireX::getSectionOrGauge
BSTR getSectionOrGauge(EwErrorCode *errorCode)
Get the section or gauge of this wire.
IEwProjectWireX::getCableWireOrder
LONG getCableWireOrder(EwErrorCode *errorCode)
Get the cabling order of the current wire.
IEwProjectWireX::getTagRoot
BSTR getTagRoot(EwErrorCode *errorCode)
Get the mark root of this object.
IEwProjectWireX::setBendRadiusFactor
EwErrorCode setBendRadiusFactor(DOUBLE dBendRadiusFactor)
Set the bend radius factor associated with the current wire.
IEwProjectWireX::setSectionOrGauge
EwErrorCode setSectionOrGauge(BSTR strValue)
Set the section or gauge of this wire.
IEwProjectWireX::getLength
DOUBLE getLength(EwErrorCode *errorCode)
Get the lenght of the current wire.
IEwProjectWireX::getWireStyleID
LONG getWireStyleID(EwErrorCode *errorCode)
Get the EwWireStyleX object ID of the current wire.
IEwProjectWireX::getTag
BSTR getTag(EwErrorCode *errorCode)
Get the mark of this object.
IEwProjectWireX::getDestination
BSTR getDestination(EwErrorCode *errorCode)
Get the destination of this wire.
IEwProjectWireX::setSignal
EwErrorCode setSignal(BSTR strValue)
Set the signal of this wire.
IEwProjectWireX::isTagUnique
VARIANT_BOOL isTagUnique(EwErrorCode *errorCode)
Returns true or false if mark is unique.
IEwProjectWireX::setWireSizeStandard
EwErrorCode setWireSizeStandard(EwWireSizeStandard eWireSizeStandard)
Set the wire size standard enum type of this wire.
IEwProjectWireX::setHarnessID
EwErrorCode setHarnessID(long lHarnessID)
Set the Harness ID of this wire.
IEwProjectWireX::getHarnessID
LONG getHarnessID(EwErrorCode *errorCode)
Get the Harness ID associated at the current wire.
IEwProjectWireX::getEquipotential
BSTR getEquipotential(EwErrorCode *errorCode)
Get the equipotential tag of this wire.
IEwProjectWireX::getOrigin
BSTR getOrigin(EwErrorCode *errorCode)
Get the origin of this wire.
IEwProjectWireX::setTagNumber
EwErrorCode setTagNumber(long lValue)
Set the mark number of this object.
IEwProjectWireX::setTag
EwErrorCode setTag(BSTR strValue)
Set the mark of this object.
IEwProjectWireX::setLinearMass
EwErrorCode setLinearMass(BSTR strLinearMass)
Set the linear mass (density) of this wire.
IEwProjectWireX::setLength
EwErrorCode setLength(DOUBLE dLength)
IEwProjectWireX::getPath
BSTR getPath(EwErrorCode *errorCode)
Get the duct path of the current wire.
IEwProjectWireX::getBendRadius
DOUBLE getBendRadius(EwErrorCode *errorCode)
Get the bend radius in millimeter associated with the current wire.
IEwProjectWireX::getCableCoreDescription
BSTR getCableCoreDescription(EwErrorCode *errorCode)
Get the cable core description of the current wire.
IEwProjectWireX::getUserData
BSTR getUserData(LONG nUserDataNumber, EwErrorCode *errorCode)
Get user data of the object.
IEwProjectWireX::setNextTagNumber
EwErrorCode setNextTagNumber()
Set the next number to have a unique mark.
IEwProjectWireX::setTagMode
EwErrorCode setTagMode(EwTagMode eTagMode)
Set the mark mode of this object.
IEwProjectWireX::setTagRoot
EwErrorCode setTagRoot(BSTR strValue)
Set the mark root of this object.
IEwProjectWireX::setColorCode
EwErrorCode setColorCode(BSTR strColorCode)
Set the color code of this wire.
IEwProjectWireX::getColorCode
BSTR getColorCode(EwErrorCode *errorCode)
Get the color code of this wire.
IEwProjectWireX::getTagMode
EwTagMode getTagMode(EwErrorCode *errorCode)
Get the mark mode of this object.
IEwProjectWireX::getLinearMass
BSTR getLinearMass(EwErrorCode *errorCode)
Get the linear mass (density) of this wire.
IEwProjectWireX::getTagNumber
long getTagNumber(EwErrorCode *errorCode)
Get the mark number of this object.
IEwProjectWireX::setDiameter
EwErrorCode setDiameter(DOUBLE dValue)
Set the diameter of this wire.
IEwProjectWireX::getWireSizeStandard
EwWireSizeStandard getWireSizeStandard(EwErrorCode *errorCode)
Get the wire size standard enum type of this wire.
IEwProjectWireX::getDiameter
DOUBLE getDiameter(EwErrorCode *errorCode)
Get the diameter of this wire.
IEwProjectWireX::getCableID
LONG getCableID(EwErrorCode *errorCode)
Get the cable ID associated to the current wire.
Generated on Thu Aug 25 2022 16:02:38 for SOLIDWORKS Electrical API by doxygen 1.9.4


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

0.20.21