SolidWorksMakroprogrammierung

Objekt · SldWorks

Parameter-Objekt

Ein Parameter eines Attributs: liest und schreibt seinen Wert als Zahl, Text oder Vektor.

Deklaration Dim x As SldWorks.Parameter · in der englischen .NET-Hilfe: IParameter

Beschreibung

Mit Parameter liest und setzt du die Werte in einem Attribut (Attribute). Welche Parameter ein Attribut hat, legt seine Definition (AttributeDef) mit Namen, Typ und Vorgabewert fest. Der Typ ist ein Wert aus swParamType_e: Kommazahl, Text, ganze Zahl oder Vektor. Den Wert speicherst du je Konfiguration oder für alle Konfigurationen.

Ohne Beschreibung in der Hilfe sind Parameter.GetOption und Parameter.SetOption.

Zugriff

Beispiel

' Hängt an die ausgewählte Fläche ein Attribut mit einem Text-, einem Zahlen- und
' einem Vektorparameter, setzt die Werte und gibt sie nach ihrem Typ wieder aus.
' Vorbedingung: Ein Teil ist offen, eine Fläche ist ausgewählt.
' Ergebnis:     Im FeatureManager steht ein Attribut Bohrung1 (oder Bohrung2 ...),
'               die Werte stehen im Direktfenster (Strg+G).
Option Explicit

Sub main()
    Dim swApp As SldWorks.SldWorks
    Dim swModel As SldWorks.ModelDoc2
    Dim swSelMgr As SldWorks.SelectionMgr
    Dim swFace As SldWorks.Face2
    Dim swAttDef As SldWorks.AttributeDef
    Dim swAtt As SldWorks.Attribute
    Dim swParam As SldWorks.Parameter
    Dim vNamen As Variant
    Dim vWerte As Variant
    Dim i As Long

    Set swApp = Application.SldWorks
    Set swModel = swApp.ActiveDoc
    If swModel Is Nothing Then Exit Sub
    Set swSelMgr = swModel.SelectionManager
    If swSelMgr.GetSelectedObjectType3(1, -1) <> swSelFACES Then Exit Sub
    Set swFace = swSelMgr.GetSelectedObject6(1, -1)

    ' Definition mit drei Parametern anlegen und registrieren
    Set swAttDef = swApp.DefineAttribute("pubBohrung")
    swAttDef.AddParameter "Werkzeug", swParamTypeString, 0#, 0
    swAttDef.AddParameter "Tiefe", swParamTypeDouble, 0#, 0
    swAttDef.AddParameter "Richtung", swParamTypeDVector, 0#, 0
    swAttDef.Register

    ' Attribut unter einem Namen anlegen, den es im FeatureManager noch nicht gibt
    Do While swAtt Is Nothing And i < 100
        i = i + 1
        Set swAtt = swAttDef.CreateInstance5(swModel, swFace, "Bohrung" & i, 0, swThisConfiguration)
    Loop
    If swAtt Is Nothing Then Exit Sub

    ' Werte setzen, für alle Konfigurationen
    Set swParam = swAtt.GetParameter("Werkzeug")
    swParam.SetStringValue2 "Bohrer D8", swAllConfiguration, ""
    Set swParam = swAtt.GetParameter("Tiefe")
    swParam.SetDoubleValue2 0.012, swSetValue_InAllConfigurations, ""     ' 12 mm, hier in Metern
    Set swParam = swAtt.GetParameter("Richtung")
    swParam.SetVector2 0, 0, -1, swAllConfiguration, ""

    ' Werte je nach Typ lesen
    vNamen = Array("Werkzeug", "Tiefe", "Richtung")
    For i = 0 To UBound(vNamen)
        Set swParam = swAtt.GetParameter(vNamen(i))
        Select Case swParam.GetType
            Case swParamTypeString
                Debug.Print swParam.GetName & " = " & swParam.GetStringValue
            Case swParamTypeDouble, swParamTypeInteger
                Debug.Print swParam.GetName & " = " & swParam.GetDoubleValue
            Case swParamTypeDVector
                vWerte = swParam.GetVectorVB
                Debug.Print swParam.GetName & " = " & vWerte(0) & ", " & vWerte(1) & ", " & vWerte(2)
        End Select
    Next i
    swModel.ForceRebuild3 False                  ' damit der FeatureManager das Attribut zeigt
End Sub

Bemerkungen

Konfigurationen: Beim Schreiben gibst du an, für welche Konfigurationen der Wert gilt. Parameter.SetDoubleValue2 erwartet einen Wert aus swSetValueInConfiguration_e, Parameter.SetStringValue2 und Parameter.SetVector2 einen aus swInConfigurationOpts_e. Den Namen der Konfiguration brauchst du nur für eine bestimmte Konfiguration (swSetValue_InSpecificConfigurations bzw. swSpecifyConfiguration). Zeichnungen haben keine Konfigurationen, dort nimmst du „alle Konfigurationen“. Die Hilfebeispiele übergeben auch bei SetDoubleValue2 swAllConfiguration. Es hat denselben Wert 2 wie swSetValue_InAllConfigurations.

Ganze Zahlen: Nach AttributeDef.AddParameter gibt es keinen eigenen Befehl für ganzzahlige Parameter (swParamTypeInteger). Du liest und schreibst sie mit GetDoubleValue und SetDoubleValue2. Negative ganze Zahlen erlaubt SOLIDWORKS nach Angabe der Hilfe nicht, für negative Werte legst du den Parameter als swParamTypeDouble an. In SOLIDWORKS 2024 nimmt ein ganzzahliger Parameter aber -2 an und liefert es zurück. 2,7 wird zu 2 abgeschnitten.

Parameter finden: Einen Befehl, der alle Parameter eines Attributs aufzählt, haben weder Attribute noch AttributeDef. Du holst sie mit Attribute.GetParameter über die Namen, die du mit AttributeDef.AddParameter vergeben hast.

Attribute aus SAT-Dateien: Allgemeine Attribute aus importierten SAT-Dateien werden zu SOLIDWORKS-Attributen mit den Parametern „Name“ und „Value“ (Programmierhandbuch, „Accessing Attributes Imported from ACIS SAT Files“). Je nach Datentyp heißt die Definition XLTR_ATTRIBUTE_DEFINITION_DOUBLE_TYPE, …_STRING_TYPE, …_INTEGER_TYPE oder …_DVECTOR_TYPE. Vektoren dieser Art liest du mit Parameter.GetVectorVB.

Eigenschaften und Methoden

Methoden 14, davon 11 beschrieben, 3 veraltet

NameBeschreibung
GetDoubleValueLiefert den Wert eines Zahlenparameters, auch eines ganzzahligen.
GetNameLiefert den Namen des Parameters.
GetOptionOhne Beschreibung in der Hilfe. Dem Namen nach liefert die Methode eine Einstellung des Parameters.
GetStringValueLiefert den Wert eines Textparameters.
GetTypeLiefert den Datentyp des Parameters: Kommazahl, Text, ganze Zahl oder Vektor.
GetVectorLiefert die drei Werte eines Vektorparameters über drei Variablen.
GetVectorVBLiefert die drei Werte eines Vektorparameters als Array.
SetDoubleValueveraltet ersetzt durch Parameter.SetDoubleValue2
SetDoubleValue2Setzt den Wert eines Zahlenparameters, auch eines ganzzahligen, für die aktive, alle oder eine bestimmte Konfiguration.
SetOptionOhne Beschreibung in der Hilfe. Dem Namen nach setzt die Methode eine Einstellung des Parameters.
SetStringValueveraltet ersetzt durch Parameter.SetStringValue2
SetStringValue2Setzt den Wert eines Textparameters für die aktive, alle oder eine bestimmte Konfiguration.
SetVectorveraltet ersetzt durch Parameter.SetVector2
SetVector2Setzt die drei Werte eines Vektorparameters für die aktive, alle oder eine bestimmte Konfiguration.

Siehe auch

Englisches Original: IParameter in der SOLIDWORKS API-Hilfe ↗ (dort mit dem .NET-Namen)

Fragen zu diesem Befehl oder ein Befehl fehlt? Frag im Discord.