Hide Table of Contents
SOLIDWORKS Electrical API  2021.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 
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 
247 
248 
249 
250 
251 
261  EwErrorCode setStockNumber (BSTR strStockNumber);
262 
263 
273  BSTR getStockNumber (EwErrorCode* errorCode);
274 
275 
285  EwErrorCode set3dOrigin (BSTR str3dOrigin);
286 
287 
297  BSTR get3dOrigin (EwErrorCode* errorCode);
298 
299 
309  EwErrorCode set3dDestination (BSTR str3dDestination);
310 
311 
321  BSTR get3dDestination (EwErrorCode* errorCode);
322 
323 
324 
325 
335  EwErrorCode setStandard (BSTR strStandard);
336 
337 
347  BSTR getStandard (EwErrorCode* pErrorCode);
348 
349 
359  EwErrorCode setAppliedVoltage (DOUBLE dAppliedVoltage);
360 
361 
371  DOUBLE getAppliedVoltage (EwErrorCode* errorCode);
372 
373 
383  EwErrorCode setFullLoadCurrent (DOUBLE dFullLoadCurrent);
384 
385 
395  DOUBLE getFullLoadCurrent (EwErrorCode* errorCode);
396 
397 
407  EwErrorCode setInRushFactor (DOUBLE dInRushFactor);
408 
409 
410 
411 
412 
413 
414 
415 
416 };
417 
422 [
423  object,
424  uuid(5E7EE771-FFA6-4959-B3A6-09E8FED6F813),
425  dual,
426  nonextensible,
427  pointer_default(unique)
428 ]
429 interface IEwProjectCableManagerX : IDispatch{
438  IEwProjectCableX findEwProjectCableByID (LONG lCableID, EwErrorCode* errorCode);
439 
440 
445  IEwProjectCableX newEwProjectCable ();
446 
447 
455  VARIANT getEwProjectCableArray (EwErrorCode* errorCode);
456 
457 
465  LONG getCount (EwErrorCode* errorCode);
466 
467 
476  VARIANT selectCables (EwErrorCode* errorCode);
477 
478 };
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:429
IEwProjectCableManagerX::findEwProjectCableByID
IEwProjectCableX findEwProjectCableByID(LONG lCableID, EwErrorCode *errorCode)
Find a cable in the project with the target ID.
IEwProjectTagObjectX
Generic interface for an object that belongs to a project.
Definition: EwObjectBase.idl:76
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::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::getArticleNumber
BSTR getArticleNumber(EwErrorCode *errorCode)
Get the article number.
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::setFamily
EwErrorCode setFamily(BSTR strFamily)
Set the family 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::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.
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::setSupplierName
EwErrorCode setSupplierName(BSTR strSupplierName)
Set the supplier name associated with the current 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.
Generated on Thu Aug 20 2020 08:40:14 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) 2021 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