Hide Table of Contents
SOLIDWORKS Electrical API  2021.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 
7 
8 import "oaidl.idl";
9 import "ocidl.idl";
10 
11 import "EnumDefinition.idl";
12 import "EwObjectBase.idl";
13 
14 
19 [
20  object,
21  uuid(61f18da4-03bd-11e5-8418-1697f925ec7b),
22  dual,
23  oleautomation,
24  nonextensible,
25  helpstring("IEwProjectWireX Interface"),
26  pointer_default(unique)
27 ]
28 interface IEwProjectWireX : IEwObjectBaseX
29 {
39  EwErrorCode setUserData (LONG nUserDataNumber , BSTR strValue);
40 
41 
51  BSTR getUserData (LONG nUserDataNumber , EwErrorCode* errorCode);
52 
53 
61  BSTR getTag (EwErrorCode* errorCode);
62 
63 
74  EwErrorCode setTag (BSTR strValue);
75 
76 
84  BSTR getTagRoot (EwErrorCode* errorCode);
85 
86 
96  EwErrorCode setTagRoot (BSTR strValue);
97 
98 
106  EwTagMode getTagMode (EwErrorCode* errorCode);
107 
108 
117  EwErrorCode setTagMode (EwTagMode eTagMode);
118 
119 
127  long getTagNumber (EwErrorCode* errorCode);
128 
129 
140  EwErrorCode setTagNumber (long lValue);
141 
142 
150  EwErrorCode setNextTagNumber ();
151 
152 
160  VARIANT_BOOL isTagUnique (EwErrorCode* errorCode);
161 
162 
163  /*
164  * Set the wire length value
165  * \return EwErrorCode enum type, can be:
166  * \li EW_NO_ERROR if no error detected
167  * \li EW_UNDEFINED_ERROR if another error occurred
168  */
169  EwErrorCode setLength (DOUBLE dLength);
170 
171 
180  BSTR getLinearMass (EwErrorCode* errorCode);
181 
182 
192  EwErrorCode setLinearMass (BSTR strLinearMass);
193 
194 
208  EwErrorCode setHarnessID (long lHarnessID);
209 
210 
221  LONG getHarnessID (EwErrorCode* errorCode);
222 
223 
233  DOUBLE getLength (EwErrorCode* pErrorCode);
234 
235 
245  EwErrorCode setDiameter (DOUBLE dValue);
246 
247 
257  DOUBLE getDiameter (EwErrorCode* errorCode);
258 
259 
260 
270  EwErrorCode setSectionOrGauge (BSTR strValue);
271 
272 
282  BSTR getSectionOrGauge (EwErrorCode* errorCode);
283 
284 
294  EwErrorCode setWireSizeStandard (EwWireSizeStandard eWireSizeStandard);
295 
296 
306  EwWireSizeStandard getWireSizeStandard (EwErrorCode* errorCode);
307 
308 
318  EwErrorCode setSignal (BSTR strValue);
319 
320 
330  BSTR getSignal (EwErrorCode* errorCode);
331 
332 };
333 
334 
339 [
340  object,
341  uuid(FC6A488D-6EA7-4800-9035-2F7F4FEA6E61),
342  dual,
343  nonextensible,
344  pointer_default(unique)
345 ]
346 interface IEwProjectWireManagerX : IDispatch{
355  IEwProjectWireX findEwProjectWireByID (LONG lWireID, EwErrorCode* errorCode);
356 
357 
363  VARIANT getEwProjectWireArray (EwErrorCode* errorCode);
364 
365 
374  IEwProjectWireX newEwProjectWire (EwErrorCode* errorCode);
375 
376 };
IEwProjectWireX::getSignal
BSTR getSignal(EwErrorCode *errorCode)
Get the signal of this wire.
IEwProjectWireX::getSectionOrGauge
BSTR getSectionOrGauge(EwErrorCode *errorCode)
Get the section or gauge of this wire.
IEwProjectWireX::setNextTagNumber
EwErrorCode setNextTagNumber()
Set the next number to have a unique mark.
IEwProjectWireX::getTagNumber
long getTagNumber(EwErrorCode *errorCode)
Get the mark number of this object.
IEwProjectWireX::isTagUnique
VARIANT_BOOL isTagUnique(EwErrorCode *errorCode)
Returns true or false if mark is unique.
IEwProjectWireManagerX::findEwProjectWireByID
IEwProjectWireX findEwProjectWireByID(LONG lWireID, EwErrorCode *errorCode)
Find a wire in the project with the target ID.
IEwProjectWireX::setLinearMass
EwErrorCode setLinearMass(BSTR strLinearMass)
Set the linear mass (density) of this wire.
IEwProjectWireX::setTag
EwErrorCode setTag(BSTR strValue)
Set the mark of this object.
IEwProjectWireX::setTagMode
EwErrorCode setTagMode(EwTagMode eTagMode)
Set the mark mode of this object.
EwErrorCode
EwErrorCode
All errors codes for this API.
Definition: EnumDefinition.idl:21
IEwProjectWireX::getDiameter
DOUBLE getDiameter(EwErrorCode *errorCode)
Get the diameter of this wire.
IEwProjectWireX::setUserData
EwErrorCode setUserData(LONG nUserDataNumber, BSTR strValue)
Set user data of the object.
IEwProjectWireManagerX::getEwProjectWireArray
VARIANT getEwProjectWireArray(EwErrorCode *errorCode)
Get all the wires in the project of the manager.
IEwProjectWireX::setDiameter
EwErrorCode setDiameter(DOUBLE dValue)
Set the diameter of this wire.
IEwProjectWireX::setTagNumber
EwErrorCode setTagNumber(long lValue)
Set the mark number of this object.
IEwProjectWireX::setHarnessID
EwErrorCode setHarnessID(long lHarnessID)
Set the Harness ID of this wire.
IEwObjectBaseX
This interface is a generic interface for standard methods.
Definition: EwObjectBase.idl:26
IEwProjectWireX::getLinearMass
BSTR getLinearMass(EwErrorCode *errorCode)
Get the linear mass (density) of this wire.
IEwProjectWireX::getHarnessID
LONG getHarnessID(EwErrorCode *errorCode)
Get the Harness ID associated at the current wire.
IEwProjectWireX::setWireSizeStandard
EwErrorCode setWireSizeStandard(EwWireSizeStandard eWireSizeStandard)
Set the wire size standard enum type of this wire.
IEwProjectWireX::setSectionOrGauge
EwErrorCode setSectionOrGauge(BSTR strValue)
Set the section or gauge of this wire.
IEwProjectWireX::setSignal
EwErrorCode setSignal(BSTR strValue)
Set the signal of this wire.
IEwProjectWireX::setTagRoot
EwErrorCode setTagRoot(BSTR strValue)
Set the mark root of this object.
EwTagMode
EwTagMode
All Mark mode type.
Definition: EwEnumeration.idl:748
IEwProjectWireManagerX
Use this interface to manage IEwProjectWireX objects.
Definition: EwProjectWireObjects.idl:346
IEwProjectWireX::getLength
DOUBLE getLength(EwErrorCode *pErrorCode)
Get the lenght of the current wire.
IEwProjectWireX::setLength
EwErrorCode setLength(DOUBLE dLength)
IEwProjectWireX::getTag
BSTR getTag(EwErrorCode *errorCode)
Get the mark of this object.
IEwProjectWireX
Use this interface to manage wire inside a project.
Definition: EwProjectWireObjects.idl:29
IEwProjectWireManagerX::newEwProjectWire
IEwProjectWireX newEwProjectWire(EwErrorCode *errorCode)
Create an interface for a new wire in the current project.
IEwProjectWireX::getUserData
BSTR getUserData(LONG nUserDataNumber, EwErrorCode *errorCode)
Get user data of the object.
IEwProjectWireX::getWireSizeStandard
EwWireSizeStandard getWireSizeStandard(EwErrorCode *errorCode)
Get the wire size standard enum type of this wire.
IEwProjectWireX::getTagMode
EwTagMode getTagMode(EwErrorCode *errorCode)
Get the mark mode of this object.
EwWireSizeStandard
EwWireSizeStandard
Wire size standard type.
Definition: EwEnumeration.idl:593
IEwProjectWireX::getTagRoot
BSTR getTagRoot(EwErrorCode *errorCode)
Get the mark root of this object.
Generated on Thu Aug 20 2020 08:40:15 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/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) 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.21