Skip to main content

DPF C++ client library 2023 R2

ansys::dpf::RuntimeClientConfig Class Reference

Last update: 10.07.2023

#include <dpf_api.h>

Inherits ansys::dpf::RuntimeConfig.

Public Member Functions

 RuntimeClientConfig (RuntimeClientConfig const &rhs)
 
 RuntimeClientConfig (RuntimeClientConfig &&rhs)
 
void enableCache (bool use_cache)
 
bool isCacheEnabled () const
 
void setStreamingBufferSize (int size)
 
int getStreamingBufferSize () const
 
void setStreamFloatsInsteadOfDoubles (bool use_float)
 
bool streamingFloatsInsteadOfDouble () const
 

Detailed Description

enables to set runtime configuration options to DPF Client.

Member Function Documentation

◆ enableCache()

void ansys::dpf::RuntimeClientConfig::enableCache ( bool  use_cache)

Sets whether gRPC calls should be intercepted to cache responses or not.

◆ getStreamingBufferSize()

int ansys::dpf::RuntimeClientConfig::getStreamingBufferSize ( ) const
Returns
the chunk size (in bytes) used in gRPC streaming calls.

◆ isCacheEnabled()

bool ansys::dpf::RuntimeClientConfig::isCacheEnabled ( ) const
Returns
Whether gRPC calls are intercepted to cache responses or not.

◆ setStreamFloatsInsteadOfDoubles()

void ansys::dpf::RuntimeClientConfig::setStreamFloatsInsteadOfDoubles ( bool  use_float)

Sets whether double values (8 bytes) should be converted and streamed as floats values (4 bytes) in gRPC streaming calls.

◆ setStreamingBufferSize()

void ansys::dpf::RuntimeClientConfig::setStreamingBufferSize ( int  size)

Sets the chunk size (in bytes) used in gRPC streaming calls.

◆ streamingFloatsInsteadOfDouble()

bool ansys::dpf::RuntimeClientConfig::streamingFloatsInsteadOfDouble ( ) const
Returns
Whether double values (8 bytes) are converted and streamed as floats values (4 bytes) in gRPC streaming calls.