CommandArgument

class ansys.fluent.mcp.common.path_descriptor.CommandArgument

Single keyword argument of a Fluent settings command.

Populated from Backend.get_command_arguments() — the live solver reports argument_names (ordered list) and arguments (per-name descriptor). The offline schema in settings_271.json.gz carries the same information under args on command nodes.

Overview

Methods

to_dict

Return a JSON-safe dict shape.

Attributes

name
kind
required
default
allowed_values
docstring

Import detail

from ansys.fluent.mcp.common.path_descriptor import CommandArgument

Attribute detail

CommandArgument.name: str

CommandArgument.kind: str | None = None

CommandArgument.required: bool = False

CommandArgument.default: Any = None

CommandArgument.allowed_values: tuple[Any, Ellipsis] | None = None

CommandArgument.docstring: str | None = None

Method detail

CommandArgument.to_dict() → dict[str, Any]

Return a JSON-safe dict shape.