Hide Table of Contents
SOLIDWORKS Electrical API 2024.0.0
Electrical API
EwProjectWireObjects.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";
9import "EnumDefinition.idl";
10import "EwObjectBaseObjects.idl";
11import "EwProjectCableObjects.idl";
12
17[
18 object,
19 uuid(61f18da4-03bd-11e5-8418-1697f925ec7b),
20 dual,
21 oleautomation,
22 nonextensible,
23 helpstring("IEwProjectWireX Interface"),
24 pointer_default(unique)
25]
27{
38 EwErrorCode setUserData (LONG nUserDataNumber, BSTR strValue);
39
40
51 BSTR getUserData (LONG nUserDataNumber, EwErrorCode* errorCode);
52
53
62 BSTR getTag (EwErrorCode* errorCode);
63
64
75 EwErrorCode setTag (BSTR strValue);
76
77
86 BSTR getTagRoot (EwErrorCode* errorCode);
87
88
99 EwErrorCode setTagRoot (BSTR strValue);
100
101
111
112
123
124
133 long getTagNumber (EwErrorCode* errorCode);
134
135
148
149
159
160
169 VARIANT_BOOL isTagUnique (EwErrorCode* errorCode);
170
171
172 /*
173 * Set the wire length value.
174 * \return EwErrorCode enum type, can be:
175 * \li EW_UNDEFINED_ERROR if another error occurred
176 * \li EW_INVALID_OBJECT if current object is invalid
177 * \li EW_NO_ERROR if no error detected
178 */
179 EwErrorCode setLength (DOUBLE dLength);
180
181
189 BSTR getLinearMass (EwErrorCode* errorCode);
190
191
200 EwErrorCode setLinearMass (BSTR strLinearMass);
201
202
216 EwErrorCode setHarnessID (long lHarnessID);
217
218
229 LONG getHarnessID (EwErrorCode* errorCode);
230
231
241 DOUBLE getLength (EwErrorCode* errorCode);
242
243
253 EwErrorCode setDiameter (DOUBLE dValue);
254
255
265 DOUBLE getDiameter (EwErrorCode* errorCode);
266
267
278
279
290
291
302
303
314
315
325 EwErrorCode setSignal (BSTR strValue);
326
327
337 BSTR getSignal (EwErrorCode* errorCode);
338
339
349 BSTR getColorCode (EwErrorCode* errorCode);
350
351
361 EwErrorCode setColorCode (BSTR strColorCode);
362
363
375 EwErrorCode setBendRadiusFactor (DOUBLE dBendRadiusFactor);
376
377
387 DOUBLE getBendRadiusFactor (EwErrorCode* errorCode);
388
389
399 EwErrorCode setBendRadius (DOUBLE dBendRadius);
400
401
410 DOUBLE getBendRadius (EwErrorCode* errorCode);
411
412
413
423 BSTR getPath (EwErrorCode* errorCode);
424
425
435 LONG getWireStyleID (EwErrorCode* errorCode);
436
437
447 BSTR getEquipotential (EwErrorCode* errorCode);
448
449
460
461
471 LONG getCableID (EwErrorCode* errorCode);
472
473
483 BSTR getOrigin (EwErrorCode* errorCode);
484
485
495 BSTR getDestination (EwErrorCode* errorCode);
496
497
508
509};
510
515[
516 object,
517 uuid(FC6A488D-6EA7-4800-9035-2F7F4FEA6E61),
518 dual,
519 nonextensible,
520 pointer_default(unique)
521]
522interface IEwProjectWireManagerX : IDispatch
523{
533
534
540 VARIANT getEwProjectWireArray (EwErrorCode* errorCode);
541
542
552
553};
554
559[
560 object,
561 uuid(80ca293e-1620-4b13-a6af-7cb1b076cbc3),
562 dual,
563 oleautomation,
564 nonextensible,
565 helpstring("IEwProjectWireStyleX Interface"),
566 pointer_default(unique)
567]
569{
578 BSTR getName (EwErrorCode* errorCode);
579
580
589 EwErrorCode setName (BSTR strName);
590
591
599 BSTR getLinearMass (EwErrorCode* errorCode);
600
601
610 EwErrorCode setLinearMass (BSTR strLinearMass);
611
612
621 EwErrorCode setDispSchema (BSTR strDispSchema);
622
623
632 BSTR getDispSchema (EwErrorCode* errorCode);
633
634
643 BSTR getTension (EwErrorCode* errorCode);
644
645
654 EwErrorCode setTension (BSTR strTension);
655
656
665 BSTR getFrequence (EwErrorCode* errorCode);
666
667
676 EwErrorCode setFrequence (BSTR strFrequence);
677
678
688
689
699 EwErrorCode setWireSectionGauge (BSTR strWireSectionGauge);
700
701
711
712
721 EwErrorCode setEquipTagFormula (BSTR strEquipTagFormula);
722
723
733
734
743 EwErrorCode setWireTagFormula (BSTR strWireTagFormula);
744
745
754 LONG getNumberID (EwErrorCode* errorCode);
755
756
766 EwErrorCode setNumberID (LONG lNumberID);
767
768
778 EwErrorCode setBendRadius (DOUBLE dBendRadius);
779
780
789 DOUBLE getBendRadius (EwErrorCode* errorCode);
790
791
800 BSTR getWireColorName (EwErrorCode* errorCode);
801
802
811 EwErrorCode setWireColorName (BSTR strWireColorName);
812
813
822 BSTR getDispTerminal (EwErrorCode* errorCode);
823
824
833 EwErrorCode setDispTerminal (BSTR strDispTerminal);
834
835
844 BSTR getDispWiring (EwErrorCode* errorCode);
845
846
855 EwErrorCode setDispWiring (BSTR strDispWiring);
856
857
866 LONG getOrderNo (EwErrorCode* errorCode);
867
868
877 EwErrorCode setOrderNo (LONG lOrderNo);
878
879
897
898
916
917
927 EwErrorCode setLineWidth (double dLineWidth);
928
929
938 double getLineWidth (EwErrorCode* errorCode);
939
940
949 EwErrorCode setPropagate (VARIANT_BOOL bPropagate);
950
951
960 VARIANT_BOOL getPropagate (EwErrorCode* errorCode);
961
962
972 EwErrorCode setColor (long lColor);
973
974
983 long getColor (EwErrorCode* errorCode);
984
985
996 EwErrorCode setCableDiameter (double dDiameter);
997
998
1007 double getCableDiameter (EwErrorCode* errorCode);
1008
1009
1023
1024
1038
1039
1048 EwErrorCode setEwProjectCableXByID (long lEwProjectCableID);
1049
1050
1060
1061
1071
1072
1085 EwErrorCode setTranslatedData (LONG nUserDataNumber, BSTR strLanguage, BSTR strValue);
1086
1087
1100 BSTR getTranslatedData (LONG nUserDataNumber, BSTR strLanguage, EwErrorCode* errorCode);
1101
1102};
1103
1108[
1109 object,
1110 uuid(942eb12a-9425-4ee1-8bad-0f805b242005),
1111 dual,
1112 oleautomation,
1113 nonextensible,
1114 helpstring("IEwProjectWireStyleGroupX Interface"),
1115 pointer_default(unique)
1116]
1118{
1127 LONG getNumber (EwErrorCode* errorCode);
1128
1129
1139 EwErrorCode setNumber (LONG lNumberID);
1140
1141
1154
1155
1168
1169
1186
1187
1204
1205
1214 EwErrorCode setActive (VARIANT_BOOL bActive);
1215
1216
1225 VARIANT_BOOL getActive (EwErrorCode* errorCode);
1226
1227
1236 EwErrorCode setStartOrderNo (LONG lStartOrderNo);
1237
1238
1247 LONG getStartOrderNo (EwErrorCode* errorCode);
1248
1249
1262 EwErrorCode setTranslatedData (LONG nUserDataNumber, BSTR strLanguage, BSTR strValue);
1263
1264
1277 BSTR getTranslatedData (LONG nUserDataNumber, BSTR strLanguage, EwErrorCode* errorCode);
1278
1279};
1280
1285[
1286 object,
1287 uuid(5f38b4b5-93ca-41fb-bd8f-eb2646d9c6d4),
1288 dual,
1289 nonextensible,
1290 pointer_default(unique)
1291]
1292interface IEwProjectWireStyleManagerX : IDispatch
1293{
1303
1304
1314
1315
1326
1327
1337
1338
1348
1349
1359
1360}
EwErrorCode
All errors codes for this API.
Definition: EnumDefinition.idl:24
EwComputeOrderNumberType
Enumeration of the short order in equipotentiel.
Definition: EwEnumeration.idl:1448
EwTagUnicityType
Tag unicity of wire style.
Definition: EwEnumeration.idl:1461
EwTagMode
All Mark mode type.
Definition: EwEnumeration.idl:803
EwWireSizeStandard
Wire size standard type.
Definition: EwEnumeration.idl:639
EwPhaseType
Conductor type of a wire style.
Definition: EwEnumeration.idl:1479
This interface is a generic interface for standard object methods.
Definition: EwObjectBaseObjects.idl:97
Use this interface to manage a cable inside a project.
Definition: EwProjectCableObjects.idl:26
Use this interface to manage IEwProjectWireX objects.
Definition: EwProjectWireObjects.idl:523
IEwProjectWireX newEwProjectWire(EwErrorCode *errorCode)
Create an interface for a new wire in the current project.
VARIANT getEwProjectWireArray(EwErrorCode *errorCode)
Get all the wires in the project of the manager.
IEwProjectWireX findEwProjectWireByID(LONG lWireID, EwErrorCode *errorCode)
Find a wire in the project with the target ID.
Use this interface to manage Wire Style Group inside a project.
Definition: EwProjectWireObjects.idl:1118
EwComputeOrderNumberType getEwComputeOrderNumberType(EwErrorCode *errorCode)
Get the compute order number type of the current object.
EwErrorCode setTranslatedData(LONG nUserDataNumber, BSTR strLanguage, BSTR strValue)
Set the value of a translated text.
EwTagUnicityType getEwTagUnicityType(EwErrorCode *errorCode)
Get the tag unicity type of the current object.
LONG getStartOrderNo(EwErrorCode *errorCode)
Get the start order no of the current object.
EwErrorCode setStartOrderNo(LONG lStartOrderNo)
Set the start order no of the current object.
VARIANT_BOOL getActive(EwErrorCode *errorCode)
Get the activate state of wire style group.
LONG getNumber(EwErrorCode *errorCode)
Get the identifier(numberID) of the current object.
BSTR getTranslatedData(LONG nUserDataNumber, BSTR strLanguage, EwErrorCode *errorCode)
Get the value of a translated text.
EwErrorCode setActive(VARIANT_BOOL bActive)
Set the activate state of wire style group.
EwErrorCode setEwComputeOrderNumberType(EwComputeOrderNumberType eComputeOrderNumberType)
Set the compute order number type of the current object.
EwErrorCode setEwTagUnicityType(EwTagUnicityType eTagUnicityType)
Set the tag unicity type of the current object.
EwErrorCode setNumber(LONG lNumberID)
Set the identifier(numberid) of the current object.
Use this interface to manage IEwProjectWireStyleX objects.
Definition: EwProjectWireObjects.idl:1293
IEwProjectWireStyleGroupX newEwProjectWireStyleGroup(EwErrorCode *errorCode)
Create an interface for a new wire style group in the current project.
VARIANT getEwProjectWireStyleGroupArray(EwErrorCode *errorCode)
Get all the wires style group in the project of the manager.
IEwProjectWireStyleX findEwProjectWireStyleByID(LONG lWireStyleID, EwErrorCode *errorCode)
Find a wire style in the project with the target ID.
IEwProjectWireStyleGroupX findEwProjectWireStyleGroupByID(LONG lWireStyleGroupID, EwErrorCode *errorCode)
Find a EwProjectWireStyleGroupX by ID in the current project.
IEwProjectWireStyleX newEwProjectWireStyle(EwErrorCode *errorCode)
Create an interface for a new wire style in the current project.
VARIANT getEwProjectWireStyleArray(EwErrorCode *errorCode)
Get all the wires style in the project of the manager.
Use this interface to manage Wire Style inside a project.
Definition: EwProjectWireObjects.idl:569
EwErrorCode setEwPhaseType(EwPhaseType ePhaseType)
Set the frequence of the current object.
BSTR getEquipTagFormula(EwErrorCode *errorCode)
Get the equip tag formula of the current object.
BSTR getDispWiring(EwErrorCode *errorCode)
Get the disp wiring of the current object.
EwErrorCode setNumberID(LONG lNumberID)
Set the number ID of the current object.
EwErrorCode setEwProjectCableXByID(long lEwProjectCableID)
Set EwProjectCableX by ID in the current object.
EwWireSizeStandard getWireSizeStandard(EwErrorCode *errorCode)
Get the wire size standard of the current object.
BSTR getTension(EwErrorCode *errorCode)
Get the tension of the current object.
EwErrorCode setDispSchema(BSTR strDispSchema)
Set the disp schema of the current object.
EwErrorCode setWireSizeStandard(EwWireSizeStandard eWireSizeStandard)
Set the wire size standard of the current object.
EwErrorCode setTension(BSTR strTension)
Set the tension of the current object.
BSTR getLinearMass(EwErrorCode *errorCode)
Get the linear mass (density) of this object.
BSTR getWireSectionGauge(EwErrorCode *errorCode)
Get the wire section gauge of the current object.
EwPhaseType getEwPhaseType(EwErrorCode *errorCode)
Get the EwPhaseType of the current object.
BSTR getFrequence(EwErrorCode *errorCode)
Get the frequence of the current object.
BSTR getWireColorName(EwErrorCode *errorCode)
Get the wire color name of the current object.
EwErrorCode setTranslatedData(LONG nUserDataNumber, BSTR strLanguage, BSTR strValue)
Set the value of a translated text.
EwErrorCode setEquipTagFormula(BSTR strEquipTagFormula)
Set the equip tag formula of the current object.
LONG getOrderNo(EwErrorCode *errorCode)
Get the order no of the current object.
VARIANT_BOOL getPropagate(EwErrorCode *errorCode)
Get the propagate value of the current object.
BSTR getDispTerminal(EwErrorCode *errorCode)
Get the disp terminal of the current object.
EwErrorCode setCableDiameter(double dDiameter)
Set the cable diameter of the current object.
LONG getNumberID(EwErrorCode *errorCode)
Get the number ID of the current object.
EwErrorCode setWireSectionGauge(BSTR strWireSectionGauge)
Set the wire section gauge of the current object.
EwErrorCode setFrequence(BSTR strFrequence)
Set the frequence of the current object.
DOUBLE getBendRadius(EwErrorCode *errorCode)
Get the bend radius in millimeter associated with the current object.
EwErrorCode setDispTerminal(BSTR strDispTerminal)
Set the disp terminal of the current object.
BSTR getWireTagFormula(EwErrorCode *errorCode)
Get the wire tag formula of the current object.
EwErrorCode setWireColorName(BSTR strWireColorName)
Set the wire color name of the current object.
EwErrorCode setColor(long lColor)
Set the color of the current object.
EwErrorCode setLineWidth(double dLineWidth)
Set the line width of the current object.
BSTR getName(EwErrorCode *errorCode)
Get the name of the current object.
EwErrorCode setPropagate(VARIANT_BOOL bPropagate)
Set the propagate value of the current object.
EwErrorCode setDispWiring(BSTR strDispWiring)
Set the disp wiring of the current object.
IEwProjectCableX getEwProjectCableX(EwErrorCode *errorCode)
Get the EwProjectCableX of the current object.
EwErrorCode setLinearMass(BSTR strLinearMass)
Set the linear mass (density) of this object.
EwErrorCode setBendRadius(DOUBLE dBendRadius)
Set the bend radius in millimeter associated with the current object.
BSTR getTranslatedData(LONG nUserDataNumber, BSTR strLanguage, EwErrorCode *errorCode)
Get the value of a translated text.
long getColor(EwErrorCode *errorCode)
Get the color of the current object.
double getLineWidth(EwErrorCode *errorCode)
Get the line width of the current object.
EwErrorCode setOrderNo(LONG lOrderNo)
Set the order no of the current object.
EwErrorCode setWireTagFormula(BSTR strWireTagFormula)
Set the wire tag formula of the current object.
double getCableDiameter(EwErrorCode *errorCode)
Get the cable diameter of the current object.
BSTR getDispSchema(EwErrorCode *errorCode)
Get the disp schema of the current object.
long getEwProjectCableXByID(EwErrorCode *errorCode)
Get the ID of EwProjectCableX in the current object.
EwErrorCode setName(BSTR strName)
Set the name of the current object.
Use this interface to manage wire inside a project.
Definition: EwProjectWireObjects.idl:27
DOUBLE getBendRadiusFactor(EwErrorCode *errorCode)
Get the bend radius factor associated with the current wire.
EwErrorCode setUserData(LONG nUserDataNumber, BSTR strValue)
Set user data of the object.
BSTR getSignal(EwErrorCode *errorCode)
Get the signal of this wire.
EwErrorCode setBendRadius(DOUBLE dBendRadius)
Set the bend radius in millimeter associated with the current object.
BSTR getSectionOrGauge(EwErrorCode *errorCode)
Get the section or gauge of this wire.
LONG getCableWireOrder(EwErrorCode *errorCode)
Get the cabling order of the current wire.
BSTR getTagRoot(EwErrorCode *errorCode)
Get the mark root of this object.
EwErrorCode setBendRadiusFactor(DOUBLE dBendRadiusFactor)
Set the bend radius factor associated with the current wire.
EwErrorCode setSectionOrGauge(BSTR strValue)
Set the section or gauge of this wire.
DOUBLE getLength(EwErrorCode *errorCode)
Get the lenght of the current wire.
LONG getWireStyleID(EwErrorCode *errorCode)
Get the EwWireStyleX object ID of the current wire.
BSTR getTag(EwErrorCode *errorCode)
Get the mark of this object.
BSTR getDestination(EwErrorCode *errorCode)
Get the destination of this wire.
EwErrorCode setSignal(BSTR strValue)
Set the signal of this wire.
VARIANT_BOOL isTagUnique(EwErrorCode *errorCode)
Returns true or false if mark is unique.
EwErrorCode setWireSizeStandard(EwWireSizeStandard eWireSizeStandard)
Set the wire size standard enum type of this wire.
EwErrorCode setHarnessID(long lHarnessID)
Set the Harness ID of this wire.
LONG getHarnessID(EwErrorCode *errorCode)
Get the Harness ID associated at the current wire.
BSTR getEquipotential(EwErrorCode *errorCode)
Get the equipotential tag of this wire.
BSTR getOrigin(EwErrorCode *errorCode)
Get the origin of this wire.
EwErrorCode setTagNumber(long lValue)
Set the mark number of this object.
EwErrorCode setTag(BSTR strValue)
Set the mark of this object.
EwErrorCode setLinearMass(BSTR strLinearMass)
Set the linear mass (density) of this object.
EwErrorCode setLength(DOUBLE dLength)
BSTR getPath(EwErrorCode *errorCode)
Get the duct path of the current wire.
DOUBLE getBendRadius(EwErrorCode *errorCode)
Get the bend radius in millimeter associated with the current object.
BSTR getCableCoreDescription(EwErrorCode *errorCode)
Get the cable core description of the current wire.
BSTR getUserData(LONG nUserDataNumber, EwErrorCode *errorCode)
Get user data of the object.
EwErrorCode setNextTagNumber()
Set the next number to have a unique mark.
EwErrorCode setTagMode(EwTagMode eTagMode)
Set the mark mode of this object.
EwErrorCode setTagRoot(BSTR strValue)
Set the mark root of this object.
EwErrorCode setColorCode(BSTR strColorCode)
Set the color code of this wire.
BSTR getColorCode(EwErrorCode *errorCode)
Get the color code of this wire.
EwTagMode getTagMode(EwErrorCode *errorCode)
Get the mark mode of this object.
BSTR getLinearMass(EwErrorCode *errorCode)
Get the linear mass (density) of this object.
long getTagNumber(EwErrorCode *errorCode)
Get the mark number of this object.
EwErrorCode setDiameter(DOUBLE dValue)
Set the diameter of this wire.
EwWireSizeStandard getWireSizeStandard(EwErrorCode *errorCode)
Get the wire size standard enum type of this wire.
DOUBLE getDiameter(EwErrorCode *errorCode)
Get the diameter of this wire.
LONG getCableID(EwErrorCode *errorCode)
Get the cable ID associated to the current wire.


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/EwProjectWireObjects.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.