Seismic Drive Client API
Classes | Public Member Functions | Public Attributes | List of all members
seismicdrive::Params Struct Reference

Represents base parameters structure passed to function calls. More...

#include <Params.h>

Inheritance diagram for seismicdrive::Params:
Inheritance graph
[legend]

Classes

struct  Impl
 

Public Member Functions

 Params ()
 
 Params (const std::string &correlationId)
 
ParamswithCorrelationId (const std::string &value)
 
const std::string & getCorrelationId () const
 

Public Attributes

std::shared_ptr< Impl_impl
 

Detailed Description

Represents base parameters structure passed to function calls.

Contains correlation-id string that can help to identify individual call Allows seamless extension for evolving interface

Constructor & Destructor Documentation

◆ Params() [1/2]

seismicdrive::Params::Params ( )

◆ Params() [2/2]

seismicdrive::Params::Params ( const std::string &  correlationId)
explicit

Member Function Documentation

◆ getCorrelationId()

const std::string & seismicdrive::Params::getCorrelationId ( ) const

◆ withCorrelationId()

Params & seismicdrive::Params::withCorrelationId ( const std::string &  value)

Member Data Documentation

◆ _impl

std::shared_ptr<Impl> seismicdrive::Params::_impl

The documentation for this struct was generated from the following files: