AbstractControlStatement

class AbstractControlStatement(element_id: ansys.api.modelcenter.v0.element_messages_pb2.ElementId, engine: ansys.modelcenter.workflow.grpc_modelcenter.engine.Engine)

Bases: ansys.modelcenter.workflow.grpc_modelcenter.abstract_renamable.AbstractRenamableElement, ansys.modelcenter.workflow.grpc_modelcenter.abstract_datapin_container.AbstractGRPCDatapinContainer, ansys.modelcenter.workflow.grpc_modelcenter.abstract_assembly_child.AbstractAssemblyChild, ansys.engineeringworkflow.api.IControlStatement, abc.ABC

Defines an abstract base class for control statements.

Control statements include driver components and assemblies.

Note

This class should not be directly instantiated by clients. Get a Workflow object from an instantiated Engine instance and use it to get valid Assembly, Component, or DriverComponent instances.

Overview

Methods

get_elements

Get all elements of the control statement.

Import detail

from ansys.modelcenter.workflow.grpc_modelcenter.abstract_control_statement import AbstractControlStatement

Method detail

AbstractControlStatement.get_elements() → Mapping[str, ansys.engineeringworkflow.api.IElement]

Get all elements of the control statement.

Because Python dictionaries are ordered, the order in which elements appear in the map may be significant, depending on the engine/workflow instance implementation. For example, some workflows may execute each element in a control statement in a defined order, which should be reflected here.

Returns:

Mapping[str, IElement]

Child elements of the control statement. Each key is the short name (relative to the parent element) of the corresponding element object.