workflow#

class ansys.fluent.core.generated.v261.object_model.workflow.Root(service, rules, path)#

Bases: PyMenu

Root group.

Classes:

`CreateCompositeTask`(service, rules, command)	CreateCompositeTask command.
`CreateNewWorkflow`(service, rules, command[, ...])	CreateNewWorkflow command.
`DeleteTasks`(service, rules, command[, path])	DeleteTasks command.
`InitializeWorkflow`(service, rules, command)	InitializeWorkflow command.
`InsertNewTask`(service, rules, command[, path])	InsertNewTask command.
`LoadState`(service, rules, command[, path])	LoadState command.
`LoadWorkflow`(service, rules, command[, path])	LoadWorkflow command.
`ResetWorkflow`(service, rules, command[, path])	ResetWorkflow command.
`SaveWorkflow`(service, rules, command[, path])	SaveWorkflow command.
`TaskObject`(service, rules[, path])
`Workflow`(service, rules, path)	Workflow group.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

class CreateCompositeTask(service, rules, command, path=None)#

Bases: PyCommand

CreateCompositeTask command.

Parameters:

ListOfTaskslist[str]

Returns:

bool

Methods:

create_instance()

Create a command-argument instance for this operation.

create_instance()#

Create a command-argument instance for this operation.

The returned PyArguments wrapper exposes the operation’s arguments for inspection and state updates. Its lifetime is registered with the underlying service so command-argument resources can be released when the wrapper is deleted.

class CreateNewWorkflow(service, rules, command, path=None)#

Bases: PyCommand

CreateNewWorkflow command.

Returns:

bool

Methods:

create_instance()

Create a command-argument instance for this operation.

create_instance()#

Create a command-argument instance for this operation.

The returned PyArguments wrapper exposes the operation’s arguments for inspection and state updates. Its lifetime is registered with the underlying service so command-argument resources can be released when the wrapper is deleted.

class DeleteTasks(service, rules, command, path=None)#

Bases: PyCommand

DeleteTasks command.

Parameters:

ListOfTaskslist[str]

Returns:

bool

Methods:

create_instance()

Create a command-argument instance for this operation.

create_instance()#

Create a command-argument instance for this operation.

The returned PyArguments wrapper exposes the operation’s arguments for inspection and state updates. Its lifetime is registered with the underlying service so command-argument resources can be released when the wrapper is deleted.

class InitializeWorkflow(service, rules, command, path=None)#

Bases: PyCommand

InitializeWorkflow command.

Parameters:

WorkflowTypestr

Returns:

bool

Methods:

create_instance()

Create a command-argument instance for this operation.

create_instance()#

Create a command-argument instance for this operation.

The returned PyArguments wrapper exposes the operation’s arguments for inspection and state updates. Its lifetime is registered with the underlying service so command-argument resources can be released when the wrapper is deleted.

class InsertNewTask(service, rules, command, path=None)#

Bases: PyCommand

InsertNewTask command.

Parameters:

CommandNamestr

Returns:

bool

Methods:

create_instance()

Create a command-argument instance for this operation.

create_instance()#

Create a command-argument instance for this operation.

The returned PyArguments wrapper exposes the operation’s arguments for inspection and state updates. Its lifetime is registered with the underlying service so command-argument resources can be released when the wrapper is deleted.

class LoadState(service, rules, command, path=None)#

Bases: PyCommand

LoadState command.

Parameters:

ListOfRootslist[str]

Returns:

bool

Methods:

create_instance()

Create a command-argument instance for this operation.

create_instance()#

Create a command-argument instance for this operation.

The returned PyArguments wrapper exposes the operation’s arguments for inspection and state updates. Its lifetime is registered with the underlying service so command-argument resources can be released when the wrapper is deleted.

class LoadWorkflow(service, rules, command, path=None)#

Bases: PyCommand

LoadWorkflow command.

Parameters:

FilePathstr

Returns:

bool

Methods:

create_instance()

Create a command-argument instance for this operation.

create_instance()#

Create a command-argument instance for this operation.

The returned PyArguments wrapper exposes the operation’s arguments for inspection and state updates. Its lifetime is registered with the underlying service so command-argument resources can be released when the wrapper is deleted.

class ResetWorkflow(service, rules, command, path=None)#

Bases: PyCommand

ResetWorkflow command.

Returns:

bool

Methods:

create_instance()

Create a command-argument instance for this operation.

create_instance()#

Create a command-argument instance for this operation.

The returned PyArguments wrapper exposes the operation’s arguments for inspection and state updates. Its lifetime is registered with the underlying service so command-argument resources can be released when the wrapper is deleted.

class SaveWorkflow(service, rules, command, path=None)#

Bases: PyCommand

SaveWorkflow command.

Parameters:

FilePathstr

Returns:

bool

Methods:

create_instance()

Create a command-argument instance for this operation.

create_instance()#

Create a command-argument instance for this operation.

The returned PyArguments wrapper exposes the operation’s arguments for inspection and state updates. Its lifetime is registered with the underlying service so command-argument resources can be released when the wrapper is deleted.

class TaskObject(service, rules, path=None)#

Bases: PyNamedObjectContainer

.

class Workflow(service, rules, path)#

Bases: PyMenu

Workflow group.

Classes:

`CurrentTask`(service, rules[, path])	Parameter CurrentTask of value type str.
`InactiveTaskList`(service, rules[, path])	Parameter InactiveTaskList of value type list[str].
`TaskList`(service, rules[, path])	Parameter TaskList of value type list[str].
`WorkflowType`(service, rules[, path])	Parameter WorkflowType of value type str.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

class CurrentTask(service, rules, path=None)#

Bases: PyTextual

Parameter CurrentTask of value type str.

class InactiveTaskList(service, rules, path=None)#

Bases: PyTextual

Parameter InactiveTaskList of value type list[str].

class TaskList(service, rules, path=None)#

Bases: PyTextual

Parameter TaskList of value type list[str].

class WorkflowType(service, rules, path=None)#

Bases: PyTextual

Parameter WorkflowType of value type str.

__init__(service, rules, path)#: __init__ method of PyMenu class.

__init__(service, rules, path)#: __init__ method of PyMenu class.