Class ansys::dpf::Workflow
Last update: 25.03.2026
Inherits from:
Inherited by:
Members
- add
- addConnection
- addImplementation
- addInterfaceHierarchy
- addStep
- callAPI
- chainWith
- chainWith
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connectCustom
- connectWith
- connectWith
- construct
- CONSTRUCTION_STRATEGY
- describe
- discoverAllOperators
- empty
- emptyWorkflow
- enableCache
- eraseInputPin
- eraseOutputPin
- eraseWorkflowFromRegistry
- firstOperator
- generateDerivativeFor
- getCacheLevelAndDestination
- getClient
- getCopy
- getCustomOutput
- getHash
- getHashableKey
- getInterfaces
- getOperators
- getOutput
- getOutputAsAny
- getOutputBool
- getOutputBool
- getOutputCustomTypeField
- getOutputCustomTypeField
- getOutputCustomTypeFieldsContainer
- getOutputCustomTypeFieldsContainer
- getOutputCyclicSupport
- getOutputCyclicSupport
- getOutputDataSources
- getOutputDataSources
- getOutputDataTree
- getOutputDouble
- getOutputDouble
- getOutputDoubleVector
- getOutputDoubleVector
- getOutputField
- getOutputField
- getOutputFieldsContainer
- getOutputFieldsContainer
- getOutputGenericDataContainer
- getOutputGenericDataContainer
- getOutputInt
- getOutputInt
- getOutputIntVector
- getOutputIntVector
- getOutputMeshedRegion
- getOutputMeshedRegion
- getOutputMeshesContainer
- getOutputMeshesContainer
- getOutputPropertyField
- getOutputPropertyField
- getOutputResultInfo
- getOutputResultInfo
- getOutputScoping
- getOutputScoping
- getOutputScopingsContainer
- getOutputScopingsContainer
- getOutputStreams
- getOutputStreams
- getOutputString
- getOutputString
- getOutputStringField
- getOutputStringField
- getOutputSupport
- getOutputSupport
- getOutputTimeFreqSupport
- getOutputTimeFreqSupport
- getOutputUnit
- getOutputUnit
- getOutputWorkflow
- getOutputWorkflow
- getRemoteId
- getSteps
- hasBeenMovedLocally
- hasInputPin
- hasInternalObject
- hasOutputPin
- hasOutputWhenEvaluated
- instantiateOnRemote
- instantiateOnRemote
- instantiateOnRemote
- isOnCommonAPI
- isSameObject
- lastOperator
- listInputPins
- listOutputPins
- loadFromSwf
- nameInputPin
- nameOutputPin
- numberOfOperators
- operator=
- operator=
- operatorForOutput
- operatorNameByIndex
- operatorsForInput
- readFromJson
- record
- record
- renameInputPin
- renameOutputPin
- setCacheLevelAndDestination
- setHashableKey
- setStrategy
- tryReplaceWorkflowInRegistry
- Workflow
- Workflow
- Workflow
- Workflow
- Workflow
- Workflow
- Workflow
- writeToGraphViz
- writeToJson
- writeToString
- writeToSwf
- ~DpfTypes
- ~Workflow
Public types
Enumeration type CONSTRUCTION_STRATEGY
enum CONSTRUCTION_STRATEGY {
Legacy,
Hierarchical
}
Enumerator Legacy
Enumerator Hierarchical
Friends
Friend Session
Friend core
Friend Operator
Friend OperatorMain
Friend RemoteWorkflow
Friend Any
Friend Field
Friend PropertyField
Friend GenericDataContainer
Friend ConstructHelpers::construct_trait
Public functions
Function Workflow
ansys::dpf::Workflow::Workflow(bool useCache=false)
Create a new workflow.
Parameters:
- bool useCache = false
Return type:
Function Workflow
ansys::dpf::Workflow::Workflow(std::string const &workflow_string)
Create a workflow from a string.
Parameters:
- std::string const & workflow_string: [in] Workflow string definition generated by writeToString().
Return type:
Function Workflow
ansys::dpf::Workflow::Workflow(Client const *const client)
Create a new workflow on a server.
Parameters:
- Client const *const client
Return type:
Function Workflow
ansys::dpf::Workflow::Workflow(std::string const &workflow_string, Client const *const client)
Create a workflow from a string on a server.
Parameters:
- std::string const & workflow_string: [in] Workflow string definition generated by writeToString().
- Client const *const client
Return type:
Function Workflow
ansys::dpf::Workflow::Workflow(dp_id id, Client const *const client)
Retrieve an existing instance of Workflow on a server.
Parameters:
Return type:
Function ~Workflow
virtual ansys::dpf::Workflow::~Workflow()
Return type:
Function Workflow
ansys::dpf::Workflow::Workflow(Workflow const &)
Parameters:
- Workflow const &
Return type:
Function Workflow
ansys::dpf::Workflow::Workflow(Workflow &&) noexcept
Parameters:
- Workflow &&
Return type:
Function operator=
Workflow & ansys::dpf::Workflow::operator=(Workflow const &)
Parameters:
- Workflow const &
Return type: Workflow &
Function operator=
Workflow & ansys::dpf::Workflow::operator=(Workflow &&) noexcept
Parameters:
- Workflow &&
Return type: Workflow &
Function getCopy
Workflow ansys::dpf::Workflow::getCopy() const
Returns:
Copy of workflow.
Return type: Workflow
Function add
void ansys::dpf::Workflow::add(Operator &op)
Add operator to workflow.
Parameters:
- Operator & op: [in] Operator to add.
Return type: void
Function connectWith
void ansys::dpf::Workflow::connectWith(Workflow &left_workflow)
connect left_worflow to this workflow with matching input/output names.
Parameters:
- Workflow & left_workflow: [in] Workflow to add.
Return type: void
Function connectWith
void ansys::dpf::Workflow::connectWith(Workflow &left_workflow, std::map< std::string, std::string > const &connections)
connect left_worflow to this workflow with specified connections (out->in).
Parameters:
- Workflow & left_workflow: [in] Workflow to add.
- std::map< std::string, std::string > const & connections: [in] Connections map (out to in).
Return type: void
Function hasInputPin
bool ansys::dpf::Workflow::hasInputPin(std::string const &pin_name) const
Returns:
Indication of existence of given input pin.
Parameters:
- std::string const & pin_name: [in] Name of pin for which to check existence.
Return type: bool
Function hasOutputPin
bool ansys::dpf::Workflow::hasOutputPin(std::string const &pin_name) const
Returns:
Indication of existence of given output pin.
Parameters:
- std::string const & pin_name: [in] Name of in for which to check existence.
Return type: bool
Function listInputPins
std::vector< std::string > ansys::dpf::Workflow::listInputPins() const
Returns:
Vector of input pin names.
Return type: std::vector< std::string >
Function listOutputPins
std::vector< std::string > ansys::dpf::Workflow::listOutputPins() const
Returns:
Vector of output pin names.
Return type: std::vector< std::string >
Function nameInputPin
void ansys::dpf::Workflow::nameInputPin(std::string const &pin_name, int operator_input_pin, Operator &op)
Add an input name to given pin of operator.
Parameters:
- std::string const & pin_name: [in] Pin name.
- int operator_input_pin: [in] Input pin.
- Operator & op: [in] Operator to which to add pin name.
Return type: void
Function nameOutputPin
void ansys::dpf::Workflow::nameOutputPin(Operator &op, int operator_output_pin, std::string const &pin_name)
Add an output name to given pin of operator.
Parameters:
- Operator & op: [in] Operator to which to add pin name.
- int operator_output_pin: [in] Output pin.
- std::string const & pin_name: [in] Pin name.
Return type: void
Function eraseInputPin
void ansys::dpf::Workflow::eraseInputPin(std::string const &pin_name)
Removes an exposed pin.
Parameters:
- std::string const & pin_name: [in] Pin name.
Return type: void
Function eraseOutputPin
void ansys::dpf::Workflow::eraseOutputPin(std::string const &pin_name)
Removes an exposed pin.
Parameters:
- std::string const & pin_name: [in] Pin name.
Return type: void
Function writeToSwf
void ansys::dpf::Workflow::writeToSwf(std::string const &file_path) const
Write workflow to given file, in a DataProcessing format.
Parameters:
- std::string const & file_path: [in] Name of file to which to write workflow.
Return type: void
Function writeToGraphViz
void ansys::dpf::Workflow::writeToGraphViz(std::string const &file_path) const
Write workflow to given file, in a graphViz format.
Parameters:
- std::string const & file_path: [in] Name of file to which to write workflow.
Return type: void
Function writeToJson
void ansys::dpf::Workflow::writeToJson(std::string &jsonString) const
Write workflow to string in a json format. This method is currently not supporting the serialization of data which is connected to an operator of the workflow. For example, trying to write to a JSON string a workflow that contains a forward operator with scoping connected to it, the scoping is not written.
Parameters:
- std::string & jsonString
Return type: void
Function readFromJson
void ansys::dpf::Workflow::readFromJson(const std::string &jsonString)
load workflow from string in a json format.
Parameters:
- const std::string & jsonString
Return type: void
Function writeToString
std::string ansys::dpf::Workflow::writeToString() const
Write workflow to text.
Return type: std::string
Function chainWith
void ansys::dpf::Workflow::chainWith(const Workflow &wf)
Append given workflow.
Parameters:
- const Workflow & wf: [in] Workflow to add.
Return type: void
Function chainWith
void ansys::dpf::Workflow::chainWith(const Workflow &wf, const std::pair< std::string, std::string > &in_out_names)
Append given workflow. Output name is connected to input name of given workflow.
Parameters:
- const Workflow & wf: [in] Workflow to add.
- const std::pair< std::string, std::string > & in_out_names: [in] Pair of input/output names.
Return type: void
Function renameInputPin
void ansys::dpf::Workflow::renameInputPin(std::string const &old_pin_name, std::string const &new_pin_name)
Rename input pin with given name to new name.
Parameters:
- std::string const & old_pin_name: [in] Name of pin to rename.
- std::string const & new_pin_name: [in] New pin name.
Return type: void
Function renameOutputPin
void ansys::dpf::Workflow::renameOutputPin(std::string const &old_pin_name, std::string const &new_pin_name)
Rename output pin with given name to new name.
Parameters:
- std::string const & old_pin_name: [in] Name of pin to rename.
- std::string const & new_pin_name: [in] New pin name.
Return type: void
Function loadFromSwf
void ansys::dpf::Workflow::loadFromSwf(std::string const &file_path)
Load workflow from given file.
Parameters:
- std::string const & file_path: [in] Name of file from which to read workflow.
Return type: void
Function generateDerivativeFor
void ansys::dpf::Workflow::generateDerivativeFor(std::string const &output_name, std::string const &symbol_name)
Parameters:
- std::string const & output_name
- std::string const & symbol_name
Return type: void
Function hasOutputWhenEvaluated
bool ansys::dpf::Workflow::hasOutputWhenEvaluated(std::string const &pin_name)
Returns:
Indication of existence of output pin when workflow evaluated.
Parameters:
- std::string const & pin_name: [in] Name of output pin to check existence.
Return type: bool
Function numberOfOperators
dp_int ansys::dpf::Workflow::numberOfOperators() const
Returns:
Number of operators in workflow chain.
Return type: dp_int
Function operatorNameByIndex
std::string ansys::dpf::Workflow::operatorNameByIndex(dp_int index) const
Returns:
Operator name by index in workflow chain.
Parameters:
- dp_int index
Return type: std::string
Function firstOperator
Operator ansys::dpf::Workflow::firstOperator() const
Returns:
First operator in workflow chain.
Return type: Operator
Function lastOperator
Operator ansys::dpf::Workflow::lastOperator() const
Returns:
last operator in workflow chain.
Return type: Operator
Function getOperators
std::vector< Operator > ansys::dpf::Workflow::getOperators() const
Return type: std::vector< Operator >
Function getOutputField
Field ansys::dpf::Workflow::getOutputField(std::string const &pin_name)
Returns:
Field result for given output pin.
Parameters:
- std::string const & pin_name: [in] Output pin name.
Return type: Field
Function getOutputFieldsContainer
FieldsContainer ansys::dpf::Workflow::getOutputFieldsContainer(std::string const &pin_name)
Returns:
Fields container result for given output pin.
Parameters:
- std::string const & pin_name: [in] Output pin name.
Return type: FieldsContainer
Function getOutputScoping
Scoping ansys::dpf::Workflow::getOutputScoping(std::string const &pin_name)
Returns:
Scoping result for given output pin.
Parameters:
- std::string const & pin_name: [in] Output pin name.
Return type: Scoping
Function getOutputScopingsContainer
ScopingsContainer ansys::dpf::Workflow::getOutputScopingsContainer(std::string const &pin_name)
Returns:
Scopings container result for given output pin.
Parameters:
- std::string const & pin_name: [in] Output pin name.
Return type: ScopingsContainer
Function getOutputMeshesContainer
MeshesContainer ansys::dpf::Workflow::getOutputMeshesContainer(std::string const &pin_name)
Returns:
Meshes container result for given output pin.
Parameters:
- std::string const & pin_name: [in] Output pin name.
Return type: MeshesContainer
Function getOutputTimeFreqSupport
TimeFreqSupport ansys::dpf::Workflow::getOutputTimeFreqSupport(std::string const &pin_name)
Returns:
Time frequency support result for given output pin.
Parameters:
- std::string const & pin_name: [in] Output pin name.
Return type: TimeFreqSupport
Function getOutputMeshedRegion
MeshedRegion ansys::dpf::Workflow::getOutputMeshedRegion(std::string const &pin_name)
Returns:
Meshed region result for given output pin.
Parameters:
- std::string const & pin_name: [in] Output pin name.
Return type: MeshedRegion
Function getOutputResultInfo
ResultInfo ansys::dpf::Workflow::getOutputResultInfo(std::string const &pin_name)
Returns:
Result information result for given output pin.
Parameters:
- std::string const & pin_name: [in] Output pin name.
Return type: ResultInfo
Function getOutputSupport
Support ansys::dpf::Workflow::getOutputSupport(std::string const &pin_name)
Returns:
Support result for given output pin.
Parameters:
- std::string const & pin_name: [in] Output pin name.
Return type: Support
Function getOutputCyclicSupport
CyclicSupport ansys::dpf::Workflow::getOutputCyclicSupport(std::string const &pin_name)
Returns:
CyclicSupport result for given output pin.
Parameters:
- std::string const & pin_name: [in] Output pin name.
Return type: CyclicSupport
Function getOutputDataSources
DataSources ansys::dpf::Workflow::getOutputDataSources(std::string const &pin_name)
Returns:
Data sources result for given output pin.
Parameters:
- std::string const & pin_name: [in] Output pin name.
Return type: DataSources
Function getOutputStreams
Streams ansys::dpf::Workflow::getOutputStreams(std::string const &pin_name)
Returns:
Streams result for given output pin.
Parameters:
- std::string const & pin_name: [in] Output pin name.
Return type: Streams
Function getOutputPropertyField
PropertyField ansys::dpf::Workflow::getOutputPropertyField(std::string const &pin_namepin_name)
Returns:
Property field result for given output pin.
Parameters:
- std::string const & pin_namepin_name: [in] Output pin name.
Return type: PropertyField
Function getOutputUnit
Unit ansys::dpf::Workflow::getOutputUnit(std::string const &pin_name)
Returns:
Unit result for given output pin.
Parameters:
- std::string const & pin_name: [in] Output pin name.
Return type: Unit
Function getOutputWorkflow
Workflow ansys::dpf::Workflow::getOutputWorkflow(std::string const &pin_name)
Returns:
Workflow result for given output pin.
Parameters:
- std::string const & pin_name: [in] Output pin name.
Return type: Workflow
Function getOutputDataTree
DataTree ansys::dpf::Workflow::getOutputDataTree(std::string const &pin_name)
Returns:
DataTree result for given output pin.
Parameters:
- std::string const & pin_name: [in] Output pin name.
Return type: DataTree
Function getOutputStringField
StringField ansys::dpf::Workflow::getOutputStringField(std::string const &pin_name)
Returns:
StringField result for given output pin.
Parameters:
- std::string const & pin_name: [in] Output pin name.
Return type: StringField
Function getOutputCustomTypeField
CustomTypeField ansys::dpf::Workflow::getOutputCustomTypeField(std::string const &pin_name)
Returns:
CustomTypeField result for given output pin.
Parameters:
- std::string const & pin_name: [in] Output pin name.
Return type: CustomTypeField
Function getOutputGenericDataContainer
GenericDataContainer ansys::dpf::Workflow::getOutputGenericDataContainer(std::string const &pin_name)
Returns:
GenericDataContainer result for given output pin.
Parameters:
- std::string const & pin_name: [in] Output pin name.
Return type: GenericDataContainer
Function getOutputCustomTypeFieldsContainer
CustomTypeFieldsContainer ansys::dpf::Workflow::getOutputCustomTypeFieldsContainer(std::string const &pin_name)
Returns:
CustomTypeFieldsContainer result for given output pin.
Parameters:
- std::string const & pin_name: [in] Output pin name.
Return type: CustomTypeFieldsContainer
Function getOutputInt
dp_int ansys::dpf::Workflow::getOutputInt(std::string const &pin_name)
Returns:
Integer result for given output pin.
Parameters:
- std::string const & pin_name: [in] Output pin name.
Return type: dp_int
Function getOutputDouble
dp_double ansys::dpf::Workflow::getOutputDouble(std::string const &pin_name)
Returns:
Double result for given output pin.
Parameters:
- std::string const & pin_name: [in] Output pin name.
Return type: dp_double
Function getOutputBool
bool ansys::dpf::Workflow::getOutputBool(std::string const &pin_name)
Returns:
Boolean result for given output pin.
Parameters:
- std::string const & pin_name: [in] Output pin name.
Return type: bool
Function getOutputString
std::string ansys::dpf::Workflow::getOutputString(std::string const &pin_index)
Returns:
String result for given output pin.
Parameters:
- std::string const & pin_index: [in] Output pin name.
Return type: std::string
Function getOutputAsAny
Any ansys::dpf::Workflow::getOutputAsAny(std::string const &pin_name)
Returns:
Any result for given output pin.
Parameters:
- std::string const & pin_name: [in] Output pin name.
Return type: Any
Function getOutputIntVector
DpfVector< int > ansys::dpf::Workflow::getOutputIntVector(std::string const &pin_name)
Returns:
Integers vector result as DpfVector for given output pin.
Parameters:
- std::string const & pin_name: [in] Output pin name.
Return type: DpfVector< int >
Function getOutputDoubleVector
DpfVector< double > ansys::dpf::Workflow::getOutputDoubleVector(std::string const &pin_name)
Returns:
Doubles vector result as DpfVector for given output pin.
Parameters:
- std::string const & pin_name: [in] Output pin name.
Return type: DpfVector< double >
Function getCustomOutput
DataT ansys::dpf::Workflow::getCustomOutput(std::string const &pin_name)
Returns:
Custom result for given output pin.
Parameters:
- std::string const & pin_name: [in] Output pin name.
Return type: DataT
Function getOutput
DataT ansys::dpf::Workflow::getOutput(std::string const &pin_name)
Returns:
Typed result for given output pin.
Parameters:
- std::string const & pin_name: [in] Output pin name.
Return type: DataT
Function getOutputField
Field ansys::dpf::Workflow::getOutputField(std::string const &pin_name, DpfError &error)
Returns:
Field result for given output pin.
Parameters:
- std::string const & pin_name: [in] Output pin name.
- DpfError & error: [out] Status of call.
Return type: Field
Function getOutputFieldsContainer
FieldsContainer ansys::dpf::Workflow::getOutputFieldsContainer(std::string const &pin_name, DpfError &error)
Returns:
Fields container result for given output pin.
Parameters:
- std::string const & pin_name: [in] Output pin name.
- DpfError & error: [out] Status of call.
Return type: FieldsContainer
Function getOutputScoping
Scoping ansys::dpf::Workflow::getOutputScoping(std::string const &pin_name, DpfError &error)
Returns:
Scoping result for given output pin.
Parameters:
- std::string const & pin_name: [in] Output pin name.
- DpfError & error: [out] Status of call.
Return type: Scoping
Function getOutputScopingsContainer
ScopingsContainer ansys::dpf::Workflow::getOutputScopingsContainer(std::string const &pin_name, DpfError &error)
Returns:
Scopings container result for given output pin.
Parameters:
- std::string const & pin_name: [in] Output pin name.
- DpfError & error: [out] Status of call.
Return type: ScopingsContainer
Function getOutputMeshesContainer
MeshesContainer ansys::dpf::Workflow::getOutputMeshesContainer(std::string const &pin_name, DpfError &error)
Returns:
Meshes container result for given output pin.
Parameters:
- std::string const & pin_name: [in] Output pin name.
- DpfError & error: [out] Status of call.
Return type: MeshesContainer
Function getOutputTimeFreqSupport
TimeFreqSupport ansys::dpf::Workflow::getOutputTimeFreqSupport(std::string const &pin_name, DpfError &error)
Returns:
Time frequency support result for given output pin.
Parameters:
- std::string const & pin_name: [in] Output pin name.
- DpfError & error: [out] Status of call.
Return type: TimeFreqSupport
Function getOutputMeshedRegion
MeshedRegion ansys::dpf::Workflow::getOutputMeshedRegion(std::string const &pin_name, DpfError &error)
Returns:
Meshed region result for given output pin.
Parameters:
- std::string const & pin_name: [in] Output pin name.
- DpfError & error: [out] Status of call.
Return type: MeshedRegion
Function getOutputResultInfo
ResultInfo ansys::dpf::Workflow::getOutputResultInfo(std::string const &pin_name, DpfError &error)
Returns:
Result information result for given output pin.
Parameters:
- std::string const & pin_name: [in] Output pin name.
- DpfError & error: [out] Status of call.
Return type: ResultInfo
Function getOutputSupport
Support ansys::dpf::Workflow::getOutputSupport(std::string const &pin_name, DpfError &error)
Returns:
Support result for given output pin.
Parameters:
- std::string const & pin_name: [in] Output pin name.
- DpfError & error: [out] Status of call.
Return type: Support
Function getOutputCyclicSupport
CyclicSupport ansys::dpf::Workflow::getOutputCyclicSupport(std::string const &pin_name, DpfError &error)
Returns:
CyclicSupport result for given output pin.
Parameters:
- std::string const & pin_name: [in] Output pin name.
- DpfError & error: [out] Status of call.
Return type: CyclicSupport
Function getOutputDataSources
DataSources ansys::dpf::Workflow::getOutputDataSources(std::string const &pin_name, DpfError &error)
Returns:
Data sources result for given output pin.
Parameters:
- std::string const & pin_name: [in] Output pin name.
- DpfError & error: [out] Status of call.
Return type: DataSources
Function getOutputStreams
Streams ansys::dpf::Workflow::getOutputStreams(std::string const &pin_name, DpfError &error)
Returns:
Streams result for given output pin.
Parameters:
- std::string const & pin_name: [in] Output pin name.
- DpfError & error: [out] Status of call.
Return type: Streams
Function getOutputPropertyField
PropertyField ansys::dpf::Workflow::getOutputPropertyField(std::string const &pin_name, DpfError &error)
Returns:
Property field result for given output pin.
Parameters:
- std::string const & pin_name: [in] Output pin name.
- DpfError & error: [out] Status of call.
Return type: PropertyField
Function getOutputStringField
StringField ansys::dpf::Workflow::getOutputStringField(std::string const &pin_name, DpfError &error)
Returns:
StringField result for given output pin.
Parameters:
- std::string const & pin_name: [in] Output pin name.
- DpfError & error: [out] Status of call.
Return type: StringField
Function getOutputCustomTypeField
CustomTypeField ansys::dpf::Workflow::getOutputCustomTypeField(std::string const &pin_name, DpfError &error)
Returns:
CustomTypeField result for given output pin.
Parameters:
- std::string const & pin_name: [in] Output pin name.
- DpfError & error: [out] Status of call.
Return type: CustomTypeField
Function getOutputGenericDataContainer
GenericDataContainer ansys::dpf::Workflow::getOutputGenericDataContainer(std::string const &pin_name, DpfError &error)
Returns:
GenericDataContainer result for given output pin.
Parameters:
- std::string const & pin_name: [in] Output pin name.
- DpfError & error: [out] Status of call.
Return type: GenericDataContainer
Function getOutputCustomTypeFieldsContainer
CustomTypeFieldsContainer ansys::dpf::Workflow::getOutputCustomTypeFieldsContainer(std::string const &pin_name, DpfError &error)
Returns:
CustomTypeFieldsContainer result for given output pin.
Parameters:
- std::string const & pin_name: [in] Output pin name.
- DpfError & error: [out] Status of call.
Return type: CustomTypeFieldsContainer
Function getOutputUnit
Unit ansys::dpf::Workflow::getOutputUnit(std::string const &pin_name, DpfError &error)
Returns:
Unit result for given output pin.
Parameters:
- std::string const & pin_name: [in] Output pin name.
- DpfError & error: [out] Status of call.
Return type: Unit
Function getOutputWorkflow
Workflow ansys::dpf::Workflow::getOutputWorkflow(std::string const &pin_name, DpfError &error)
Returns:
Workflow result for given output pin.
Parameters:
- std::string const & pin_name: [in] Output pin name.
- DpfError & error: [out] Status of call.
Return type: Workflow
Function getOutputInt
dp_int ansys::dpf::Workflow::getOutputInt(std::string const &pin_name, DpfError &error)
Returns:
Integer result for given output pin.
Parameters:
- std::string const & pin_name: [in] Output pin name.
- DpfError & error: [out] Status of call.
Return type: dp_int
Function getOutputDouble
dp_double ansys::dpf::Workflow::getOutputDouble(std::string const &pin_name, DpfError &error)
Returns:
Double result for given output pin.
Parameters:
- std::string const & pin_name: [in] Output pin name.
- DpfError & error: [out] Status of call.
Return type: dp_double
Function getOutputBool
bool ansys::dpf::Workflow::getOutputBool(std::string const &pin_name, DpfError &error)
Returns:
Boolean result for given output pin.
Parameters:
- std::string const & pin_name: [in] Output pin name.
- DpfError & error: [out] Status of call.
Return type: bool
Function getOutputString
std::string ansys::dpf::Workflow::getOutputString(std::string const &pin_name, DpfError &error)
Returns:
String result for given output pin.
Parameters:
- std::string const & pin_name: [in] Output pin name.
- DpfError & error: [out] Status of call.
Return type: std::string
Function getOutputIntVector
DpfVector< int > ansys::dpf::Workflow::getOutputIntVector(std::string const &pin_name, DpfError &error)
Returns:
Integers vector result as DpfVector for given output pin.
Parameters:
- std::string const & pin_name: [in] Output pin name.
- DpfError & error: [out] Status of call.
Return type: DpfVector< int >
Function getOutputDoubleVector
DpfVector< double > ansys::dpf::Workflow::getOutputDoubleVector(std::string const &pin_name, DpfError &error)
Returns:
Doubles vector result as DpfVector for given output pin.
Parameters:
- std::string const & pin_name: [in] Output pin name.
- DpfError & error: [out] Status of call.
Return type: DpfVector< double >
Function connect
void ansys::dpf::Workflow::connect(std::string const &pin_name, std::string const &f)
Connect string to input pin. Exceptions:
Parameters:
- std::string const & pin_name: [in] Input pin name.
- std::string const & f: [in] String data.
Return type: void
Function connect
void ansys::dpf::Workflow::connect(std::string const &pin_name, dp_int f)
Connect integer to input pin. Exceptions:
Parameters:
- std::string const & pin_name: [in] Input pin name.
- dp_int f: [in] Integer data.
Return type: void
Function connect
void ansys::dpf::Workflow::connect(std::string const &pin_name, bool f)
Connect boolean to input pin. Exceptions:
Parameters:
- std::string const & pin_name: [in] Input pin name.
- bool f: [in] Boolean data.
Return type: void
Function connect
void ansys::dpf::Workflow::connect(std::string const &pin_name, dp_double f)
Connect double to input pin. Exceptions:
Parameters:
- std::string const & pin_name: [in] Input pin name.
- dp_double f: [in] Double data.
Return type: void
Function connect
void ansys::dpf::Workflow::connect(std::string const &pin_name, std::vector< int > const &f)
Connect vector of integers to input pin. Exceptions:
Parameters:
- std::string const & pin_name: [in] Input pin name.
- std::vector< int > const & f: [in] Vector of integers data.
Return type: void
Function connect
void ansys::dpf::Workflow::connect(std::string const &pin_name, std::vector< dp_double > const &f)
Connect vector of doubles to input pin. Exceptions:
Parameters:
- std::string const & pin_name: [in] Input pin name.
- std::vector< dp_double > const & f: [in] Vector of doubles data.
Return type: void
Function connect
void ansys::dpf::Workflow::connect(std::string const &pin_name, std::vector< std::string > const &f)
Connect vector of strings to input pin. Exceptions:
Parameters:
- std::string const & pin_name: [in] Input pin name.
- std::vector< std::string > const & f: [in] Vector of strings data.
Return type: void
Function connect
void ansys::dpf::Workflow::connect(std::string const &pin_name, Scoping const &data)
Connect Scoping data to input_pin. Exceptions:
Parameters:
- std::string const & pin_name: [in] Input pin.
- Scoping const & data: [in] Scoping data to connect to pin.
Return type: void
Function connect
void ansys::dpf::Workflow::connect(std::string const &pin_name, Field const &f)
Connect field to input pin. Exceptions:
Parameters:
- std::string const & pin_name: [in] Input pin name.
- Field const & f: [in] Field data.
Return type: void
Function connect
void ansys::dpf::Workflow::connect(std::string const &pin_name, FieldsContainer const &f)
Connect fields container to input pin. Exceptions:
Parameters:
- std::string const & pin_name: [in] Input pin name.
- FieldsContainer const & f: [in] Fields container data.
Return type: void
Function connect
void ansys::dpf::Workflow::connect(std::string const &pin_name, ScopingsContainer const &f)
Connect scopings container to input pin. Exceptions:
Parameters:
- std::string const & pin_name: [in] Input pin name.
- ScopingsContainer const & f: [in] Scopings container data.
Return type: void
Function connect
void ansys::dpf::Workflow::connect(std::string const &pin_name, MeshesContainer const &f)
Connect meshes container to input pin. Exceptions:
Parameters:
- std::string const & pin_name: [in] Input pin name.
- MeshesContainer const & f: [in] Meshes container data.
Return type: void
Function connect
void ansys::dpf::Workflow::connect(std::string const &pin_name, MeshedRegion const &f)
Connect mesed region to input pin. Exceptions:
Parameters:
- std::string const & pin_name: [in] Input pin name.
- MeshedRegion const & f: [in] Meshed region data.
Return type: void
Function connect
void ansys::dpf::Workflow::connect(std::string const &pin_name, PropertyField const &f)
Connect property field to input pin. Exceptions:
Parameters:
- std::string const & pin_name: [in] Input pin name.
- PropertyField const & f: [in] Property field data.
Return type: void
Function connect
void ansys::dpf::Workflow::connect(std::string const &pin_name, Support const &f)
Connect support to input pin. Exceptions:
Parameters:
Return type: void
Function connect
void ansys::dpf::Workflow::connect(std::string const &pin_name, TimeFreqSupport const &f)
Connect time frequency support to input pin. Exceptions:
Parameters:
- std::string const & pin_name: [in] Input pin name.
- TimeFreqSupport const & f: [in] Time frequency support data.
Return type: void
Function connect
void ansys::dpf::Workflow::connect(std::string const &pin_name, CyclicSupport const &f)
Connect CyclicSupport to input pin. Exceptions:
Parameters:
- std::string const & pin_name: [in] Input pin name.
- CyclicSupport const & f: [in] Time frequency support data.
Return type: void
Function connect
void ansys::dpf::Workflow::connect(std::string const &pin_name, Workflow const &f)
Connect Workflow to input pin. Exceptions:
Parameters:
- std::string const & pin_name: [in] Input pin name.
- Workflow const & f: [in] Workflow data.
Return type: void
Function connect
void ansys::dpf::Workflow::connect(std::string const &pin_name, DataSources const &f)
Connect data sources to input pin. Exceptions:
Parameters:
- std::string const & pin_name: [in] Input pin name.
- DataSources const & f: [in] Data sources data.
Return type: void
Function connect
void ansys::dpf::Workflow::connect(std::string const &pin_name, Streams const &f)
Connect Streams to input pin. Exceptions:
Parameters:
Return type: void
Function connect
void ansys::dpf::Workflow::connect(std::string const &pin_name, DataTree const &f)
Connect DataTree to input pin. Exceptions:
Parameters:
Return type: void
Function connect
void ansys::dpf::Workflow::connect(std::string const &pin_name, StringField const &f)
Connect StringField to input pin. Exceptions:
Parameters:
- std::string const & pin_name: [in] Input pin name.
- StringField const & f: [in] StringField data.
Return type: void
Function connect
void ansys::dpf::Workflow::connect(std::string const &pin_name, CustomTypeField const &f)
Connect CustomTypeField to input pin. Exceptions:
Parameters:
- std::string const & pin_name: [in] Input pin name.
- CustomTypeField const & f: [in] CustomTypeField data.
Return type: void
Function connect
void ansys::dpf::Workflow::connect(std::string const &pin_name, GenericDataContainer const &f)
Connect GenericDataContainer to input pin. Exceptions:
Parameters:
- std::string const & pin_name: [in] Input pin name.
- GenericDataContainer const & f: [in] GenericDataContainer data.
Return type: void
Function connect
void ansys::dpf::Workflow::connect(std::string const &pin_name, CustomTypeFieldsContainer const &f)
Connect CustomTypeFieldsContainer to input pin. Exceptions:
Parameters:
- std::string const & pin_name: [in] Input pin name.
- CustomTypeFieldsContainer const & f: [in] CustomTypeFieldsContainer data.
Return type: void
Function connect
void ansys::dpf::Workflow::connect(std::string const &pin_name, LabelSpace const &f)
Connect LabelSpace to input pin. Exceptions:
Parameters:
- std::string const & pin_name: [in] Input pin name.
- LabelSpace const & f: [in] LabelSpace data.
Return type: void
Function connect
void ansys::dpf::Workflow::connect(std::string const &pin_name, CustomContainerBase const &f)
Connect LabelSpace to input pin. Exceptions:
Parameters:
- std::string const & pin_name: [in] Input pin name.
- CustomContainerBase const & f: [in] CustomContainerBase data.
Return type: void
Function connect
void ansys::dpf::Workflow::connect(std::string const &pin_name, Collection< DataT > const &f)
Connect Any dpf type. Exceptions:
Parameters:
- std::string const & pin_name: [in] Input pin name.
- Collection< DataT > const & f: [in] Operator from which to connect output pin.
Return type: void
Function connect
void ansys::dpf::Workflow::connect(std::string const &pin_name, Any const &f)
Connect Any to input pin. Exceptions:
Parameters:
- std::string const & pin_name: [in] Input pin name.
- Any const & f: [in] Any data.
Return type: void
Function connect
void ansys::dpf::Workflow::connect(std::string const &pin_name, Operator const &f, dp_index output_pin)
Connect operator output pin to input pin. Exceptions:
Parameters:
- std::string const & pin_name: [in] Input pin name.
- Operator const & f: [in] Operator from which to connect output pin.
- dp_index output_pin: [in] Output pin.
Return type: void
Function connectCustom
void ansys::dpf::Workflow::connectCustom(std::string const &input_pin, DataT const &d)
Connect typed data to input pin. Exceptions:
Parameters:
- std::string const & input_pin: [in] Input pin name.
- DataT const & d: {in] Typed data
Return type: void
Function connect
void ansys::dpf::Workflow::connect(std::string const &pin_name, dp_int f, DpfError &error)
Connect integer to input pin.
Parameters:
- std::string const & pin_name: [in] Input pin name.
- dp_int f: [in] Integer data.
- DpfError & error: [out] Status of call.
Return type: void
Function connect
void ansys::dpf::Workflow::connect(std::string const &pin_name, bool f, DpfError &error)
Connect boolean to input pin.
Parameters:
- std::string const & pin_name: [in] Input pin name.
- bool f: [in] Boolean data.
- DpfError & error: [out] Status of call.
Return type: void
Function connect
void ansys::dpf::Workflow::connect(std::string const &pin_name, dp_double f, DpfError &error)
Connect double to input pin.
Parameters:
- std::string const & pin_name: [in] Input pin name.
- dp_double f: [in] Double data.
- DpfError & error: [out] Status of call.
Return type: void
Function connect
void ansys::dpf::Workflow::connect(std::string const &pin_name, std::string const &f, DpfError &error)
Connect string to input pin.
Parameters:
- std::string const & pin_name: [in] Input pin name.
- std::string const & f: [in] String data.
- DpfError & error: [out] Status of call.
Return type: void
Function connect
void ansys::dpf::Workflow::connect(std::string const &pin_name, std::vector< int > const &f, DpfError &error)
Connect vector of integers to input pin.
Parameters:
- std::string const & pin_name: [in] Input pin name.
- std::vector< int > const & f: [in] Vector of integer data.
- DpfError & error: [out] Status of call.
Return type: void
Function connect
void ansys::dpf::Workflow::connect(std::string const &pin_name, std::vector< dp_double > const &f, DpfError &error)
Connect vector of doubles to input pin.
Parameters:
- std::string const & pin_name: [in] Input pin name.
- std::vector< dp_double > const & f: [in] Vector of double data.
- DpfError & error: [out] Status of call.
Return type: void
Function connect
void ansys::dpf::Workflow::connect(std::string const &pin_name, std::vector< std::string > const &f, DpfError &error)
Connect vector of strings to input pin.
Parameters:
- std::string const & pin_name: [in] Input pin name.
- std::vector< std::string > const & f: [in] Vector of string data.
- DpfError & error: [out] Status of call.
Return type: void
Function connect
void ansys::dpf::Workflow::connect(std::string const &pin_name, Scoping const &f, DpfError &error)
Connect scoping to input pin.
Parameters:
- std::string const & pin_name: [in] Input pin name.
- Scoping const & f: [in] Scoping data.
- DpfError & error: [out] Status of call.
Return type: void
Function connect
void ansys::dpf::Workflow::connect(std::string const &pin_name, Field const &f, DpfError &error)
Connect field to input pin.
Parameters:
- std::string const & pin_name: [in] Input pin name.
- Field const & f: [in] Field data.
- DpfError & error: [out] Status of call.
Return type: void
Function connect
void ansys::dpf::Workflow::connect(std::string const &pin_name, FieldsContainer const &f, DpfError &error)
Connect fields container to input pin.
Parameters:
- std::string const & pin_name: [in] Input pin name.
- FieldsContainer const & f: [in] Fields container data.
- DpfError & error: [out] Status of call.
Return type: void
Function connect
void ansys::dpf::Workflow::connect(std::string const &pin_name, ScopingsContainer const &f, DpfError &error)
Connect scopings container to input pin.
Parameters:
- std::string const & pin_name: [in] Input pin name.
- ScopingsContainer const & f: [in] Scopings container data.
- DpfError & error: [out] Status of call.
Return type: void
Function connect
void ansys::dpf::Workflow::connect(std::string const &pin_name, MeshesContainer const &f, DpfError &error)
Connect meshes container to input pin.
Parameters:
- std::string const & pin_name: [in] Input pin name.
- MeshesContainer const & f: [in] Meshes container data.
- DpfError & error: [out] Status of call.
Return type: void
Function connect
void ansys::dpf::Workflow::connect(std::string const &pin_name, MeshedRegion const &f, DpfError &error)
Connect meshed region to input pin.
Parameters:
- std::string const & pin_name: [in] Input pin name.
- MeshedRegion const & f: [in] Meshed region data.
- DpfError & error: [out] Status of call.
Return type: void
Function connect
void ansys::dpf::Workflow::connect(std::string const &pin_name, DataSources const &f, DpfError &error)
Connect data sources to input pin.
Parameters:
- std::string const & pin_name: [in] Input pin name.
- DataSources const & f: [in] Data sources data.
- DpfError & error: [out] Status of call.
Return type: void
Function connect
void ansys::dpf::Workflow::connect(std::string const &pin_name, Streams const &f, DpfError &error)
Connect Streams to input pin.
Parameters:
- std::string const & pin_name: [in] Input pin name.
- Streams const & f: [in] Streams data.
- DpfError & error: [out] Status of call.
Return type: void
Function connect
void ansys::dpf::Workflow::connect(std::string const &pin_name, PropertyField const &f, DpfError &error)
Connect property field to input pin.
Parameters:
- std::string const & pin_name: [in] Input pin name.
- PropertyField const & f: [in] Property field data.
- DpfError & error: [out] Status of call.
Return type: void
Function connect
void ansys::dpf::Workflow::connect(std::string const &pin_name, Support const &f, DpfError &error)
Connect support to input pin.
Parameters:
- std::string const & pin_name: [in] Input pin name.
- Support const & f: [in] Support data.
- DpfError & error: [out] Status of call.
Return type: void
Function connect
void ansys::dpf::Workflow::connect(std::string const &pin_name, CyclicSupport const &f, DpfError &error)
Connect CyclicSupport to input pin.
Parameters:
- std::string const & pin_name: [in] Input pin name.
- CyclicSupport const & f: [in] CyclicSupport data.
- DpfError & error: [out] Status of call.
Return type: void
Function connect
void ansys::dpf::Workflow::connect(std::string const &pin_name, TimeFreqSupport const &f, DpfError &error)
Connect timefrequency support to input pin.
Parameters:
- std::string const & pin_name: [in] Input pin name.
- TimeFreqSupport const & f: [in] Time frequency support data.
- DpfError & error: [out] Status of call.
Return type: void
Function connect
void ansys::dpf::Workflow::connect(std::string const &pin_name, Workflow const &f, DpfError &error)
Connect Workflow support to input pin.
Parameters:
- std::string const & pin_name: [in] Input pin name.
- Workflow const & f: [in] Workflow support data.
- DpfError & error: [out] Status of call.
Return type: void
Function connect
void ansys::dpf::Workflow::connect(std::string const &pin_name, DataTree const &f, DpfError &error)
Connect DataTree support to input pin.
Parameters:
- std::string const & pin_name: [in] Input pin name.
- DataTree const & f: [in] DataTree support data.
- DpfError & error: [out] Status of call.
Return type: void
Function connect
void ansys::dpf::Workflow::connect(std::string const &pin_name, StringField const &f, DpfError &error)
Connect StringField support to input pin.
Parameters:
- std::string const & pin_name: [in] Input pin name.
- StringField const & f: [in] StringField data.
- DpfError & error: [out] Status of call.
Return type: void
Function connect
void ansys::dpf::Workflow::connect(std::string const &pin_name, CustomTypeField const &f, DpfError &error)
Connect CustomTypeField support to input pin.
Parameters:
- std::string const & pin_name: [in] Input pin name.
- CustomTypeField const & f: [in] CustomTypeField data.
- DpfError & error: [out] Status of call.
Return type: void
Function connect
void ansys::dpf::Workflow::connect(std::string const &pin_name, GenericDataContainer const &f, DpfError &error)
Connect GenericDataContainer support to input pin.
Parameters:
- std::string const & pin_name: [in] Input pin name.
- GenericDataContainer const & f: [in] GenericDataContainer data.
- DpfError & error: [out] Status of call.
Return type: void
Function connect
void ansys::dpf::Workflow::connect(std::string const &pin_name, CustomTypeFieldsContainer const &f, DpfError &error)
Connect CustomTypeFieldsContainer support to input pin.
Parameters:
- std::string const & pin_name: [in] Input pin name.
- CustomTypeFieldsContainer const & f: [in] CustomTypeFieldsContainer data.
- DpfError & error: [out] Status of call.
Return type: void
Function connect
void ansys::dpf::Workflow::connect(std::string const &pin_name, LabelSpace const &f, DpfError &error)
Connect LabelSpace support to input pin.
Parameters:
- std::string const & pin_name: [in] Input pin name.
- LabelSpace const & f: [in] LabelSpace data.
- DpfError & error: [out] Status of call.
Return type: void
Function connect
void ansys::dpf::Workflow::connect(std::string const &pin_name, Any const &f, DpfError &error)
Connect Any support to input pin.
Parameters:
- std::string const & pin_name: [in] Input pin name.
- Any const & f: [in] Workflow Any data.
- DpfError & error: [out] Status of call.
Return type: void
Function connect
void ansys::dpf::Workflow::connect(std::string const &pin_name, Operator const &f, dp_index output_pin, DpfError &error)
Connect operator output pin to input pin.
Parameters:
- std::string const & pin_name: [in] Input pin name.
- Operator const & f: [in] Operator from which to connect output pin.
- dp_index output_pin: [in] Output pin.
- DpfError & error: [out] Status of call.
Return type: void
Function discoverAllOperators
void ansys::dpf::Workflow::discoverAllOperators()
Using operator's connectivity, discover all operators contained in the workflow and add them inside.
Return type: void
Function record
int ansys::dpf::Workflow::record(std::string const &name, bool transfer_ownership, DpfError &error)
Records the workflow in DPF's registry.
Parameters:
- name: Name of the workflow.
- transfer_ownership: If true the workflow will be suppressed from the registry as soon as it is returned by ansys::dpf::core::workflowById.
- error: Name of the workflow.
Parameters:
- std::string const & name
- bool transfer_ownership
- DpfError & error
Return type: int
Function record
int ansys::dpf::Workflow::record(std::string const &name, bool transfer_ownership)
Records the workflow in DPF's registry.
Parameters:
- name: Name of the workflow.
- transfer_ownership: If true the workflow will be suppressed from the registry as soon as it is returned by ansys::dpf::core::workflowById.
Parameters:
- std::string const & name
- bool transfer_ownership
Return type: int
Function tryReplaceWorkflowInRegistry
bool ansys::dpf::Workflow::tryReplaceWorkflowInRegistry(int id, std::string const &name, bool transfer_ownership)
Parameters:
- int id
- std::string const & name
- bool transfer_ownership
Return type: bool
Function eraseWorkflowFromRegistry
bool ansys::dpf::Workflow::eraseWorkflowFromRegistry()
Return type: bool
Function instantiateOnRemote
Workflow ansys::dpf::Workflow::instantiateOnRemote(ansys::dpf::Client const *const client) const
Make a copy of the workflow (with writeToString) on a server.
Parameters:
- ansys::dpf::Client const *const client: [in] Client instance designating the IP, port and protocol to use.
Return type: Workflow
Function instantiateOnRemote
Workflow ansys::dpf::Workflow::instantiateOnRemote(std::string const &address, std::string const &protocol) const
Asks the server to make a copy of the workflow (with writeToString) on a server address.
Parameters:
- std::string const & address: [in] address of the server (ip:port).
- std::string const & protocol: [in] servers protocol (ex: 'grpc').
Return type: Workflow
Function instantiateOnRemote
Workflow ansys::dpf::Workflow::instantiateOnRemote(std::string const &ip, int port, std::string const &protocol) const
Asks the server to make a copy of the workflow (with writeToString) on a server address.
Parameters:
- std::string const & ip: [in] ip address of the server.
- int port: [in] port of the server.
- std::string const & protocol: [in] servers protocol (ex: 'grpc').
Return type: Workflow
Function getRemoteId
dp_id ansys::dpf::Workflow::getRemoteId() const
If the workflow is remote, returns its Id on the server.
Return type: dp_id
Function operatorsForInput
std::vector< std::pair< int, ansys::dpf::Operator > > ansys::dpf::Workflow::operatorsForInput(std::string const &input_name) const
get the list of Operator s and their exposed input pin number for a given exposed input pin name.
Parameters:
- std::string const & input_name: [in] pin_name
Return type: std::vector< std::pair< int, ansys::dpf::Operator > >
Function operatorForOutput
std::pair< int, ansys::dpf::Operator > ansys::dpf::Workflow::operatorForOutput(std::string const &output_name) const
get the Operator and their exposed output pin number for a given exposed output pin name.
Parameters:
- std::string const & output_name: [in] pin_name
Return type: std::pair< int, ansys::dpf::Operator >
Function addInterfaceHierarchy
void ansys::dpf::Workflow::addInterfaceHierarchy(const Interface &parent, const Interface &child)
Add an inheritance relationship between two interfaces. BETA
Parameters:
Return type: void
Function addConnection
void ansys::dpf::Workflow::addConnection(const std::pair< Interface, Interface > &interfaces, const std::pair< std::string, std::string > &connection)
Add a pin to pin connection between two interfaces. BETA
Parameters:
- const std::pair< Interface, Interface > & interfaces
- const std::pair< std::string, std::string > & connection
Return type: void
Function addImplementation
void ansys::dpf::Workflow::addImplementation(const std::string &iName, const ansys::dpf::Workflow &wf)
Add an implementation for a given interface. BETA
Parameters:
- const std::string & iName
- const ansys::dpf::Workflow & wf
Return type: void
Function setCacheLevelAndDestination
void ansys::dpf::Workflow::setCacheLevelAndDestination(const std::string &outputPinName, const CacheInformation::LevelAndDestination &levelDestintation)
Parameters:
- const std::string & outputPinName
- const CacheInformation::LevelAndDestination & levelDestintation
Return type: void
Function getCacheLevelAndDestination
CacheInformation::LevelAndDestination ansys::dpf::Workflow::getCacheLevelAndDestination(const std::string &outputPinName)
Parameters:
- const std::string & outputPinName
Return type: CacheInformation::LevelAndDestination
Function setStrategy
void ansys::dpf::Workflow::setStrategy(const CONSTRUCTION_STRATEGY &constructionStrategy)
Parameters:
- const CONSTRUCTION_STRATEGY & constructionStrategy
Return type: void
Function getInterfaces
std::vector< Interface > ansys::dpf::Workflow::getInterfaces() const noexcept
Return type: std::vector< Interface >
Function enableCache
void ansys::dpf::Workflow::enableCache(bool b)
Parameters:
- bool b
Return type: void
Function getHashableKey
std::string ansys::dpf::Workflow::getHashableKey() const
Set and get an simpler hashable entity (here workflow identifier) instead of the full Workflow to save time
Return type: std::string
Function setHashableKey
void ansys::dpf::Workflow::setHashableKey(const std::string &unique_identifier) const
Parameters:
- const std::string & unique_identifier
Return type: void
Function getHash
size_t ansys::dpf::Workflow::getHash() const
Compute and get the hash of a workflow
Return type: size_t
Function construct
Workflow ansys::dpf::Workflow::construct()
Construct a workflow from its implementations. BETA
Return type: Workflow
Function addStep
void ansys::dpf::Workflow::addStep(const std::string &name, const WorkflowStep &step)
Set symbolic step to the workflow
Parameters:
- const std::string & name
- const WorkflowStep & step
Return type: void
Function getSteps
std::map< std::string, WorkflowStep > ansys::dpf::Workflow::getSteps()
Return type: std::map< std::string, WorkflowStep >
Public static functions
Function emptyWorkflow
static Workflow ansys::dpf::Workflow::emptyWorkflow()
Create an empty workflow. Returns:
Empty Workflow.
Return type: Workflow