Hide Table of Contents
SOLIDWORKS Electrical API  2022.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 
7 import "oaidl.idl";
8 import "ocidl.idl";
9 
10 import "EnumDefinition.idl";
11 
12 import "EwObjectBase.idl";
13 
18 [
19  object,
20  uuid(60A0873B-AFFB-47CB-91B4-4F94D860672B),
21  dual,
22  nonextensible,
23  pointer_default(unique)
24 ]
25 interface IEwProjectCableX : IEwProjectTagObjectX
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* pErrorCode);
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 
513  LONG getUpStreamLocationID (EwErrorCode* errorCode);
514 
515 
526  EwErrorCode setDownStreamLocationID (LONG lDownStreamLocationID);
527 
528 
538  LONG getDownStreamLocationID (EwErrorCode* errorCode);
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 ]
601 interface IEwProjectCableManagerX : IDispatch{
610  IEwProjectCableX findEwProjectCableByID (LONG lCableID, EwErrorCode* errorCode);
611 
612 
617  IEwProjectCableX newEwProjectCable ();
618 
619 
627  VARIANT getEwProjectCableArray (EwErrorCode* errorCode);
628 
629 
637  LONG getCount (EwErrorCode* errorCode);
638 
639 
648  VARIANT selectCables (EwErrorCode* errorCode);
649 
650 };
IEwProjectCableX::setVoltageDrop
EwErrorCode setVoltageDrop(DOUBLE dVoltageDrop)
Set the voltage drop associated with the current cable.
IEwProjectCableManagerX::getEwProjectCableArray
VARIANT getEwProjectCableArray(EwErrorCode *errorCode)
Get all the cables in the manager project.
IEwProjectCableManagerX
Use this interface to manage cables of a project.
Definition: EwProjectCableObjects.idl:601
IEwProjectCableManagerX::findEwProjectCableByID
IEwProjectCableX findEwProjectCableByID(LONG lCableID, EwErrorCode *errorCode)
Find a cable in the project with the target ID.
IEwProjectCableX::setFunctionID
EwErrorCode setFunctionID(LONG lFunctionID)
Set the function ID associated with the current cable.
IEwProjectTagObjectX
Generic interface for an object that belongs to a project.
Definition: EwObjectBase.idl:103
IEwProjectCableX::setDoCalculation
EwErrorCode setDoCalculation(VARIANT_BOOL bDoCalculation)
Set the calculation associated with the current cable.
IEwProjectCableX::set3dDestination
EwErrorCode set3dDestination(BSTR str3dDestination)
Set the 3D destination associated with the current cable.
IEwProjectCableX::getFamily
BSTR getFamily(EwErrorCode *errorCode)
Get the family associated with the current cable.
EwErrorCode
EwErrorCode
All errors codes for this API.
Definition: EnumDefinition.idl:21
IEwProjectCableX::setLength
EwErrorCode setLength(DOUBLE dLength)
IEwProjectCableX::setLinearMass
EwErrorCode setLinearMass(BSTR strLinearMass)
Set the linear mass (density) of this cable.
IEwProjectCableX::setUpStreamLocationID
EwErrorCode setUpStreamLocationID(LONG lUpStreamLocationID)
Set the up stream location associated with the current cable.
IEwProjectCableX::getColorCode
BSTR getColorCode(EwErrorCode *errorCode)
Get the color code of this cable.
IEwProjectCableX::getDownStreamLocationID
LONG getDownStreamLocationID(EwErrorCode *errorCode)
Get the down stream location associated with the current cable.
IEwProjectCableX::getLinearMass
BSTR getLinearMass(EwErrorCode *errorCode)
Get the linear mass (density) of this cable.
IEwProjectCableX::getReference
BSTR getReference(EwErrorCode *errorCode)
Get the reference of the cable.
IEwProjectCableX::setDiameter
EwErrorCode setDiameter(DOUBLE dDiameter)
Set the diameter associated with the current cable.
IEwProjectCableX::getArticleNumber
BSTR getArticleNumber(EwErrorCode *errorCode)
Get the article number.
IEwProjectCableX::getInRushFactor
DOUBLE getInRushFactor(EwErrorCode *errorCode)
Get the rush factor associated with the current cable.
IEwProjectCableX::setDownStreamLocationID
EwErrorCode setDownStreamLocationID(LONG lDownStreamLocationID)
Set the down stream location associated with the current cable.
IEwProjectCableX::get3dDestination
BSTR get3dDestination(EwErrorCode *errorCode)
Get the 3D Destination associated with the current cable.
IEwProjectCableX::getStandard
BSTR getStandard(EwErrorCode *pErrorCode)
Get the standard associated with the current cable.
IEwProjectCableX::getUpStreamLocationID
LONG getUpStreamLocationID(EwErrorCode *errorCode)
Get the up stream location associated with the current cable.
IEwProjectCableX::setFamily
EwErrorCode setFamily(BSTR strFamily)
Set the family associated with the current cable.
IEwProjectCableX::getDoCalculation
VARIANT_BOOL getDoCalculation(EwErrorCode *errorCode)
Get the calculation associated with the current cable.
IEwProjectCableX::setHarnessID
EwErrorCode setHarnessID(long lHarnessID)
Set the Harness ID of this cable.
IEwProjectCableManagerX::newEwProjectCable
IEwProjectCableX newEwProjectCable()
Create an IEwProjectCableX object from the associated project.
IEwProjectCableX
Use this interface to manage a cable inside a project.
Definition: EwProjectCableObjects.idl:26
IEwProjectCableX::getDiameter
DOUBLE getDiameter(EwErrorCode *errorCode)
Get the diameter associated with the current cable.
IEwProjectCableX::getStockNumber
BSTR getStockNumber(EwErrorCode *errorCode)
Get the stock number associated with the current cable.
IEwProjectCableX::get3dOrigin
BSTR get3dOrigin(EwErrorCode *errorCode)
Get the 3D Orign associated with the current cable.
IEwProjectCableX::getCoreCount
LONG getCoreCount(EwErrorCode *errorCode)
Get cable core count.
IEwProjectCableX::getExternalID
BSTR getExternalID(EwErrorCode *errorCode)
Get external identifier of this cable.
IEwProjectCableX::getBendRadius
DOUBLE getBendRadius(EwErrorCode *errorCode)
Get the bend radius associated with the current cable.
IEwProjectCableManagerX::getCount
LONG getCount(EwErrorCode *errorCode)
return the number of cables of associated project
IEwProjectCableX::getHarnessID
LONG getHarnessID(EwErrorCode *errorCode)
Get the Harness ID associated with the current cable.
IEwProjectCableX::setStandard
EwErrorCode setStandard(BSTR strStandard)
Set the standard associated with the current cable.
IEwProjectCableX::setAppliedVoltage
EwErrorCode setAppliedVoltage(DOUBLE dAppliedVoltage)
Set the applied voltage associated with the current cable.
IEwProjectCableX::setFullLoadCurrent
EwErrorCode setFullLoadCurrent(DOUBLE dFullLoadCurrent)
Set the full load current associated with the current cable.
IEwProjectCableX::getVoltageDrop
DOUBLE getVoltageDrop(EwErrorCode *errorCode)
Get the voltage drop associated with the current cable.
IEwProjectCableX::getFullLoadCurrent
DOUBLE getFullLoadCurrent(EwErrorCode *errorCode)
Get the full load current associated with the current cable.
IEwProjectCableX::getAppliedVoltage
DOUBLE getAppliedVoltage(EwErrorCode *errorCode)
Get the applied voltage associated with the current cable.
IEwProjectCableX::getManufacturer
BSTR getManufacturer(EwErrorCode *errorCode)
Get the manufacturer of the cable.
IEwProjectCableX::setExternalID
EwErrorCode setExternalID(BSTR strExternalID)
Set the external identifier of this cable.
IEwProjectCableX::set3dOrigin
EwErrorCode set3dOrigin(BSTR str3dOrigin)
Set the 3D Orign associated with the current cable.
IEwProjectCableX::getSupplierName
BSTR getSupplierName(EwErrorCode *errorCode)
Get the supplier name associated with the current cable.
IEwProjectCableX::setBendRadius
EwErrorCode setBendRadius(DOUBLE dBendRadius)
Set the bend radius associated with the current cable.
IEwProjectCableX::setSupplierName
EwErrorCode setSupplierName(BSTR strSupplierName)
Set the supplier name associated with the current cable.
IEwProjectCableX::setColorCode
EwErrorCode setColorCode(BSTR strColorCode)
Set the color code of this cable.
IEwProjectCableX::setStockNumber
EwErrorCode setStockNumber(BSTR strStockNumber)
Set the stock number associated with the current cable.
IEwProjectCableManagerX::selectCables
VARIANT selectCables(EwErrorCode *errorCode)
Invoke cable selection dialog.
IEwProjectCableX::setArticleNumber
EwErrorCode setArticleNumber(BSTR strArticleNumber)
Set the article number.
IEwProjectCableX::setCoreStubs
EwErrorCode setCoreStubs(LONG nCoreIdx, DOUBLE dStubLengthFrom, DOUBLE dStubLengthTo)
Set lengths of cable core stubs.
IEwProjectCableX::setInRushFactor
EwErrorCode setInRushFactor(DOUBLE dInRushFactor)
Set the rush factor associated with the current cable.
IEwProjectCableX::getFunctionID
LONG getFunctionID(EwErrorCode *errorCode)
Get the function ID associated with the current cable.
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/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) 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.46