Hide Table of Contents
SOLIDWORKS Electrical API 2024.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
211 IEwClassX duplicate (EwErrorCode* errorCode);
212
213};
214
219[
220 object,
221 uuid(BA2E432E-1AFA-4401-A0BE-4E488D1F8C7E),
222 dual,
223 nonextensible,
224 helpstring("IEwClassificationX Interface"),
225 pointer_default(unique)
226]
227interface IEwClassificationX : IEwObjectX
228{
229 /*
230 * Deprecated use IEwClassificationX getID() interface .
231 * Get the ID of the object. -1 if the object is invalid.
232 * \since 2021 SP0
233 * \param[out] errorCode EwErrorCode enum type, can be:
234 * \li EW_NO_ERROR if no error detected.
235 * \li EW_UNDEFINED_ERROR if an error occurred.
236 * \return ID of current object.
237 */
238 LONG getID (EwErrorCode* errorCode);
239
240
249 LONG getEwClassCount (EwErrorCode* errorCode);
250
251
260 EwClassificationType getClassificationType (EwErrorCode* errorCode);
261
262
272 IEwClassX findEwClassByID (LONG lClassId, EwErrorCode* errorCode);
273
274
283 VARIANT getEwClassArray (EwErrorCode* errorCode);
284
285
294 IEwClassX newEwClass (EwErrorCode* errorCode);
295
296
305 EwErrorCode set3DPartName (BSTR str3DPartName);
306
307
316 BSTR get3DPartName (EwErrorCode* errorCode);
317
318
327 EwErrorCode set2DFootprintSymbolName (BSTR str2DFootprintSymbolName);
328
329
338 BSTR get2DFootprintSymbolName (EwErrorCode* errorCode);
339
340
349 EwErrorCode set2DConnectionLabelSymbolName (BSTR str2DConnectionLabelSymbolName);
350
351
360 BSTR get2DConnectionLabelSymbolName (EwErrorCode* errorCode);
361
362
375 EwClassificationType getType (EwErrorCode* errorCode);
376
377
388 EwErrorCode moveClass (long lClassId, long lClassIdParent);
389
390
391};
392
397[
398 object,
399 uuid(7E6882FA-9A8C-46A1-AB4E-BAF9484EE7FB),
400 dual,
401 nonextensible,
402 helpstring("IEwClassificationManagerX Interface"),
403 pointer_default(unique)
404]
405interface IEwClassificationManagerX : IDispatch
406{
416 IEwClassificationX getEwClassification (EwClassificationType eClassificationType, EwErrorCode* errorCode);
417
418
427 IEwClassX newEwClass (EwErrorCode* errorCode);
428
429
438 VARIANT getEwClassArray (EwErrorCode* errorCode);
439
440
450 IEwClassX findEwClassByID (long lID, EwErrorCode* errorCode);
451
452
462 IEwClassX getEwClassAt (long lIndex, EwErrorCode* errorCode);
463
464
465
474 long getEwClassCount (EwErrorCode* errorCode);
475
476};
EwErrorCode
EwErrorCode
All errors codes for this API.
Definition: EnumDefinition.idl:24
EwClassificationType
EwClassificationType
Classification for components, symbols and manufacturer parts kComponentType 0->3 kTitleBlockType 3...
Definition: EwEnumeration.idl:583
EwClassComponentType
EwClassComponentType
All the class component types.
Definition: EwEnumeration.idl:1116
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::duplicate
IEwClassX duplicate(EwErrorCode *errorCode)
Duplicate current class.
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:406
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:228
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:307
IEwObjectX
This interface is a generic interface for standard object methods.
Definition: EwObjectBaseObjects.idl:97
Generated on Mon Aug 28 2023 13:39:20 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) 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.

0.20.21