SchemaNode

class ansys.cfx.mcp.cfx.schema_cache.SchemaNode

A single indexed entry in the CFX schema tree.

Overview

Properties

is_named	Whether this schema entry represents a named-object collection.
is_parameter	Whether this schema entry represents a parameter leaf.
has_allowed_values	Whether this schema declared an explicit value set.
is_command	Whether this schema entry represents a command.

Attributes

path
kind
cfx_type
help
allowed_values
arguments

Import detail

from ansys.cfx.mcp.cfx.schema_cache import SchemaNode

Property detail

property SchemaNode.is_named: bool

Whether this schema entry represents a named-object collection.

Returns:

bool

Boolean answer for the requested condition.

property SchemaNode.is_parameter: bool

Whether this schema entry represents a parameter leaf.

Returns:

bool

Boolean answer for the requested condition.

property SchemaNode.has_allowed_values: bool

Whether this schema declared an explicit value set.

True only when the bundled configuration files attach an enum-style values list to this path. False for free-form primitives (integer/real/string without an enum cross-reference.

property SchemaNode.is_command: bool

Whether this schema entry represents a command.

Attribute detail

SchemaNode.path: str

SchemaNode.kind: str

SchemaNode.cfx_type: str

SchemaNode.help: str = ''

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

SchemaNode.arguments: tuple[CommandArgument, Ellipsis] = ()