 |
SOLIDWORKS Electrical API
2022.0.0
Electrical API
|
Go to the documentation of this file.
4 midl_pragma warning(disable:2111)
10 import "EnumDefinition.idl";
11 import "EwClassificationObjects.idl";
27 uuid(97D8E9CC-9C15-4DEF-AC7C-7BB7ED11164A),
31 helpstring(
"IEwSymbolPointX Interface"),
32 pointer_default(unique)
177 uuid(960C29C7-51FA-452E-865E-59F7C0669A7A),
181 helpstring(
"IEwSymbolCircuitX Interface"),
182 pointer_default(unique)
247 uuid(02C2A32C-B421-42C8-9A7B-48BCF979D50C),
251 helpstring(
"IEwSymbolFiltersX Interface"),
252 pointer_default(unique)
564 uuid(90C1D0BC-FDC7-4410-BB37-2A86CA6CA1EC),
568 helpstring(
"IEwSymbolX Interface"),
569 pointer_default(unique)
1084 uuid(D4CAA186-3BD6-462A-A3DC-E1DB39B7941E),
1088 helpstring(
"IEwSymbolManagerX Interface"),
1089 pointer_default(unique)
EwErrorCode getEwSymbolArray(VARIANT *vArray)
Return Array of Symbol according to filter.
BSTR getCreatedBy(EwErrorCode *eErrorCode)
Get the user name that created the current object.
void setEwSymbolCircuitCount(LONG lNbCircuit)
Set/reset the number of circuit of the filter.
void setClassNodeID(LONG lNodeID)
Set/reset the class ID of the filter.
IEwSymbolFiltersX newEwSymbolFilters()
Create a IEwSymbolFiltesrX object to get symbols af associated environment.
void setDoNotRotateAttributes(EwBooleanFiltersValue eBooleanFiltersValue)
Set the value of "do not rotate attributes" of the filter.
EwErrorCode deleteEwSymbolCircuitAt(LONG index)
Delete a circuit from the symbol.
BOOL isAlreadyOpened(EwErrorCode *errorCode)
Check if the drawing is already opened.
IEwSymbolPointX addEwSymbolPoint(EwErrorCode *errorCode)
Create and add a connection point for the symbol.
BSTR getReference()
Get the reference of the filter.
EwErrorCode setStandard(BSTR strStandard)
Set the standard of the symbol.
DATE getModificationDate(EwErrorCode *errorCode)
Get the last modification date of the symbol.
BSTR getRootMark()
Get the root mark of the filter.
EwBooleanFiltersValue getDoNotRotateAttributes()
Get the value of "do not rotate attributes" of the filter.
void setReference(BSTR strReference)
Set/reset the reference of the filter.
LONG getClassNodeID()
Get the class ID of the filter.
LONG getEwSymbolPointCount()
Count the number of connection point in the symbol.
BSTR getTerminationTypeCode(EwErrorCode *errorCode)
Get the termination type code of the connection point.
BSTR getStandard(EwErrorCode *errorCode)
Get the standard of the symbol.
EwErrorCode setAngle(DOUBLE dAngle)
Set the angle of the connection point.
IEwSymbolX newEwSymbol()
Create a IEwSymbolX object from the associated environnement.
EwErrorCode setType(BSTR strKeyCode)
Set the type of the circuit.
EwErrorCode
All errors codes for this API.
Definition: EnumDefinition.idl:21
EwErrorCode setDescription(BSTR lgCode, BSTR val)
Set/reset the description of the filter.
EwErrorCode setEwCircuitPassingType(EwCircuitPassingType ePassingType)
Set the passing type of the circuit.
LONG getClassNodeID(EwErrorCode *errorCode)
Get the classification node ID of the symbol.
EwErrorCode deleteEwSymbolPoint(LONG index)
Delete a connection point from the symbol.
EwMeasurementType
All measurement type.
Definition: EwEnumeration.idl:273
EwSymbolType getEwSymbolType()
Get the symbol type of the filter.
DATE getModificationDateTo()
Get the "modification date to" of the filter.
EwErrorCode setManufacturer(BSTR strManufacturer)
Set the manufacturer of the symbol.
BSTR getManufacturer()
Get the manufacturer of the filter.
void setSymbolName(BSTR strName)
Set/reset the symbol name of the filter.
EwPointOrientation getEwPointOrientation(EwErrorCode *errorCode)
Get the flow direction of the connection point.
void setAssociatedMacro(BSTR strAssociatedMacro)
Set/reset the associated macro of the filter.
void setCreationDateTo(DATE creationDateTo)
Set/reset the "creation date to" of the filter.
void setEwMeasurementType(EwMeasurementType eMeasurementTypes)
Set/reset the measurement of the filter.
IEwSymbolX at(int iIndex, EwErrorCode *errorCode)
Return an IEwSymbolX at a given position from the associated environment.
EwErrorCode setEwPointOrientation(EwPointOrientation ePointOrientation)
Set the flow direction of the connection point.
void setManufacturer(BSTR strManufacturer)
Set/reset the manufacturer of the filter.
EwSymbolCrossRefType getEwSymbolCrossRefType()
Get the type of cross reference of the filter.
IEwSymbolX findEwSymbolXByName(BSTR strName, EwErrorCode *errorCode)
Find an IEwSymbolX by his Name.
Use this interface to manage filter for EwSymbolX.
Definition: EwSymbolObjects.idl:254
LONG getEwSymbolCircuitNumber(EwErrorCode *errorCode)
Get the circuit number of the connection point.
EwMeasurementType getEwMeasurementType()
Get the measurement of the filter.
IEwSymbolCircuitX addEwSymbolCircuit(BSTR strCircuitCode, EwErrorCode *errorCode)
Create and add a circuit in the symbol.
IEwClassificationX getClassification(EwErrorCode *errorCode)
Get the classification of the current symbol.
EwErrorCode insert()
Insert this object inside the current environment.
BSTR getAssociatedMacro()
Get the associated macro of the filter.
BSTR getModifiedBy(EwErrorCode *eErrorCode)
Get the last user name that modified the current object.
void setModificationDateFrom(DATE modificationDateFrom)
Set/reset the modification date from of the filter.
EwErrorCode setLibraryCode(BSTR strLibraryCode)
Set the library code of the symbol.
EwErrorCode showConnectionPoint(VARIANT_BOOL bVisible)
Show connection point.
EwErrorCode setEwSymbolCircuitNumber(LONG lCircuitNo)
Set the circuit number of the connection point.
void setModificationDateTo(DATE modificationDateTo)
Set/reset the "modification date to" of the filter.
BSTR getDescription(BSTR lgCode, EwErrorCode *errorCode)
Get the description of the filter.
Use this interface to manage a circuit inside a symbol.
Definition: EwSymbolObjects.idl:185
void setDisplayEwSymbolPoint(EwBooleanFiltersValue eBooleanFiltersValues)
Set the display connection point value of the filter.
DOUBLE getAngle(EwErrorCode *errorCode)
Get the angle of the connection point.
EwErrorCode setAssociatedMacro(BSTR strAssociatedMacro)
Set the associated macro of the symbol.
VARIANT_BOOL isConnectionPointVisible(EwErrorCode *errorCode)
Check if connection point are displayed.
DATE getCreationDate(EwErrorCode *errorCode)
Get the creation date of the symbol.
EwErrorCode setEwSymbolCrossRefType(EwSymbolCrossRefType eSymbolCrossRefType)
Set the cross reference type of the symbol.
EwErrorCode setTerminationTypeCode(BSTR strTerminationTypeCode)
Set the termination type code of the connection point.
void setRootMark(BSTR strRootMark)
Set/reset the root mark of the filter.
EwErrorCode setReference(BSTR strReference)
Set the reference of the symbol.
EwSymbolType
All types of symbol.
Definition: EwEnumeration.idl:416
DATE getCreationDateFrom()
Get the "creation date from" of the filter.
BSTR getAssociatedMacro(EwErrorCode *errorCode)
Return the associated macro of the symbol.
EwErrorCode setName(BSTR strSymbolName)
Set the name of the symbol.
void setEwSymbolCrossRefType(EwSymbolCrossRefType eSymbolCrossRefTypes)
Set/reset the type of cross reference of the filter.
LONG getEwSymbolPointCount()
Get the number of connection point of the filter.
BSTR getRootMark(EwErrorCode *errorCode)
Get the root mark of the symbol.
EwErrorCode setRootMark(BSTR strRootMark)
Set the root mark of the symbol.
EwSymbolCrossRefType
All cross reference type of symbol.
Definition: EwEnumeration.idl:443
EwErrorCode getNumber(LONG *lNo)
Get the number of the circuit.
EwErrorCode insertFromDwg(BSTR strDwgFilePath)
Insert the object inside the current environment.
EwErrorCode update()
Update the object inside the current environment.
Use this interface to manage a connection point.
Definition: EwSymbolObjects.idl:34
LONG getEwSymbolCircuitCount()
Get the number of circuit of the filter.
EwErrorCode setDescription(BSTR lgCode, BSTR strValue)
Set a description of the symbol.
EwErrorCode setYPos(DOUBLE dYValue)
Set the Y coordinate of the connection point.
EwErrorCode getType(BSTR *strKeyCode)
Get the type of the circuit.
EwMeasurementType getEwMeasurementType(EwErrorCode *errorCode)
Return the measurement type of the symbol.
void setLibraryCode(BSTR strLibraryCode)
Set/reset the library code of the filter.
BSTR getTerminalStripDrawingSymbol()
Get the TerminalStrip drawing symbol of the filter.
EwErrorCode setEwMeasurementType(EwMeasurementType eMeasurementType)
Set the measurement type of the symbol.
void setEwSymbolType(EwSymbolType eSymbolTypes)
Set/reset the symbol type of the filter.
BSTR getReference(EwErrorCode *errorCode)
Get the reference of the symbol.
LONG getID(EwErrorCode *errorCode)
Get ID of the symbol.
EwErrorCode setXPos(DOUBLE dXValue)
Set the X coordinate of the connection point.
EwSymbolType getEwSymbolType(EwErrorCode *errorCode)
Get the type of the symbol.
BSTR getName(EwErrorCode *errorCode)
Get the name of the symbol.
IEwSymbolX findEwSymbolXById(long lId, EwErrorCode *errorCode)
Find an IEwSymbolX by ID.
VARIANT getEwSymbolArray(EwErrorCode *errorCode)
return the array of IEwSymbolX of associated environment
EwErrorCode getDoNotRotateAttributes(VARIANT_BOOL *bRotate)
Get value of option "Do not rotate attributes".
EwErrorCode setDoNotRotateAttributes(VARIANT_BOOL bRotate)
Set value of option "Do not rotate attributes".
BSTR getManufacturer(EwErrorCode *errorCode)
Get the manufacturer of the symbol.
EwCircuitPassingType
All passing types of symbol circuit.
Definition: EwEnumeration.idl:669
IEwSymbolPointX getEwSymbolPointAt(LONG index, EwErrorCode *errorCode)
Get a connection point inside the symbol.
void setCreationDateFrom(DATE creationDateFrom)
Set/reset the "creation date from" of the filter.
DOUBLE getXPos(EwErrorCode *errorCode)
Get the X coordinate of the connection point.
LONG getEwSymbolCircuitCount()
Count the number of circuit in this symbol.
EwErrorCode setEwSymbolType(EwSymbolType eSymbolType)
Set the type of the symbol.
EwBooleanFiltersValue getDisplayEwSymbolPoint()
Get the display connection point value of the filter.
DOUBLE getYPos(EwErrorCode *errorCode)
Get the Y coordinate of the connection point.
BSTR getSymbolName()
Get the symbol name of the filter.
Use this interface to manage a symbol.
Definition: EwSymbolObjects.idl:571
EwErrorCode getNumber(LONG *lNo)
Get the number of the connection point.
IEwSymbolCircuitX getEwSymbolCircuitAt(LONG index, EwErrorCode *errorCode)
Get a circuit inside the symbol.
void setEwSymbolPointCount(LONG lConnectionPoint)
Set/reset the number of connection point of the filter.
DATE getCreationDateTo()
Get the "creation date to" of the filter.
EwSymbolCrossRefType getEwSymbolCrossRefType(EwErrorCode *errorCode)
Return the cross reference type of the symbol.
EwCreatorType
All creator type.
Definition: EwEnumeration.idl:260
DATE getModificationDateFrom()
Get the modification date from of the filter.
BSTR getLibraryCode(EwErrorCode *errorCode)
Get the library code of the symbol.
EwBooleanFiltersValue
All value for boolean filters.
Definition: EnumDefinition.idl:83
EwCreatorType getEwCreatorType(EwErrorCode *errorCode)
Get the creator of the symbol.
Use this interface to manage EwSymbolX objects.
Definition: EwSymbolObjects.idl:1092
EwErrorCode getEwCircuitPassingType(EwCircuitPassingType *ePassingType)
Get the passing type of the circuit.
EwErrorCode setClassNodeID(LONG lNodeId)
Set the classification node ID of the symbol.
void setTerminalStripDrawingSymbol(BSTR strTerminalStripDrawingSymbol)
Set/reset the TerminalStrip drawing symbol of the filter.
BSTR getLibraryCode()
Get the library code of the filter.
BSTR getDescription(BSTR lgCode, EwErrorCode *errorCode)
Get a description of the symbol.
EwPointOrientation
Flow direction of symbol connexion point type.
Definition: EwEnumeration.idl:658