Hide Table of Contents
SOLIDWORKS Electrical API 2024.0.0
Electrical API
EwCableObjects.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";
11import "EwClassificationObjects.idl";
12
13
14/************************************************************************/
15/* In his file, all CABLE object */
16/************************************************************************/
17
18/************************************************************************/
19/* ENUMERATION */
20/************************************************************************/
21
22
23/************************************************************************/
24/* INTERFACES */
25/************************************************************************/
26
31[
32 object,
33 uuid(8061C6A3-CDC3-4000-B1E8-DF811FE93EE7),
34 dual,
35 oleautomation,
36 nonextensible,
37 helpstring("IEwCableCoreX Interface"),
38 pointer_default(unique)
39]
40interface IEwCableCoreX : IDispatch{
41
42
43
48 LONG getNumber ();
49
50
60 BSTR getDescription (BSTR lgCode, EwErrorCode* errorCode);
61
62
72 EwErrorCode setDescription (BSTR lgCode, BSTR strValue);
73
74
83
84
93
94
102 DOUBLE getSection (EwErrorCode* errorCode);
103
104
113 EwErrorCode setSection (DOUBLE dSection);
114
115
123 BSTR getGroup (EwErrorCode* errorCode);
124
125
133 EwErrorCode setGroup (BSTR strGroup);
134
135
143 BSTR getGauge (EwErrorCode* errorCode);
144
145
153 EwErrorCode setGauge (BSTR strGauge);
154
155
163 BSTR getColorCode (EwErrorCode* errorCode);
164
165
173 EwErrorCode setColorCode (BSTR strColorCode);
174
175
184 DOUBLE getDiameter (EwErrorCode* errorCode);
185
186
196 EwErrorCode setDiameter (DOUBLE dDiameter);
197
198
199};
200
205[
206 object,
207 uuid(59A07E7E-D6B9-4D71-92A3-009916908E54),
208 dual,
209 oleautomation,
210 nonextensible,
211 helpstring("IEwCableReferenceX Interface"),
212 pointer_default(unique)
213]
215{
225
226
237
238
244
245
257
258
269 BSTR getDescription (BSTR lgCode, EwErrorCode* errorCode);
270
271
282 EwErrorCode setDescription (BSTR lgCode, BSTR strValue);
283
284
293 BSTR getReference (EwErrorCode* errorCode);
294
295
305 EwErrorCode setReference (BSTR strReference);
306
307
316 BSTR getManufacturer (EwErrorCode* errorCode);
317
318
327 EwErrorCode setManufacturer (BSTR strManufacturer);
328
329
338 BSTR getArticleNumber (EwErrorCode* errorCode);
339
340
349 EwErrorCode setArticleNumber (BSTR strArticleNumber);
350
351
361 LONG getClassNodeID (EwErrorCode* errorCode);
362
363
374
375
384 BSTR getLibraryCode (EwErrorCode* errorCode);
385
386
395 EwErrorCode setLibraryCode (BSTR strLibraryCode);
396
397
406 BSTR getFamily (EwErrorCode* errorCode);
407
408
417 EwErrorCode setFamily (BSTR strFamily);
418
419
428 BSTR getStandard (EwErrorCode* errorCode);
429
430
439 EwErrorCode setStandard (BSTR strStandard);
440
441
450 BSTR getSerie (EwErrorCode* errorCode);
451
452
461 BSTR getSupplierName (EwErrorCode* errorCode);
462
463
472 EwErrorCode setSupplierName (BSTR strSupplierName);
473
474
483 BSTR getStockNumber (EwErrorCode* errorCode);
484
485
494 EwErrorCode setStockNumber (BSTR strStockNumber);
495
496
507
508
518
519
529
530
540
541
551
552
562 DOUBLE getSection (EwErrorCode* errorCode);
563
564
575 EwErrorCode setSection (DOUBLE dSection);
576
577
586 DOUBLE getDiameter (EwErrorCode* errorCode);
587
588
598 EwErrorCode setDiameter (DOUBLE dDiameter);
599
600
609 BSTR getColorCode (EwErrorCode* errorCode);
610
611
620 EwErrorCode setColorCode (BSTR strColorCode);
621
622
631 DOUBLE getBendRadius (EwErrorCode* errorCode);
632
633
643 EwErrorCode setBendRadius (DOUBLE dBendRadius);
644
645
654 DOUBLE getVoltageDrop (EwErrorCode* errorCode);
655
656
666 EwErrorCode setVoltageDrop (DOUBLE dVoltageDrop);
667
668
669
679 BSTR getGauge (EwErrorCode* errorCode);
680
681
691 EwErrorCode setGauge (BSTR strGauge);
692
693
703 BSTR getExternalID (EwErrorCode* errorCode);
704
705
715 EwErrorCode setExternalID (BSTR strExternalID);
716
717
727 BSTR getLinearMass (EwErrorCode* errorCode);
728
729
740 EwErrorCode setLinearMass (BSTR strLinearMass);
741
742
754 EwErrorCode setUserData (LONG nUserDataNumber, BSTR strValue);
755
756
768 BSTR getUserData (LONG nUserDataNumber, EwErrorCode* errorCode);
769
770
771
781 DOUBLE getCoreDiameter (EwErrorCode* errorCode);
782
783
794 EwErrorCode setCoreDiameter (DOUBLE dCoreDiameter);
795
796
808
809
821 LONG getClassID (EwErrorCode* errorCode);
822
823
835
836
849
850};
851
856[
857 object,
858 uuid(1F2276D3-B358-40C8-84E2-F8BDED5BF8BF),
859 dual,
860 oleautomation,
861 nonextensible,
862 helpstring("IEwCableReferenceManagerX Interface"),
863 pointer_default(unique)
864]
865interface IEwCableReferenceManagerX : IDispatch
866{
872
873
877 LONG getCount ();
878
879
884
885
890 IEwCableReferenceFiltersX newEwCableReferenceFilters ();
891
892
902 IEwCableReferenceX findByManufacturerAndReference (BSTR strManufacturer, BSTR strReference , EwErrorCode* errorCode);
903
904
905};
EwErrorCode
All errors codes for this API.
Definition: EnumDefinition.idl:24
EwWireSizeStandard
Wire size standard type.
Definition: EwEnumeration.idl:639
EwCableCoreType
Cable Core type.
Definition: EwEnumeration.idl:652
EwCableReferenceType
Cable reference type.
Definition: EwEnumeration.idl:626
EwCreatorType
All creator type.
Definition: EwEnumeration.idl:271
Use this interface to manage a cable core inside a cable reference.
Definition: EwCableObjects.idl:40
DOUBLE getDiameter(EwErrorCode *errorCode)
Get the diameter of this cable core.
EwErrorCode setEwCableCoreType(EwCableCoreType eCableCoreType)
Set the type of cable core.
LONG getNumber()
Get the number of this cable core.
EwErrorCode setColorCode(BSTR strColorCode)
Set the color code of this cable core.
EwErrorCode setDescription(BSTR lgCode, BSTR strValue)
Set a description of this cable core.
BSTR getDescription(BSTR lgCode, EwErrorCode *errorCode)
Get a description of this cable core.
EwErrorCode setDiameter(DOUBLE dDiameter)
Set the diameter of this cable core.
BSTR getColorCode(EwErrorCode *errorCode)
Get the color code of this cable core.
EwErrorCode setGauge(BSTR strGauge)
Set the gauge of this cable core.
BSTR getGroup(EwErrorCode *errorCode)
Get the group of this cable core.
BSTR getGauge(EwErrorCode *errorCode)
Get the gauge of this cable core.
DOUBLE getSection(EwErrorCode *errorCode)
Get the section of this cable core.
EwErrorCode setGroup(BSTR strGroup)
Set the group of this cable core.
EwErrorCode setSection(DOUBLE dSection)
Set the section of this cable core.
EwCableCoreType getEwCableCoreType(EwErrorCode *errorCode)
Get the type of cable core.
Use this interface to manage EwCableReferenceX objects.
Definition: EwCableObjects.idl:866
IEwCableReferenceFiltersX newEwCableReferenceFilters()
Create an IEwCableReferenceFiltersX interface to filter on cable references (IEwCableReferenceX) of a...
VARIANT getEwCableReferenceArray(EwErrorCode *errorCode)
return the array of IEwCableReferenceX of associated environment
IEwCableReferenceX findByManufacturerAndReference(BSTR strManufacturer, BSTR strReference, EwErrorCode *errorCode)
Return an IEWCableReference according to the manufacturer name and the reference.
IEwCableReferenceX newEwCableReference()
Create a IEwCableReferenceX object from the associated environnement.
Use this interface to manage cable reference.
Definition: EwCableObjects.idl:215
IEwCableCoreX getEwCableCoreAt(LONG index, EwErrorCode *errorCode)
Get a cable core inside this cable reference.
EwErrorCode setCoreDiameter(DOUBLE dCoreDiameter)
Set outside diameter of cable core (mm).
EwErrorCode setBendRadius(DOUBLE dBendRadius)
Set the bend radius of this cable reference.
EwErrorCode setSection(DOUBLE dSection)
Set the section of this cable reference.
EwErrorCode setLinearMass(BSTR strLinearMass)
Set the linear mass (density) of this cable.
EwErrorCode setReference(BSTR strReference)
Set a reference of this cable reference.
BSTR getManufacturer(EwErrorCode *errorCode)
Get a manufacturer of this cable reference.
IEwClassificationX getClassification(EwErrorCode *errorCode)
Get the classification of the current cable reference.
LONG getClassID(EwErrorCode *errorCode)
Get the class ID of cable reference.
BSTR getColorCode(EwErrorCode *errorCode)
Get the color code of this cable reference.
DOUBLE getBendRadius(EwErrorCode *errorCode)
Get the bend radius of this cable reference.
EwErrorCode setVoltageDrop(DOUBLE dVoltageDrop)
Set the voltage drop of this cable reference.
DOUBLE getDiameter(EwErrorCode *errorCode)
Get the diameter of this cable reference.
DOUBLE getVoltageDrop(EwErrorCode *errorCode)
Get the voltage drop of this cable reference.
EwErrorCode setFamily(BSTR strFamily)
Set a library of this cable reference.
EwErrorCode setLibraryCode(BSTR strLibraryCode)
Set a library code of this cable reference.
DOUBLE getCoreDiameter(EwErrorCode *errorCode)
Get the outside diameter of cable core (mm).
EwErrorCode setArticleNumber(BSTR strArticleNumber)
Set an article number of this cable reference.
BSTR getLibraryCode(EwErrorCode *errorCode)
Get a library code of this cable reference.
EwErrorCode setDescription(BSTR lgCode, BSTR strValue)
Set a description of this cable reference.
LONG getClassNodeID(EwErrorCode *errorCode)
LONG getCableCoreCount()
Count the number of cable core in this cable reference.
BSTR getSupplierName(EwErrorCode *errorCode)
Get a supplier name of this cable reference.
BSTR getLinearMass(EwErrorCode *errorCode)
Get the linear mass (density) of this cable.
BSTR getFamily(EwErrorCode *errorCode)
Get a family of this cable reference.
BSTR getReference(EwErrorCode *errorCode)
Get a reference of this cable reference.
EwCableReferenceType getCableType(EwErrorCode *errorCode)
Get a cable type of this cable reference.
EwErrorCode setGauge(BSTR strGauge)
Set the gauge of this cable reference.
EwErrorCode setStandard(BSTR strStandard)
Set a standard of this cable reference.
EwErrorCode setExternalID(BSTR strExternalID)
Set the external identifier of this cable reference.
EwErrorCode setSupplierName(BSTR strSupplierName)
Set a supplier name of this cable reference.
IEwCableCoreX addEwCableCore(EwErrorCode *errorCode)
Create and add a cable core for this cable reference.
EwErrorCode setWireSizeStandard(EwWireSizeStandard eWireSizeStandard)
Set the size standard of this cable reference.
EwErrorCode setClassID(LONG lID)
Set the class ID of this cable reference.
EwErrorCode setUserData(LONG nUserDataNumber, BSTR strValue)
Set user data of the object.
IEwCableReferenceX duplicate(EwErrorCode *errorCode)
Duplicate current cable reference.
BSTR getDescription(BSTR lgCode, EwErrorCode *errorCode)
Get a description of this cable reference.
EwWireSizeStandard getWireSizeStandard(EwErrorCode *errorCode)
Get the size standard of this cable reference.
BSTR getArticleNumber(EwErrorCode *errorCode)
Get an article number of this cable reference.
BSTR getSerie(EwErrorCode *errorCode)
Get a serie of this cable reference.
BSTR getStandard(EwErrorCode *errorCode)
Get a standard of this cable reference.
EwErrorCode setStockNumber(BSTR strStockNumber)
Set a stock number of this cable reference.
DOUBLE getSection(EwErrorCode *errorCode)
Get the section of this cable reference.
EwErrorCode setColorCode(BSTR strColorCode)
Set the color code of this cable reference.
BSTR getStockNumber(EwErrorCode *errorCode)
Get a stock number of this cable reference.
EwCreatorType getCreator(EwErrorCode *errorCode)
EwErrorCode setCableType(EwCableReferenceType eCableReferenceType)
Set a cable type of this cable reference.
EwErrorCode setManufacturer(BSTR strManufacturer)
Set a manufacturer of this cable reference.
EwErrorCode deleteCableCoreAt(LONG index)
Delete a cable core from this cable reference.
BSTR getGauge(EwErrorCode *errorCode)
Get the Gauge of this cable reference.
BSTR getUserData(LONG nUserDataNumber, EwErrorCode *errorCode)
Get user data of the object.
EwErrorCode setDiameter(DOUBLE dDiameter)
Set the diameter of this cable reference.
EwErrorCode setClassNodeID(LONG lNodeId)
BSTR getExternalID(EwErrorCode *errorCode)
Get external identifier of this cable reference.
Use this interface to manage an IEwClassificationX object.
Definition: EwClassificationObjects.idl:228
This interface is a generic interface for environment object methods.
Definition: EwObjectBaseObjects.idl:307


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/EwCableObjects.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) 2024 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.