Hide Table of Contents
SOLIDWORKS Electrical API 2023.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 */
33 EwErrorCode setLength (DOUBLE dLength);
34
35
43 BSTR getArticleNumber (EwErrorCode* errorCode);
44
45
53 EwErrorCode setArticleNumber (BSTR strArticleNumber);
54
55
63 BSTR getManufacturer (EwErrorCode* errorCode);
64
65
73 BSTR getReference (EwErrorCode* errorCode);
74
75
84 LONG getCoreCount (EwErrorCode* errorCode);
85
86
98 EwErrorCode setCoreStubs (LONG nCoreIdx, DOUBLE dStubLengthFrom, DOUBLE dStubLengthTo);
99
100
109 BSTR getExternalID (EwErrorCode* errorCode);
110
111
120 EwErrorCode setExternalID (BSTR strExternalID);
121
122
131 BSTR getLinearMass (EwErrorCode* errorCode);
132
133
143 EwErrorCode setLinearMass (BSTR strLinearMass);
144
145
159 EwErrorCode setHarnessID (long lHarnessID);
160
161
171 LONG getHarnessID (EwErrorCode* errorCode);
172
173
183 DOUBLE getVoltageDrop (EwErrorCode* errorCode);
184
185
195 EwErrorCode setVoltageDrop (DOUBLE dVoltageDrop);
196
197
207 EwErrorCode setFamily (BSTR strFamily);
208
209
219 BSTR getFamily (EwErrorCode* errorCode);
220
221
231 EwErrorCode setSupplierName (BSTR strSupplierName);
232
233
243 BSTR getSupplierName (EwErrorCode* errorCode);
244
245
257 EwErrorCode setDiameter (DOUBLE dDiameter);
258
259
269 DOUBLE getDiameter (EwErrorCode* errorCode);
270
271
282 EwErrorCode setBendRadius (DOUBLE dBendRadius);
283
284
294 DOUBLE getBendRadius (EwErrorCode* errorCode);
295
296
306 EwErrorCode setStockNumber (BSTR strStockNumber);
307
308
318 BSTR getStockNumber (EwErrorCode* errorCode);
319
320
330 EwErrorCode set3dOrigin (BSTR str3dOrigin);
331
332
342 BSTR get3dOrigin (EwErrorCode* errorCode);
343
344
354 EwErrorCode set3dDestination (BSTR str3dDestination);
355
356
366 BSTR get3dDestination (EwErrorCode* errorCode);
367
368
378 EwErrorCode setDoCalculation (VARIANT_BOOL bDoCalculation);
379
380
392 VARIANT_BOOL getDoCalculation (EwErrorCode* errorCode);
393
394
404 EwErrorCode setStandard (BSTR strStandard);
405
406
416 BSTR getStandard (EwErrorCode* errorCode);
417
418
428 EwErrorCode setAppliedVoltage (DOUBLE dAppliedVoltage);
429
430
440 DOUBLE getAppliedVoltage (EwErrorCode* errorCode);
441
442
452 EwErrorCode setFullLoadCurrent (DOUBLE dFullLoadCurrent);
453
454
464 DOUBLE getFullLoadCurrent (EwErrorCode* errorCode);
465
466
476 EwErrorCode setInRushFactor (DOUBLE dInRushFactor);
477
478
488 DOUBLE getInRushFactor (EwErrorCode* errorCode);
489
490
501 EwErrorCode setUpStreamLocationID (LONG lUpStreamLocationID);
502
503
514
515
526 EwErrorCode setDownStreamLocationID (LONG lDownStreamLocationID);
527
528
539
540
551 EwErrorCode setFunctionID (LONG lFunctionID);
552
553
563 LONG getFunctionID (EwErrorCode* errorCode);
564
565
574 BSTR getColorCode (EwErrorCode* errorCode);
575
576
585 EwErrorCode setColorCode (BSTR strColorCode);
586
587
588};
589
594[
595 object,
596 uuid(5E7EE771-FFA6-4959-B3A6-09E8FED6F813),
597 dual,
598 nonextensible,
599 pointer_default(unique)
600]
601interface IEwProjectCableManagerX : IDispatch{
611
612
618
619
628
629
637 LONG getCount (EwErrorCode* errorCode);
638
639
648 VARIANT selectCables (EwErrorCode* errorCode);
649
650};
EwErrorCode
All errors codes for this API.
Definition: EnumDefinition.idl:21
Use this interface to manage cables of a project.
Definition: EwProjectCableObjects.idl:601
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.
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.
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.
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) 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.