DPF C++ client library 2023 R2

ansys::dpf::Client Class Reference

Last update: 10.07.2023

#include <dpf_api_base.h>

Inheritance diagram for ansys::dpf::Client:
ansys::dpf::DpfTypes

Public Member Functions

 Client (std::string const &ip, std::string const &port)
 
 Client (std::string const &ip, std::string const &port, LibraryHandle const &library_handle)
 
 Client (std::string const &address)
 
 Client (std::string const &address, LibraryHandle const &library_handle)
 
 Client (Client const &)
 
 Client (Client &&)
 
Client & operator= (Client const &)
 
Client & operator= (Client &&)
 
opaque::DpfObject *& internalObj ()
 
opaque::DpfObject *const internalObj () const
 
std::string getChannelAddress () const
 
std::string getProtocolName () const
 
so::API const * callAPI () const
 
- Public Member Functions inherited from ansys::dpf::DpfTypes
virtual bool empty () const
 
virtual std::string describe () const
 
so::API const * callAPI () const
 
bool isOnCommonAPI () const
 
bool getClient (Client &client) const
 
bool hasBeenMovedLocally () const
 
bool isSameObject (DpfTypes const &rhs) const
 

Static Public Member Functions

static Client emptyClient ()
 

Detailed Description

Client for remote DPF connection. A Client instance is always associated to a DPF server process. The corresponding server needs to run so that the client instance can then be correctly used. This client allows to create DPF objects on a remote server.

Constructor & Destructor Documentation

◆ Client() [1/4]

ansys::dpf::Client::Client ( std::string const &  ip,
std::string const &  port 
)

Create Client object from known ip and port.

Parameters
[in]ipserver ip
[in]portserver port

◆ Client() [2/4]

ansys::dpf::Client::Client ( std::string const &  ip,
std::string const &  port,
LibraryHandle const &  library_handle 
)

Create Client from known ip, port and library handle.

Parameters
[in]ipserver ip
[in]portserver port
[in]library_handlethe library_handle API will be used

◆ Client() [3/4]

ansys::dpf::Client::Client ( std::string const &  address)

Create Client from known address.

Parameters
[in]addressstring with 'ip::port' format.

◆ Client() [4/4]

ansys::dpf::Client::Client ( std::string const &  address,
LibraryHandle const &  library_handle 
)

Create Client from known address and library handle.

Parameters
[in]addressstring with 'ip::port' format.
[in]library_handlethe library_handle API will be used

Member Function Documentation

◆ emptyClient()

static Client ansys::dpf::Client::emptyClient ( )
static

Create an empty client.

Returns
Empty Client

◆ getChannelAddress()

std::string ansys::dpf::Client::getChannelAddress ( ) const
Returns
Address string with 'ip::port' format.

◆ getProtocolName()

std::string ansys::dpf::Client::getProtocolName ( ) const
Returns
Protocol's name.

Connect with Ansys