Class ansys::dpf::Session
Last update: 25.03.2026
Define a DPF session.
Inherits from:
Members
- add
- add
- addEventHandler
- callAPI
- describe
- empty
- flushWorkflows
- getClient
- getWorkflow
- getWorkflowByIndex
- hasBeenMovedLocally
- hasInternalObject
- id
- isOnCommonAPI
- isSameObject
- numberOfWorkflow
- operator=
- operator=
- Session
- Session
- Session
- Session
- ~DpfTypes
- ~Session
Public functions
Function Session
ansys::dpf::Session::Session()
Return type:
Function ~Session
ansys::dpf::Session::~Session()
Return type:
Function Session
ansys::dpf::Session::Session(Client const *const client)
Create a new Session on a server.
Parameters:
Return type:
Function Session
ansys::dpf::Session::Session(Session const &)
Parameters:
- Session const &
Return type:
Function Session
ansys::dpf::Session::Session(Session &&)=delete
Parameters:
- Session &&
Return type:
Function operator=
Session & ansys::dpf::Session::operator=(Session const &)
Parameters:
- Session const &
Return type: Session &
Function operator=
Session & ansys::dpf::Session::operator=(Session &&)=delete
Parameters:
- Session &&
Return type: Session &
Function id
std::string ansys::dpf::Session::id() const
Returns:
Id of session.
Return type: std::string
Function add
void ansys::dpf::Session::add(Workflow &wf, std::string const &identifier)
Add a workflow to session.
Parameters:
- Workflow & wf: [in] Workflow to add.
- std::string const & identifier: [out] Identifier for workflow.
Return type: void
Function add
std::string ansys::dpf::Session::add(Workflow &wf)
Add workflow to session. Returns:
Identifier for workflow.
Parameters:
- Workflow & wf: [in] Workflow to add.
Return type: std::string
Function getWorkflow
Workflow ansys::dpf::Session::getWorkflow(std::string const &identifier)
Returns:
Workflow given by identifier.
Parameters:
- std::string const & identifier: [in] Identifier of workflow.
Return type: Workflow
Function getWorkflowByIndex
Workflow ansys::dpf::Session::getWorkflowByIndex(dp_index index)
Returns:
Workflow given by index.
Parameters:
- dp_index index: [in] Index of workflow.
Return type: Workflow
Function numberOfWorkflow
dp_int ansys::dpf::Session::numberOfWorkflow() const
Returns:
Number of workflows in session.
Return type: dp_int
Function flushWorkflows
void ansys::dpf::Session::flushWorkflows()
Return type: void
Function addEventHandler
void ansys::dpf::Session::addEventHandler(EventHandler &event_handler)
Add event handler to handle status of DPF session.
Parameters:
- EventHandler & event_handler: [in] Handler for session status.
Return type: void