Typen von Jobparametern

Jeder Eintrag in der parameterDefinitions Liste einer Jobvorlage deklariert einen Jobparameter. Jeder Parameter hat a name und a type und kann a descriptiondefault, a und einen userInterface Block mit alabel, a und a groupLabel control haben. Der Typ bestimmt, welche Werte der Parameter akzeptiert, welche Einschränkungsfelder er unterstützt und welches Steuerelement im Eingabedialogfeld standardmäßig für ihn angezeigt wird. Eine Vorlage bezieht sich auf den Wert als{{Param.Name}}. Die Typen lauten wie folgt.

Einige Typen sind Teil der Basisspezifikation Open Job Description. Die anderen werden durch die EXPR Erweiterung hinzugefügt, und eine Vorlage, die sie verwendet, muss EXPR in der Erweiterung aufgeführt extensions werden. Die Feld-für-Feld-Definitionen der einzelnen Typen finden Sie in den Jobparameterdefinitionen für Open Job Description auf der Website. GitHub

INT

Eine Ganzzahl, als Zahl oder als numerische Zeichenfolge. Einschränkungen:allowedValues,minValue,maxValue. Steuerung:SPIN_BOX, oder DROPDOWN_LIST wann allowedValues ist gesetzt.

FLOAT

Eine Zahl, als Zahl oder als numerische Zeichenfolge. Einschränkungen:allowedValues,minValue,maxValue. Steuerung:SPIN_BOX, oder DROPDOWN_LIST wann allowedValues ist gesetzt. Das decimals Feld legt die Anzahl der editierbaren Dezimalstellen fest.

STRING

Eine Zeichenfolge. Einschränkungen:allowedValues,minLength,maxLength. Steuerung:LINE_EDIT, oder DROPDOWN_LIST wann allowedValues ist gesetzt. Nimmt auch anMULTILINE_EDIT, und CHECK_BOX wann allowedValues gilt ein true/false Paar wie["true", "false"].

PATH

Ein Datei- oder Verzeichnispfad. Regeln für die Pfadzuweisung werden auf den Wert auf dem Worker angewendet. Einschränkungen: allowedValuesminLength,maxLength,objectType,dataFlow. Steuerung:CHOOSE_INPUT_FILE,CHOOSE_OUTPUT_FILE, oderCHOOSE_DIRECTORY, abhängig von objectType unddataFlow.

BOOL(benötigtEXPR)

trueoderfalse; die Zahlen 1 oder0; oder die Zeichenketten trueyes,on,1,false,no,off,, 0 in beliebigen Buchstaben. Keine Einschränkungen. Steuerung:CHECK_BOX.

RANGE_EXPR(benötigtEXPR)

Ein ganzzahliger Bereichsausdruck wie "1-100""1-100:10", oder"1,3,5-9". Einschränkungen:minLength,maxLength. Steuerung:LINE_EDIT.

LIST[STRING](benötigtEXPR)

Liste von Zeichenfolgen. Einschränkungen: minLength und maxLength für die Liste;item.allowedValues,item.minLength, und item.maxLength für jedes Element. Steuerung:LINE_EDIT_LIST.

LIST[PATH](benötigtEXPR)

Eine Liste von Pfaden. Regeln für die Pfadzuweisung werden auf jeden Wert angewendet. Einschränkungen: Die Liste und die Elementeinschränkungen vonLIST[STRING], plus objectType unddataFlow. Steuerung:CHOOSE_INPUT_FILE_LIST,CHOOSE_OUTPUT_FILE_LIST, oderCHOOSE_DIRECTORY_LIST, abhängig von objectType unddataFlow.

LIST[INT], LIST[FLOAT] (erfordertEXPR)

Eine Liste von Zahlen. Einschränkungen: minLength und maxLength für die Liste;item.allowedValues,item.minValue, und item.maxValue für jedes Element. Steuerung:SPIN_BOX_LIST.

LIST[BOOL](benötigtEXPR)

Eine Liste von booleschen Werten, von denen jeder dieselben Werte akzeptiert wie. BOOL Einschränkungen:minLength,. maxLength Steuerung:CHECK_BOX_LIST.

LIST[LIST[INT]](benötigtEXPR)

Eine Liste von Integer-Listen für strukturierte Eingaben, z. B. eine Adjazenzliste. Einschränkungen: verschachtelte item Einschränkungen. Steuerung:HIDDEN; für diesen Typ gibt es keine visuelle Kontrolle.

Jeder Typ akzeptiert auch HIDDEN als Steuerelement, wodurch der Parameter nicht in den Eingabedialog aufgenommen wird. Legt HIDDEN Werte fest, die eine Pipeline programmgesteuert bereitstellt.

Die LIST[PATH] Typen PATH und enthalten zwei zusätzliche Felder. objectTypeist FILE oder DIRECTORY und dataFlow istIN,OUT,INOUT, oderNONE. Jobanhänge lesen diese Felder, um zu entscheiden, welche Pfade als Eingaben hochgeladen werden sollen und welche nach Ausgaben Ausschau gehalten werden sollen. Ein PATH Parameter unterstützt auch fileFilters und fileFilterDefault für den Dateidialog. Weitere Informationen finden Sie unter Jobvorlagenelemente für Jobpakete.

Die folgenden Definitionen zeigen ein Kontrollkästchen, einen Bildbereich, eine Liste von Kameranamen und eine Liste von Eingabedateien. Die Vorlage wird aufgeführtEXPR, da sie für die letzten vier Typen erforderlich ist.

specificationVersion: 'jobtemplate-2023-09'
extensions:
  - EXPR
parameterDefinitions:
  - name: Samples
    type: INT
    default: 64
    minValue: 1
    maxValue: 4096
  - name: UseGpu
    type: BOOL
    default: false
    userInterface:
      label: Render on GPU
  - name: Frames
    type: RANGE_EXPR
    default: "1-100"
    userInterface:
      label: Frame Range
  - name: Cameras
    type: LIST[STRING]
    default: ["main", "closeup"]
    minLength: 1
    userInterface:
      label: Cameras to Render
  - name: Textures
    type: LIST[PATH]
    objectType: FILE
    dataFlow: IN
    default: []

In einer Vorlage mit der EXPR Erweiterung hat jeder Parameter einen passenden Ausdruckstyp: intfloat,string,path,bool,range_expr, oderlist[T]. Ein RANGE_EXPR oder -Listenparameter kann direkt einem Aufgabenparameter entsprechen, sodass jeder Frame oder jedes Element zu einer Aufgabe wird. range Für PATH und RawParam.Name ist der Wert soLIST[PATH], wie er vor der Pfadzuweisung als Zeichenfolge übermittelt wurde.

steps:
  - name: Render
    parameterSpace:
      taskParameterDefinitions:
        - name: Camera
          type: STRING
          range: "{{Param.Cameras}}"
        - name: Frame
          type: INT
          range: "{{Param.Frames}}"
    script:
      actions:
        onRun:
          command: render
          args:
            - "--camera"
            - "{{Task.Param.Camera}}"
            - "--frame"
            - "{{Task.Param.Frame}}"
            - "--samples"
            - "{{Param.Samples}}"
            - "{{ '--gpu' if Param.UseGpu else null }}"
            - "{{ ['--textures', Param.Textures.join(',')] if len(Param.Textures) > 0 else null }}"

Die letzten beiden Argumente sind Ausdrücke. Ein null Ergebnis fügt kein Argument hinzu, und ein Listenergebnis fügt jedes Element als separates Argument hinzu. Weitere Informationen finden Sie unter Ausdrücke in Jobvorlagen.

Um ein Job-Bundle einzureichen, das die EXPR Parametertypen verwendet, müssen die Deadline Cloud-CLI und der Einreichungsdialog in deadline bundle gui-submit und im Deadline Cloud-Monitor eine Version sein, die die Erweiterung unterstützt. Ältere Kunden lehnen Vorlagen mit diesen Typen ab.