Hide Table of Contents
SOLIDWORKS Electrical API  2021.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 
12 
13 /************************************************************************/
14 /* In his file, all CABLE object */
15 /************************************************************************/
16 
17 /************************************************************************/
18 /* ENUMERATION */
19 /************************************************************************/
20 
21 
22 /************************************************************************/
23 /* INTERFACES */
24 /************************************************************************/
25 
30 [
31  object,
32  uuid(8061C6A3-CDC3-4000-B1E8-DF811FE93EE7),
33  dual,
34  oleautomation,
35  nonextensible,
36  helpstring("IEwCableCoreX Interface"),
37  pointer_default(unique)
38 ]
39 interface IEwCableCoreX : IDispatch{
40 
41 
42 
47  LONG getNumber ();
48 
49 
59  BSTR getDescription (BSTR lgCode, EwErrorCode* errorCode);
60 
61 
71  EwErrorCode setDescription (BSTR lgCode, BSTR strValue);
72 
73 
81  EwCableCoreType getEwCableCoreType (EwErrorCode* errorCode);
82 
83 
91  EwErrorCode setEwCableCoreType (EwCableCoreType eCableCoreType);
92 
93 
101  DOUBLE getSection (EwErrorCode* errorCode);
102 
103 
112  EwErrorCode setSection (DOUBLE dSection);
113 
114 
122  BSTR getGroup (EwErrorCode* errorCode);
123 
124 
132  EwErrorCode setGroup (BSTR strGroup);
133 
134 
142  BSTR getGauge (EwErrorCode* errorCode);
143 
144 
152  EwErrorCode setGauge (BSTR strGauge);
153 
154 
162  BSTR getColorCode (EwErrorCode* errorCode);
163 
164 
172  EwErrorCode setColorCode (BSTR strColorCode);
173 
174 
175 };
176 
181 [
182  object,
183  uuid(59A07E7E-D6B9-4D71-92A3-009916908E54),
184  dual,
185  oleautomation,
186  nonextensible,
187  helpstring("IEwCableReferenceX Interface"),
188  pointer_default(unique)
189 ]
190 interface IEwCableReferenceX : IDispatch{
191 
192 
193 
202  IEwCableCoreX addEwCableCore (EwErrorCode* errorCode);
203 
204 
214  EwErrorCode deleteCableCoreAt (LONG index);
215 
216 
221  LONG getCableCoreCount ();
222 
223 
234  IEwCableCoreX getEwCableCoreAt (LONG index, EwErrorCode* errorCode);
235 
236 
247  BSTR getDescription (BSTR lgCode, EwErrorCode* errorCode);
248 
249 
260  EwErrorCode setDescription (BSTR lgCode, BSTR strValue);
261 
262 
270  BSTR getReference (EwErrorCode* errorCode);
271 
272 
281  EwErrorCode setReference (BSTR strReference);
282 
283 
291  BSTR getManufacturer (EwErrorCode* errorCode);
292 
293 
302  EwErrorCode setManufacturer (BSTR strManufacturer);
303 
304 
312  BSTR getArticleNumber (EwErrorCode* errorCode);
313 
314 
323  EwErrorCode setArticleNumber (BSTR strArticleNumber);
324 
325 
333  LONG getClassNodeID (EwErrorCode* errorCode);
334 
335 
344  EwErrorCode setClassNodeID (LONG lNodeId);
345 
346 
354  BSTR getLibraryCode (EwErrorCode* errorCode);
355 
356 
365  EwErrorCode setLibraryCode (BSTR strLibraryCode);
366 
367 
375  BSTR getFamily (EwErrorCode* errorCode);
376 
377 
386  EwErrorCode setFamily (BSTR strFamily);
387 
388 
396  BSTR getStandard (EwErrorCode* errorCode);
397 
398 
407  EwErrorCode setStandard (BSTR strStandard);
408 
409 
417  BSTR getSerie (EwErrorCode* errorCode);
418 
419 
427  BSTR getSupplierName (EwErrorCode* errorCode);
428 
429 
438  EwErrorCode setSupplierName (BSTR strSupplierName);
439 
440 
448  BSTR getStockNumber (EwErrorCode* errorCode);
449 
450 
459  EwErrorCode setStockNumber (BSTR strStockNumber);
460 
461 
469  DATE getModificationDate (EwErrorCode* errorCode);
470 
471 
479  DATE getCreationDate (EwErrorCode* errorCode);
480 
481 
489  EwCreatorType getCreator (EwErrorCode* errorCode);
490 
491 
499  EwCableReferenceType getCableType (EwErrorCode* errorCode);
500 
501 
510  EwErrorCode setCableType (EwCableReferenceType eCableReferenceType);
511 
512 
520  EwWireSizeStandard getWireSizeStandard (EwErrorCode* errorCode);
521 
522 
531  EwErrorCode setWireSizeStandard (EwWireSizeStandard eWireSizeStandard);
532 
533 
543  DOUBLE getSection (EwErrorCode* errorCode);
544 
545 
556  EwErrorCode setSection (DOUBLE dSection);
557 
558 
566  DOUBLE getDiameter (EwErrorCode* errorCode);
567 
568 
578  EwErrorCode setDiameter (DOUBLE dDiameter);
579 
580 
588  BSTR getColorCode (EwErrorCode* errorCode);
589 
590 
599  EwErrorCode setColorCode (BSTR strColorCode);
600 
601 
609  DOUBLE getBendRadius (EwErrorCode* errorCode);
610 
611 
621  EwErrorCode setBendRadius (DOUBLE dBendRadius);
622 
623 
631  DOUBLE getVoltageDrop (EwErrorCode* errorCode);
632 
633 
643  EwErrorCode setVoltageDrop (DOUBLE dVoltageDrop);
644 
645 
656  EwErrorCode insert ();
657 
658 
668  EwErrorCode update ();
669 
670 
678  EwErrorCode remove ();
679 
680 
690  BSTR getGauge (EwErrorCode* errorCode);
691 
692 
702  EwErrorCode setGauge (BSTR strGauge);
703 
704 
713  BSTR getExternalID (EwErrorCode* errorCode);
714 
715 
725  EwErrorCode setExternalID (BSTR strExternalID);
726 
727 
737  BSTR getModifiedBy (EwErrorCode* eErrorCode);
738 
748  BSTR getLinearMass (EwErrorCode* errorCode);
749 
750 
761  EwErrorCode setLinearMass (BSTR strLinearMass);
762 
763 
775  EwErrorCode setUserData (LONG nUserDataNumber, BSTR strValue);
776 
777 
789  BSTR getUserData (LONG nUserDataNumber, EwErrorCode* errorCode);
790 
791 
805  EwErrorCode setTranslatedData (LONG nUserDataNumber, BSTR strLanguage, BSTR strValue);
806 
807 
821  BSTR getTranslatedData (LONG nUserDataNumber, BSTR strLanguage, EwErrorCode* errorCode);
822 
832  BSTR getCreatedBy (EwErrorCode* eErrorCode);
833 
834 
843  DOUBLE getCoreDiameter (EwErrorCode* errorCode);
844 
845 
856  EwErrorCode setCoreDiameter (DOUBLE dCoreDiameter);
857 
858 
859 
860 };
861 
866 [
867  object,
868  uuid(1F2276D3-B358-40C8-84E2-F8BDED5BF8BF),
869  dual,
870  oleautomation,
871  nonextensible,
872  helpstring("IEwCableReferenceManagerX Interface"),
873  pointer_default(unique)
874 ]
875 interface IEwCableReferenceManagerX : IDispatch
876 {
881  IEwCableReferenceX newEwCableReference ();
882 
883 
887  LONG getCount ();
888 
889 
893  VARIANT getEwCableReferenceArray (EwErrorCode* errorCode);
894 
895 
900  IEwCableReferenceFiltersX newEwCableReferenceFilters ();
901 
902 
912  IEwCableReferenceX findByManufacturerAndReference (BSTR strManufacturer, BSTR strReference , EwErrorCode* errorCode);
913 
914 
915 };
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:581
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:39
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:606
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:190
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:876
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::getColorCode
BSTR getColorCode(EwErrorCode *errorCode)
Get the color code of this cable reference.
EwCreatorType
EwCreatorType
All creator type.
Definition: EwEnumeration.idl:246
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:593
IEwCableReferenceX::getWireSizeStandard
EwWireSizeStandard getWireSizeStandard(EwErrorCode *errorCode)
Get the size standard of this cable reference.
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/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) 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