Hide Table of Contents
SOLIDWORKS Electrical API 2025.0.0
Electrical API
EwProjectCableObjects.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";
11
12import "EwObjectBaseObjects.idl";
13
18[
19 object,
20 uuid(60A0873B-AFFB-47CB-91B4-4F94D860672B),
21 dual,
22 nonextensible,
23 pointer_default(unique)
24]
26{
27 /*
28 * Set the cable length value.
29 * \return EwErrorCode enum type, can be:
30 * \li EW_NO_ERROR if no error detected
31 * \li EW_UNDEFINED_ERROR if another error occurred
32 * \li EW_BAD_INPUTS if the dLength is invalid (if is < 0)
33 */
34 EwErrorCode setLength (DOUBLE dLength);
35
36
44 BSTR getArticleNumber (EwErrorCode* errorCode);
45
46
54 EwErrorCode setArticleNumber (BSTR strArticleNumber);
55
56
64 BSTR getManufacturer (EwErrorCode* errorCode);
65
66
74 BSTR getReference (EwErrorCode* errorCode);
75
76
85 LONG getCoreCount (EwErrorCode* errorCode);
86
87
99 EwErrorCode setCoreStubs (LONG nCoreIdx, DOUBLE dStubLengthFrom, DOUBLE dStubLengthTo);
100
101
110 BSTR getExternalID (EwErrorCode* errorCode);
111
112
121 EwErrorCode setExternalID (BSTR strExternalID);
122
123
132 BSTR getLinearMass (EwErrorCode* errorCode);
133
134
144 EwErrorCode setLinearMass (BSTR strLinearMass);
145
146
160 EwErrorCode setHarnessID (long lHarnessID);
161
162
172 LONG getHarnessID (EwErrorCode* errorCode);
173
174
184 DOUBLE getVoltageDrop (EwErrorCode* errorCode);
185
186
196 EwErrorCode setVoltageDrop (DOUBLE dVoltageDrop);
197
198
208 EwErrorCode setFamily (BSTR strFamily);
209
210
220 BSTR getFamily (EwErrorCode* errorCode);
221
222
232 EwErrorCode setSupplierName (BSTR strSupplierName);
233
234
244 BSTR getSupplierName (EwErrorCode* errorCode);
245
246
258 EwErrorCode setDiameter (DOUBLE dDiameter);
259
260
270 DOUBLE getDiameter (EwErrorCode* errorCode);
271
272
283 EwErrorCode setBendRadius (DOUBLE dBendRadius);
284
285
295 DOUBLE getBendRadius (EwErrorCode* errorCode);
296
297
307 EwErrorCode setStockNumber (BSTR strStockNumber);
308
309
319 BSTR getStockNumber (EwErrorCode* errorCode);
320
321
331 EwErrorCode set3dOrigin (BSTR str3dOrigin);
332
333
343 BSTR get3dOrigin (EwErrorCode* errorCode);
344
345
355 EwErrorCode set3dDestination (BSTR str3dDestination);
356
357
367 BSTR get3dDestination (EwErrorCode* errorCode);
368
369
379 EwErrorCode setDoCalculation (VARIANT_BOOL bDoCalculation);
380
381
393 VARIANT_BOOL getDoCalculation (EwErrorCode* errorCode);
394
395
405 EwErrorCode setStandard (BSTR strStandard);
406
407
417 BSTR getStandard (EwErrorCode* errorCode);
418
419
429 EwErrorCode setAppliedVoltage (DOUBLE dAppliedVoltage);
430
431
441 DOUBLE getAppliedVoltage (EwErrorCode* errorCode);
442
443
453 EwErrorCode setFullLoadCurrent (DOUBLE dFullLoadCurrent);
454
455
465 DOUBLE getFullLoadCurrent (EwErrorCode* errorCode);
466
467
477 EwErrorCode setInRushFactor (DOUBLE dInRushFactor);
478
479
489 DOUBLE getInRushFactor (EwErrorCode* errorCode);
490
491
502 EwErrorCode setUpStreamLocationID (LONG lUpStreamLocationID);
503
504
515
516
527 EwErrorCode setDownStreamLocationID (LONG lDownStreamLocationID);
528
529
540
541
552 EwErrorCode setFunctionID (LONG lFunctionID);
553
554
564 LONG getFunctionID (EwErrorCode* errorCode);
565
566
575 BSTR getColorCode (EwErrorCode* errorCode);
576
577
586 EwErrorCode setColorCode (BSTR strColorCode);
587
588
598 VARIANT_BOOL getIsFixedLength (EwErrorCode* errorCode);
599
600
610 EwErrorCode setIsFixedLength (VARIANT_BOOL bIsFixedLength);
611
612
621 DOUBLE getLength (EwErrorCode* errorCode);
622
623};
624
629[
630 object,
631 uuid(5E7EE771-FFA6-4959-B3A6-09E8FED6F813),
632 dual,
633 nonextensible,
634 pointer_default(unique)
635]
636interface IEwProjectCableManagerX : IDispatch{
646
647
653
654
663
664
672 LONG getCount (EwErrorCode* errorCode);
673
674
683 VARIANT selectCables (EwErrorCode* errorCode);
684
685};
EwErrorCode
All errors codes for this API.
Definition: EnumDefinition.idl:24
Use this interface to manage cables of a project.
Definition: EwProjectCableObjects.idl:636
VARIANT selectCables(EwErrorCode *errorCode)
Invoke cable selection dialog.
VARIANT getEwProjectCableArray(EwErrorCode *errorCode)
Get all the cables in the manager project.
IEwProjectCableX findEwProjectCableByID(LONG lCableID, EwErrorCode *errorCode)
Find a cable in the project with the target ID.
IEwProjectCableX newEwProjectCable()
Create an IEwProjectCableX object from the associated project.
LONG getCount(EwErrorCode *errorCode)
return the number of cables of associated project
Use this interface to manage a cable inside a project.
Definition: EwProjectCableObjects.idl:26
VARIANT_BOOL getDoCalculation(EwErrorCode *errorCode)
Get the calculation associated with the current cable.
DOUBLE getBendRadius(EwErrorCode *errorCode)
Get the bend radius associated with the current cable.
EwErrorCode setDiameter(DOUBLE dDiameter)
Set the diameter associated with the current cable.
BSTR getReference(EwErrorCode *errorCode)
Get the reference of the cable.
EwErrorCode setBendRadius(DOUBLE dBendRadius)
Set the bend radius associated with the current cable.
BSTR getSupplierName(EwErrorCode *errorCode)
Get the supplier name associated with the current cable.
BSTR getStockNumber(EwErrorCode *errorCode)
Get the stock number associated with the current cable.
EwErrorCode setVoltageDrop(DOUBLE dVoltageDrop)
Set the voltage drop associated with the current cable.
BSTR getManufacturer(EwErrorCode *errorCode)
Get the manufacturer of the cable.
BSTR get3dDestination(EwErrorCode *errorCode)
Get the 3D Destination associated with the current cable.
BSTR get3dOrigin(EwErrorCode *errorCode)
Get the 3D Orign associated with the current cable.
EwErrorCode setFunctionID(LONG lFunctionID)
Set the function ID associated with the current cable.
EwErrorCode setCoreStubs(LONG nCoreIdx, DOUBLE dStubLengthFrom, DOUBLE dStubLengthTo)
Set lengths of cable core stubs.
EwErrorCode setLinearMass(BSTR strLinearMass)
Set the linear mass (density) of this cable.
EwErrorCode setDoCalculation(VARIANT_BOOL bDoCalculation)
Set the calculation associated with the current cable.
EwErrorCode setArticleNumber(BSTR strArticleNumber)
Set the article number.
DOUBLE getFullLoadCurrent(EwErrorCode *errorCode)
Get the full load current associated with the current cable.
EwErrorCode setFamily(BSTR strFamily)
Set the family associated with the current cable.
LONG getCoreCount(EwErrorCode *errorCode)
Get cable core count.
VARIANT_BOOL getIsFixedLength(EwErrorCode *errorCode)
Get if the cable length is fixed.
DOUBLE getInRushFactor(EwErrorCode *errorCode)
Get the rush factor associated with the current cable.
BSTR getArticleNumber(EwErrorCode *errorCode)
Get the article number.
EwErrorCode setColorCode(BSTR strColorCode)
Set the color code of this cable.
BSTR getExternalID(EwErrorCode *errorCode)
Get external identifier of this cable.
EwErrorCode set3dOrigin(BSTR str3dOrigin)
Set the 3D Orign associated with the current cable.
EwErrorCode set3dDestination(BSTR str3dDestination)
Set the 3D destination associated with the current cable.
EwErrorCode setUpStreamLocationID(LONG lUpStreamLocationID)
Set the up stream location associated with the current cable.
EwErrorCode setStandard(BSTR strStandard)
Set the standard associated with the current cable.
LONG getFunctionID(EwErrorCode *errorCode)
Get the function ID associated with the current cable.
EwErrorCode setSupplierName(BSTR strSupplierName)
Set the supplier name associated with the current cable.
DOUBLE getVoltageDrop(EwErrorCode *errorCode)
Get the voltage drop associated with the current cable.
LONG getHarnessID(EwErrorCode *errorCode)
Get the Harness ID associated with the current cable.
DOUBLE getAppliedVoltage(EwErrorCode *errorCode)
Get the applied voltage associated with the current cable.
EwErrorCode setLength(DOUBLE dLength)
EwErrorCode setExternalID(BSTR strExternalID)
Set the external identifier of this cable.
EwErrorCode setDownStreamLocationID(LONG lDownStreamLocationID)
Set the down stream location associated with the current cable.
EwErrorCode setAppliedVoltage(DOUBLE dAppliedVoltage)
Set the applied voltage associated with the current cable.
EwErrorCode setInRushFactor(DOUBLE dInRushFactor)
Set the rush factor associated with the current cable.
LONG getDownStreamLocationID(EwErrorCode *errorCode)
Get the down stream location associated with the current cable.
BSTR getStandard(EwErrorCode *errorCode)
Get the standard associated with the current cable.
BSTR getFamily(EwErrorCode *errorCode)
Get the family associated with the current cable.
DOUBLE getLength(EwErrorCode *errorCode)
Get the cable length value.
EwErrorCode setFullLoadCurrent(DOUBLE dFullLoadCurrent)
Set the full load current associated with the current cable.
EwErrorCode setHarnessID(long lHarnessID)
Set the Harness ID of this cable.
LONG getUpStreamLocationID(EwErrorCode *errorCode)
Get the up stream location associated with the current cable.
DOUBLE getDiameter(EwErrorCode *errorCode)
Get the diameter associated with the current cable.
BSTR getLinearMass(EwErrorCode *errorCode)
Get the linear mass (density) of this cable.
EwErrorCode setIsFixedLength(VARIANT_BOOL bIsFixedLength)
Set if the cable length is fixed.
BSTR getColorCode(EwErrorCode *errorCode)
Get the color code of this cable.
EwErrorCode setStockNumber(BSTR strStockNumber)
Set the stock number associated with the current cable.
Generic interface for an object that belongs to a project.
Definition: EwObjectBaseObjects.idl:118


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/EwProjectCableObjects.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) 2025 SP2

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.