Hide Table of Contents
SOLIDWORKS Electrical API  2022.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 
7 import "oaidl.idl";
8 import "ocidl.idl";
9 
10 import "EnumDefinition.idl";
11 import "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 ]
40 interface 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 
82  EwCableCoreType getEwCableCoreType (EwErrorCode* errorCode);
83 
84 
92  EwErrorCode setEwCableCoreType (EwCableCoreType eCableCoreType);
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 
176 };
177 
182 [
183  object,
184  uuid(59A07E7E-D6B9-4D71-92A3-009916908E54),
185  dual,
186  oleautomation,
187  nonextensible,
188  helpstring("IEwCableReferenceX Interface"),
189  pointer_default(unique)
190 ]
191 interface IEwCableReferenceX : IDispatch{
192 
193 
194 
203  IEwCableCoreX addEwCableCore (EwErrorCode* errorCode);
204 
205 
215  EwErrorCode deleteCableCoreAt (LONG index);
216 
217 
222  LONG getCableCoreCount ();
223 
224 
235  IEwCableCoreX getEwCableCoreAt (LONG index, EwErrorCode* errorCode);
236 
237 
248  BSTR getDescription (BSTR lgCode, EwErrorCode* errorCode);
249 
250 
261  EwErrorCode setDescription (BSTR lgCode, BSTR strValue);
262 
263 
272  BSTR getReference (EwErrorCode* errorCode);
273 
274 
283  EwErrorCode setReference (BSTR strReference);
284 
285 
294  BSTR getManufacturer (EwErrorCode* errorCode);
295 
296 
305  EwErrorCode setManufacturer (BSTR strManufacturer);
306 
307 
316  BSTR getArticleNumber (EwErrorCode* errorCode);
317 
318 
327  EwErrorCode setArticleNumber (BSTR strArticleNumber);
328 
329 
338  LONG getClassNodeID (EwErrorCode* errorCode);
339 
340 
349  EwErrorCode setClassNodeID (LONG lNodeId);
350 
351 
360  BSTR getLibraryCode (EwErrorCode* errorCode);
361 
362 
371  EwErrorCode setLibraryCode (BSTR strLibraryCode);
372 
373 
382  BSTR getFamily (EwErrorCode* errorCode);
383 
384 
393  EwErrorCode setFamily (BSTR strFamily);
394 
395 
404  BSTR getStandard (EwErrorCode* errorCode);
405 
406 
415  EwErrorCode setStandard (BSTR strStandard);
416 
417 
426  BSTR getSerie (EwErrorCode* errorCode);
427 
428 
437  BSTR getSupplierName (EwErrorCode* errorCode);
438 
439 
448  EwErrorCode setSupplierName (BSTR strSupplierName);
449 
450 
459  BSTR getStockNumber (EwErrorCode* errorCode);
460 
461 
470  EwErrorCode setStockNumber (BSTR strStockNumber);
471 
472 
481  DATE getModificationDate (EwErrorCode* errorCode);
482 
483 
492  DATE getCreationDate (EwErrorCode* errorCode);
493 
494 
503  EwCreatorType getCreator (EwErrorCode* errorCode);
504 
505 
514  EwCableReferenceType getCableType (EwErrorCode* errorCode);
515 
516 
525  EwErrorCode setCableType (EwCableReferenceType eCableReferenceType);
526 
527 
536  EwWireSizeStandard getWireSizeStandard (EwErrorCode* errorCode);
537 
538 
547  EwErrorCode setWireSizeStandard (EwWireSizeStandard eWireSizeStandard);
548 
549 
559  DOUBLE getSection (EwErrorCode* errorCode);
560 
561 
572  EwErrorCode setSection (DOUBLE dSection);
573 
574 
583  DOUBLE getDiameter (EwErrorCode* errorCode);
584 
585 
595  EwErrorCode setDiameter (DOUBLE dDiameter);
596 
597 
606  BSTR getColorCode (EwErrorCode* errorCode);
607 
608 
617  EwErrorCode setColorCode (BSTR strColorCode);
618 
619 
628  DOUBLE getBendRadius (EwErrorCode* errorCode);
629 
630 
640  EwErrorCode setBendRadius (DOUBLE dBendRadius);
641 
642 
651  DOUBLE getVoltageDrop (EwErrorCode* errorCode);
652 
653 
663  EwErrorCode setVoltageDrop (DOUBLE dVoltageDrop);
664 
665 
676  EwErrorCode insert ();
677 
678 
688  EwErrorCode update ();
689 
690 
698  EwErrorCode remove ();
699 
700 
710  BSTR getGauge (EwErrorCode* errorCode);
711 
712 
722  EwErrorCode setGauge (BSTR strGauge);
723 
724 
734  BSTR getExternalID (EwErrorCode* errorCode);
735 
736 
746  EwErrorCode setExternalID (BSTR strExternalID);
747 
748 
758  BSTR getModifiedBy (EwErrorCode* eErrorCode);
759 
769  BSTR getLinearMass (EwErrorCode* errorCode);
770 
771 
782  EwErrorCode setLinearMass (BSTR strLinearMass);
783 
784 
796  EwErrorCode setUserData (LONG nUserDataNumber, BSTR strValue);
797 
798 
810  BSTR getUserData (LONG nUserDataNumber, EwErrorCode* errorCode);
811 
812 
826  EwErrorCode setTranslatedData (LONG nUserDataNumber, BSTR strLanguage, BSTR strValue);
827 
828 
842  BSTR getTranslatedData (LONG nUserDataNumber, BSTR strLanguage, EwErrorCode* errorCode);
843 
853  BSTR getCreatedBy (EwErrorCode* eErrorCode);
854 
855 
865  DOUBLE getCoreDiameter (EwErrorCode* errorCode);
866 
867 
878  EwErrorCode setCoreDiameter (DOUBLE dCoreDiameter);
879 
880 
891  IEwClassificationX getClassification (EwErrorCode* errorCode);
892 
893 };
894 
899 [
900  object,
901  uuid(1F2276D3-B358-40C8-84E2-F8BDED5BF8BF),
902  dual,
903  oleautomation,
904  nonextensible,
905  helpstring("IEwCableReferenceManagerX Interface"),
906  pointer_default(unique)
907 ]
908 interface IEwCableReferenceManagerX : IDispatch
909 {
914  IEwCableReferenceX newEwCableReference ();
915 
916 
920  LONG getCount ();
921 
922 
926  VARIANT getEwCableReferenceArray (EwErrorCode* errorCode);
927 
928 
933  IEwCableReferenceFiltersX newEwCableReferenceFilters ();
934 
935 
945  IEwCableReferenceX findByManufacturerAndReference (BSTR strManufacturer, BSTR strReference , EwErrorCode* errorCode);
946 
947 
948 };
IEwCableReferenceX::deleteCableCoreAt
EwErrorCode deleteCableCoreAt(LONG index)
Delete a cable core from this cable reference.
IEwCableReferenceX::setStockNumber
EwErrorCode setStockNumber(BSTR strStockNumber)
Set a stock number of this cable reference.
IEwCableCoreX::getGroup
BSTR getGroup(EwErrorCode *errorCode)
Get the group of this cable core.
IEwCableReferenceX::getExternalID
BSTR getExternalID(EwErrorCode *errorCode)
Get external identifier of this cable reference.
IEwCableReferenceX::insert
EwErrorCode insert()
Insert this object inside the current environment.
IEwCableReferenceX::getCreator
EwCreatorType getCreator(EwErrorCode *errorCode)
Get the creator of this cable reference.
IEwCableCoreX::getNumber
LONG getNumber()
Get the number of this cable core.
IEwCableReferenceManagerX::newEwCableReference
IEwCableReferenceX newEwCableReference()
Create a IEwCableReferenceX object from the associated environnement.
IEwCableReferenceX::setCableType
EwErrorCode setCableType(EwCableReferenceType eCableReferenceType)
Set a cable type of this cable reference.
IEwCableReferenceX::setWireSizeStandard
EwErrorCode setWireSizeStandard(EwWireSizeStandard eWireSizeStandard)
Set the size standard of this cable reference.
IEwCableReferenceX::setBendRadius
EwErrorCode setBendRadius(DOUBLE dBendRadius)
Set the bend radius of this cable reference.
IEwCableReferenceX::getManufacturer
BSTR getManufacturer(EwErrorCode *errorCode)
Get a manufacturer of this cable reference.
IEwCableReferenceX::setVoltageDrop
EwErrorCode setVoltageDrop(DOUBLE dVoltageDrop)
Set the voltage drop of this cable reference.
IEwCableReferenceX::getCreationDate
DATE getCreationDate(EwErrorCode *errorCode)
Get the creation date of this cable reference.
IEwCableReferenceX::getGauge
BSTR getGauge(EwErrorCode *errorCode)
Get the Gauge of this cable reference.
IEwCableReferenceX::getLibraryCode
BSTR getLibraryCode(EwErrorCode *errorCode)
Get a library code of this cable reference.
IEwCableReferenceX::setReference
EwErrorCode setReference(BSTR strReference)
Set a reference of this cable reference.
IEwCableReferenceManagerX::findByManufacturerAndReference
IEwCableReferenceX findByManufacturerAndReference(BSTR strManufacturer, BSTR strReference, EwErrorCode *errorCode)
Return an IEWCableReference according to the manufacturer name and the reference.
EwErrorCode
EwErrorCode
All errors codes for this API.
Definition: EnumDefinition.idl:21
IEwCableReferenceX::setDiameter
EwErrorCode setDiameter(DOUBLE dDiameter)
Set the diameter of this cable reference.
EwCableReferenceType
EwCableReferenceType
Cable reference type.
Definition: EwEnumeration.idl:599
IEwCableReferenceX::getVoltageDrop
DOUBLE getVoltageDrop(EwErrorCode *errorCode)
Get the voltage drop of this cable reference.
IEwCableReferenceX::setUserData
EwErrorCode setUserData(LONG nUserDataNumber, BSTR strValue)
Set user data of the object.
IEwCableCoreX::setGroup
EwErrorCode setGroup(BSTR strGroup)
Set the group of this cable core.
IEwCableReferenceX::getDiameter
DOUBLE getDiameter(EwErrorCode *errorCode)
Get the diameter of this cable reference.
IEwCableReferenceX::getCableType
EwCableReferenceType getCableType(EwErrorCode *errorCode)
Get a cable type of this cable reference.
IEwCableCoreX::setGauge
EwErrorCode setGauge(BSTR strGauge)
Set the gauge of this cable core.
IEwCableReferenceX::getStandard
BSTR getStandard(EwErrorCode *errorCode)
Get a standard of this cable reference.
IEwCableReferenceX::getModifiedBy
BSTR getModifiedBy(EwErrorCode *eErrorCode)
Get the last user name that modified the current object.
IEwCableReferenceX::addEwCableCore
IEwCableCoreX addEwCableCore(EwErrorCode *errorCode)
Create and add a cable core for this cable reference.
IEwCableReferenceX::getUserData
BSTR getUserData(LONG nUserDataNumber, EwErrorCode *errorCode)
Get user data of the object.
IEwCableCoreX
Use this interface to manage a cable core inside a cable reference.
Definition: EwCableObjects.idl:40
IEwCableReferenceX::getTranslatedData
BSTR getTranslatedData(LONG nUserDataNumber, BSTR strLanguage, EwErrorCode *errorCode)
Get the value of a translated text.
IEwCableReferenceX::setTranslatedData
EwErrorCode setTranslatedData(LONG nUserDataNumber, BSTR strLanguage, BSTR strValue)
Set the value of a translated text.
IEwCableCoreX::getEwCableCoreType
EwCableCoreType getEwCableCoreType(EwErrorCode *errorCode)
Get the type of cable core.
EwCableCoreType
EwCableCoreType
Cable Core type.
Definition: EwEnumeration.idl:624
IEwCableReferenceX::update
EwErrorCode update()
Update this object inside the current environment.
IEwCableReferenceX::getReference
BSTR getReference(EwErrorCode *errorCode)
Get a reference of this cable reference.
IEwCableReferenceX
Use this interface to manage cable reference.
Definition: EwCableObjects.idl:191
IEwCableCoreX::getDescription
BSTR getDescription(BSTR lgCode, EwErrorCode *errorCode)
Get a description of this cable core.
IEwCableReferenceX::getLinearMass
BSTR getLinearMass(EwErrorCode *errorCode)
Get the linear mass (density) of this cable.
IEwCableReferenceX::getEwCableCoreAt
IEwCableCoreX getEwCableCoreAt(LONG index, EwErrorCode *errorCode)
Get a cable core inside this cable reference.
IEwCableReferenceX::getCreatedBy
BSTR getCreatedBy(EwErrorCode *eErrorCode)
Get the user name that created the current object.
IEwCableReferenceX::getBendRadius
DOUBLE getBendRadius(EwErrorCode *errorCode)
Get the bend radius of this cable reference.
IEwCableReferenceX::getSupplierName
BSTR getSupplierName(EwErrorCode *errorCode)
Get a supplier name of this cable reference.
IEwCableReferenceX::getDescription
BSTR getDescription(BSTR lgCode, EwErrorCode *errorCode)
Get a description of this cable reference.
IEwCableReferenceX::setDescription
EwErrorCode setDescription(BSTR lgCode, BSTR strValue)
Set a description of this cable reference.
IEwCableReferenceX::setFamily
EwErrorCode setFamily(BSTR strFamily)
Set a library of this cable reference.
IEwCableReferenceX::setArticleNumber
EwErrorCode setArticleNumber(BSTR strArticleNumber)
Set an article number of this cable reference.
IEwCableCoreX::getColorCode
BSTR getColorCode(EwErrorCode *errorCode)
Get the color code of this cable core.
IEwCableReferenceX::setSupplierName
EwErrorCode setSupplierName(BSTR strSupplierName)
Set a supplier name of this cable reference.
IEwCableReferenceX::setCoreDiameter
EwErrorCode setCoreDiameter(DOUBLE dCoreDiameter)
Set outside diameter of cable core (mm)
IEwCableReferenceX::getClassNodeID
LONG getClassNodeID(EwErrorCode *errorCode)
Get the classification node ID of this cable reference.
IEwCableReferenceX::getCableCoreCount
LONG getCableCoreCount()
Count the number of cable core in this cable reference.
IEwCableReferenceX::getModificationDate
DATE getModificationDate(EwErrorCode *errorCode)
Get the last modification date of this cable reference.
IEwCableCoreX::setDescription
EwErrorCode setDescription(BSTR lgCode, BSTR strValue)
Set a description of this cable core.
IEwCableReferenceX::getStockNumber
BSTR getStockNumber(EwErrorCode *errorCode)
Get a stock number of this cable reference.
IEwCableReferenceX::setSection
EwErrorCode setSection(DOUBLE dSection)
Set the section of this cable reference.
IEwCableReferenceX::getCoreDiameter
DOUBLE getCoreDiameter(EwErrorCode *errorCode)
Get the outside diameter of cable core (mm)
IEwCableReferenceManagerX
Use this interface to manage EwCableReferenceX objects.
Definition: EwCableObjects.idl:909
IEwCableCoreX::setColorCode
EwErrorCode setColorCode(BSTR strColorCode)
Set the color code of this cable core.
IEwCableReferenceX::setExternalID
EwErrorCode setExternalID(BSTR strExternalID)
Set the external identifier of this cable reference.
IEwCableReferenceX::getFamily
BSTR getFamily(EwErrorCode *errorCode)
Get a family of this cable reference.
IEwCableCoreX::getSection
DOUBLE getSection(EwErrorCode *errorCode)
Get the section of this cable core.
IEwCableReferenceX::setColorCode
EwErrorCode setColorCode(BSTR strColorCode)
Set the color code of this cable reference.
IEwCableCoreX::setSection
EwErrorCode setSection(DOUBLE dSection)
Set the section of this cable core.
IEwCableReferenceX::getArticleNumber
BSTR getArticleNumber(EwErrorCode *errorCode)
Get an article number of this cable reference.
IEwCableCoreX::getGauge
BSTR getGauge(EwErrorCode *errorCode)
Get the gauge of this cable core.
IEwCableReferenceX::setLinearMass
EwErrorCode setLinearMass(BSTR strLinearMass)
Set the linear mass (density) of this cable.
IEwCableReferenceX::setLibraryCode
EwErrorCode setLibraryCode(BSTR strLibraryCode)
Set a library code of this cable reference.
IEwCableReferenceX::getSection
DOUBLE getSection(EwErrorCode *errorCode)
Get the section of this cable reference.
IEwCableReferenceX::setClassNodeID
EwErrorCode setClassNodeID(LONG lNodeId)
Set the classification node ID of this cable reference.
IEwCableReferenceManagerX::newEwCableReferenceFilters
IEwCableReferenceFiltersX newEwCableReferenceFilters()
Create an IEwCableReferenceFiltersX interface to filter on cable references (IEwCableReferenceX) of a...
IEwCableReferenceX::setGauge
EwErrorCode setGauge(BSTR strGauge)
Set the gauge of this cable reference.
IEwCableReferenceX::getClassification
IEwClassificationX getClassification(EwErrorCode *errorCode)
Get the classification of the current cable reference.
IEwCableReferenceX::getColorCode
BSTR getColorCode(EwErrorCode *errorCode)
Get the color code of this cable reference.
EwCreatorType
EwCreatorType
All creator type.
Definition: EwEnumeration.idl:260
IEwCableReferenceX::setStandard
EwErrorCode setStandard(BSTR strStandard)
Set a standard of this cable reference.
IEwCableReferenceX::setManufacturer
EwErrorCode setManufacturer(BSTR strManufacturer)
Set a manufacturer of this cable reference.
IEwCableCoreX::setEwCableCoreType
EwErrorCode setEwCableCoreType(EwCableCoreType eCableCoreType)
Set the type of cable core.
IEwCableReferenceManagerX::getEwCableReferenceArray
VARIANT getEwCableReferenceArray(EwErrorCode *errorCode)
return the array of IEwCableReferenceX of associated environment
IEwCableReferenceX::getSerie
BSTR getSerie(EwErrorCode *errorCode)
Get a serie of this cable reference.
EwWireSizeStandard
EwWireSizeStandard
Wire size standard type.
Definition: EwEnumeration.idl:611
IEwCableReferenceX::getWireSizeStandard
EwWireSizeStandard getWireSizeStandard(EwErrorCode *errorCode)
Get the size standard of this cable reference.
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/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) 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