Hide Table of Contents
SOLIDWORKS Electrical API 2023.0.0
Electrical API
EwClassificationObjects.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 "EwObjectBaseObjects.idl";
11
16[
17 object,
18 uuid(DAE1E577-A5CE-4E4C-9515-58C4CB548CFB),
19 dual,
20 nonextensible,
21 helpstring("IEwClassX Interface"),
22 pointer_default(unique)
23]
24interface IEwClassX : IEwEnvironmentObjectX
25{
29 LONG getID ();
30
31
41 EwErrorCode setParentID (LONG lID);
42
43
52 LONG getParentID (EwErrorCode* errorCode);
53
54
63 LONG getClassificationID (EwErrorCode* errorCode);
64
65
74 LONG getClassID (EwErrorCode* errorCode);
75
76
85 EwErrorCode set3DPartName (BSTR str3DPartName);
86
87
96 BSTR get3DPartName (EwErrorCode* errorCode);
97
98
108 EwErrorCode set2DFootprintSymbolName (BSTR str2DFootprintSymbolName);
109
110
119 BSTR get2DFootprintSymbolName (EwErrorCode* errorCode);
120
121
130 EwErrorCode set2DConnectionLabelSymbolName (BSTR str2DConnectionLabelSymbolName);
131
132
141 BSTR get2DConnectionLabelSymbolName (EwErrorCode* errorCode);
142
143
152 EwErrorCode setUserDataFile (BSTR strDataFileName);
153
154
163 BSTR getUserDataFile (EwErrorCode* errorCode);
164
165
175 EwErrorCode setClassID (EwClassificationType ewClassificationType);
176
177
186 EwClassComponentType getComponentType (EwErrorCode* errorCode);
187
188
197 EwErrorCode setComponentType (EwClassComponentType ewClassComponentType);
198
199};
200
205[
206 object,
207 uuid(BA2E432E-1AFA-4401-A0BE-4E488D1F8C7E),
208 dual,
209 nonextensible,
210 helpstring("IEwClassificationX Interface"),
211 pointer_default(unique)
212]
213interface IEwClassificationX : IEwObjectX
214{
215 /*
216 * Deprecated use IEwClassificationX getID() interface .
217 * Get the ID of the object. -1 if the object is invalid.
218 * \since 2021 SP0
219 * \param[out] errorCode EwErrorCode enum type, can be:
220 * \li EW_NO_ERROR if no error detected.
221 * \li EW_UNDEFINED_ERROR if an error occurred.
222 * \return ID of current object.
223 */
224 LONG getID (EwErrorCode* errorCode);
225
226
235 LONG getEwClassCount (EwErrorCode* errorCode);
236
237
246 EwClassificationType getClassificationType (EwErrorCode* errorCode);
247
248
258 IEwClassX findEwClassByID (LONG lClassId, EwErrorCode* errorCode);
259
260
269 VARIANT getEwClassArray (EwErrorCode* errorCode);
270
271
280 IEwClassX newEwClass (EwErrorCode* errorCode);
281
282
291 EwErrorCode set3DPartName (BSTR str3DPartName);
292
293
302 BSTR get3DPartName (EwErrorCode* errorCode);
303
304
313 EwErrorCode set2DFootprintSymbolName (BSTR str2DFootprintSymbolName);
314
315
324 BSTR get2DFootprintSymbolName (EwErrorCode* errorCode);
325
326
335 EwErrorCode set2DConnectionLabelSymbolName (BSTR str2DConnectionLabelSymbolName);
336
337
346 BSTR get2DConnectionLabelSymbolName (EwErrorCode* errorCode);
347
348
361 EwClassificationType getType (EwErrorCode* errorCode);
362
363
374 EwErrorCode moveClass (long lClassId, long lClassIdParent);
375
376
377};
378
383[
384 object,
385 uuid(7E6882FA-9A8C-46A1-AB4E-BAF9484EE7FB),
386 dual,
387 nonextensible,
388 helpstring("IEwClassificationManagerX Interface"),
389 pointer_default(unique)
390]
391interface IEwClassificationManagerX : IDispatch
392{
402 IEwClassificationX getEwClassification (EwClassificationType eClassificationType, EwErrorCode* errorCode);
403
404
413 IEwClassX newEwClass (EwErrorCode* errorCode);
414
415
424 VARIANT getEwClassArray (EwErrorCode* errorCode);
425
426
436 IEwClassX findEwClassByID (long lID, EwErrorCode* errorCode);
437
438
448 IEwClassX getEwClassAt (long lIndex, EwErrorCode* errorCode);
449
450
451
460 long getEwClassCount (EwErrorCode* errorCode);
461
462};
EwErrorCode
EwErrorCode
All errors codes for this API.
Definition: EnumDefinition.idl:21
EwClassificationType
EwClassificationType
Classification for components, symbols and manufacturer parts Enum Change due to TEW-49235 kComponent...
Definition: EwEnumeration.idl:580
EwClassComponentType
EwClassComponentType
All the class component types.
Definition: EwEnumeration.idl:1111
IEwClassX
Use this interface to manage an EwClassX object.
Definition: EwClassificationObjects.idl:25
IEwClassX::getClassID
LONG getClassID(EwErrorCode *errorCode)
Return the class node Id, unique within the classification.
IEwClassX::getParentID
LONG getParentID(EwErrorCode *errorCode)
Return the ID of the parent of the class.
IEwClassX::getID
LONG getID()
IEwClassX::get2DConnectionLabelSymbolName
BSTR get2DConnectionLabelSymbolName(EwErrorCode *errorCode)
Get the default connection label symbol used if none is associated to a manufacturer part.
IEwClassX::get3DPartName
BSTR get3DPartName(EwErrorCode *errorCode)
Get the default 3D part used if none is associated to a manufacturer part.
IEwClassX::set2DConnectionLabelSymbolName
EwErrorCode set2DConnectionLabelSymbolName(BSTR str2DConnectionLabelSymbolName)
Set the default connection label symbol to use when inserting a connection label.
IEwClassX::setUserDataFile
EwErrorCode setUserDataFile(BSTR strDataFileName)
Set User Data File of node.
IEwClassX::setComponentType
EwErrorCode setComponentType(EwClassComponentType ewClassComponentType)
Set Component Type of current node in classification.
IEwClassX::setParentID
EwErrorCode setParentID(LONG lID)
Set the value of parent ID.
IEwClassX::getComponentType
EwClassComponentType getComponentType(EwErrorCode *errorCode)
Get Component Type of current node in classification.
IEwClassX::setClassID
EwErrorCode setClassID(EwClassificationType ewClassificationType)
Set class id of current node in classification.
IEwClassX::getClassificationID
LONG getClassificationID(EwErrorCode *errorCode)
Return classification ID.
IEwClassX::getUserDataFile
BSTR getUserDataFile(EwErrorCode *errorCode)
Get User Data File of node.
IEwClassX::set2DFootprintSymbolName
EwErrorCode set2DFootprintSymbolName(BSTR str2DFootprintSymbolName)
Set the default 2D footprint symbol to use if none is associated to a manufacturer part.
IEwClassX::get2DFootprintSymbolName
BSTR get2DFootprintSymbolName(EwErrorCode *errorCode)
Get the default 2D footprint symbol used if none is associated to a manufacturer part.
IEwClassX::set3DPartName
EwErrorCode set3DPartName(BSTR str3DPartName)
Set the default 3D part to use when inserting a 3D part.
IEwClassificationManagerX
Use this interface to manage EwClassificationX objects.
Definition: EwClassificationObjects.idl:392
IEwClassificationManagerX::newEwClass
IEwClassX newEwClass(EwErrorCode *errorCode)
Create a new node in curent classification.
IEwClassificationManagerX::getEwClassCount
long getEwClassCount(EwErrorCode *errorCode)
Get number of nodes in all classification.
IEwClassificationManagerX::getEwClassification
IEwClassificationX getEwClassification(EwClassificationType eClassificationType, EwErrorCode *errorCode)
Get an interface of classificationX from classification type.
IEwClassificationManagerX::findEwClassByID
IEwClassX findEwClassByID(long lID, EwErrorCode *errorCode)
Get node find by id in current classification.
IEwClassificationManagerX::getEwClassAt
IEwClassX getEwClassAt(long lIndex, EwErrorCode *errorCode)
Get node find at specific position in current classification.
IEwClassificationManagerX::getEwClassArray
VARIANT getEwClassArray(EwErrorCode *errorCode)
Get array of all nodes found in current classification.
IEwClassificationX
Use this interface to manage an IEwClassificationX object.
Definition: EwClassificationObjects.idl:214
IEwClassificationX::get2DConnectionLabelSymbolName
BSTR get2DConnectionLabelSymbolName(EwErrorCode *errorCode)
Get a classification 2D Connection Label SymbolName.
IEwClassificationX::findEwClassByID
IEwClassX findEwClassByID(LONG lClassId, EwErrorCode *errorCode)
Get EwClassX find by id in current classification.
IEwClassificationX::getID
LONG getID(EwErrorCode *errorCode)
IEwClassificationX::set2DConnectionLabelSymbolName
EwErrorCode set2DConnectionLabelSymbolName(BSTR str2DConnectionLabelSymbolName)
Set a classification 2D Connection Label SymbolName.
IEwClassificationX::getEwClassCount
LONG getEwClassCount(EwErrorCode *errorCode)
Get number of class in this classification.
IEwClassificationX::set2DFootprintSymbolName
EwErrorCode set2DFootprintSymbolName(BSTR str2DFootprintSymbolName)
Set a classification 2D Footprint SymbolName.
IEwClassificationX::getClassificationType
EwClassificationType getClassificationType(EwErrorCode *errorCode)
Get classification's type.
IEwClassificationX::getEwClassArray
VARIANT getEwClassArray(EwErrorCode *errorCode)
Get the classification's class array.
IEwClassificationX::get3DPartName
BSTR get3DPartName(EwErrorCode *errorCode)
Get a classification 3d part name.
IEwClassificationX::getType
EwClassificationType getType(EwErrorCode *errorCode)
Get an EwClassificationType enumeration type.
IEwClassificationX::moveClass
EwErrorCode moveClass(long lClassId, long lClassIdParent)
Move a class in the classification (change parent).
IEwClassificationX::set3DPartName
EwErrorCode set3DPartName(BSTR str3DPartName)
Set a classification 3d part name.
IEwClassificationX::get2DFootprintSymbolName
BSTR get2DFootprintSymbolName(EwErrorCode *errorCode)
Get a classification 2D Footprint SymbolName.
IEwClassificationX::newEwClass
IEwClassX newEwClass(EwErrorCode *errorCode)
Create a new node in electrical classification.
IEwEnvironmentObjectX
This interface is a generic interface for environment object methods.
Definition: EwObjectBaseObjects.idl:293
IEwObjectX
This interface is a generic interface for standard object methods.
Definition: EwObjectBaseObjects.idl:97
Generated on Thu Aug 25 2022 16:02:38 for SOLIDWORKS Electrical API by doxygen 1.9.4


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/EwClassificationObjects.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) 2023 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