Skip to main content

DPF Cpp Client Library 2026 R1

Class ansys::dpf::Streams

Last update: 25.03.2026

Defines an open, ready-to-use, data sources.

Streams is an entity containing the data sources. Once the files in the streams are opened, they stay opened and they keep some data in cache to make the next evaluations faster. To close the files, release the streams.

Inherits from:

Members

Friends

Public functions

Function ~Streams

virtual ansys::dpf::Streams::~Streams()

Return type:

Function Streams

ansys::dpf::Streams::Streams(DataSources const &dataSources, bool open_files=false)

Create a stream from given data sources.

Parameters:

  • DataSources const & dataSources: [in] Data source from which to create stream.
  • bool open_files = false : [in] Wether files defined in the dataSources are opened at the creation of the Streams (default false).

Return type:

Function Streams

ansys::dpf::Streams::Streams(Streams const &)

Parameters:

  • Streams const &

Return type:

Function Streams

ansys::dpf::Streams::Streams(Streams &&) noexcept

Parameters:

  • Streams &&

Return type:

Function Streams

ansys::dpf::Streams::Streams(int id, Client const *const client)

Retrieve an existing instance of Streams on a server.

Parameters:

  • int id: [in] Id of the Streams on the server's database.
  • Client const *const client: [in] Client instance designating the IP, port and protocol to use.

Return type:

Function operator=

Streams & ansys::dpf::Streams::operator=(Streams const &)

Parameters:

  • Streams const &

Return type: Streams &

Function operator=

Streams & ansys::dpf::Streams::operator=(Streams &&) noexcept

Parameters:

  • Streams &&

Return type: Streams &

Function releaseFiles

void ansys::dpf::Streams::releaseFiles()

Closes all files and releases file resources.

Return type: void

Function addStream

void ansys::dpf::Streams::addStream(ExternalStream *stream)

Add external stream.

Parameters:

Return type: void

Function addStream

void ansys::dpf::Streams::addStream(ExternalStream *stream, LabelSpace const &identifier)

Add external stream.

Parameters:

  • ExternalStream * stream: [in] External stream to add.
  • LabelSpace const & identifier: [in] Identifier returned by the data sources.

Return type: void

Function getExternalStream

ExternalStreamType *const ansys::dpf::Streams::getExternalStream(std::string const &key) const

Parameters:

  • std::string const & key

Return type: ExternalStreamType *const

Function getExternalStream

ExternalStreamType *const ansys::dpf::Streams::getExternalStream(LabelSpace const &identifier) const

Parameters:

  • LabelSpace const & identifier

Return type: ExternalStreamType *const

Function dataSources

DataSources ansys::dpf::Streams::dataSources() const

Return type: DataSources

Public static functions

Function emptyStreams

static Streams ansys::dpf::Streams::emptyStreams()

Create an empty streams. Returns:

Empty Streams.

Return type: Streams

Connect with Ansys