eisgenerator 1.0.x
Functions
Translators

Eis model string translators to translate between different description strings used by various 3rd parties. More...

Functions

std::string eis::relaxisToEis (const std::string &in, const std::vector< double > &params=std::vector< double >())
 Translates a model string for RHD instruments RelaxIS to the format used by eisgenerator.
 
std::string eis::eisToRelaxis (const std::string &in)
 Translates a string for this library to the format used by RHD instruments RelaxIS.
 
std::string eis::cdcToEis (std::string in)
 Translates a Boukamp Circuit Description Code (CDC) string into the format used by this library.
 
std::string eis::eisToCdc (const std::string &in)
 Translates a string for this library a Boukamp Circuit Description Code (CDC)
 
std::string eis::madapToEis (const std::string &in, const std::string &parameters="")
 Translates a model description string as used by the MADAP library into the format used by this library.
 
std::string eis::eisToMadap (std::string in)
 Translates a string for this library a into the format used by the MADAP library.
 
void eis::purgeEisParamBrackets (std::string &in)
 Given a eisgenerator model description string, this function will purge all the embedded parameters.
 

Detailed Description

Eis model string translators to translate between different description strings used by various 3rd parties.

Function Documentation

◆ cdcToEis()

std::string eis::cdcToEis ( std::string  in)

Translates a Boukamp Circuit Description Code (CDC) string into the format used by this library.

Exceptions
parse_errror
Parameters
inthe CDC string
Returns
the eisgenerator model string

◆ eisToCdc()

std::string eis::eisToCdc ( const std::string &  in)

Translates a string for this library a Boukamp Circuit Description Code (CDC)

Note that any parameters embedded into the eisgenerator model string will be striped and not included in the CDC.

Exceptions
parse_errror
Parameters
inthe eisgenerator model string
Returns
the CDC string

◆ eisToMadap()

std::string eis::eisToMadap ( std::string  in)

Translates a string for this library a into the format used by the MADAP library.

Note that any parameters embedded into the eisgenerator model string will be striped and not included in the MADAP string.

Exceptions
parse_errror
Parameters
inthe eisgenerator model string
Returns
the MADAP string

◆ eisToRelaxis()

std::string eis::eisToRelaxis ( const std::string &  in)

Translates a string for this library to the format used by RHD instruments RelaxIS.

Note that any parameters embedded into the eisgenerator model string will be striped and not included in the RelaxIS model.

Exceptions
parse_errror
Parameters
inthe eisgenerator model string
Returns
the RelaxIS model string

◆ madapToEis()

std::string eis::madapToEis ( const std::string &  in,
const std::string &  parameters = "" 
)

Translates a model description string as used by the MADAP library into the format used by this library.

Parameters
ina model description string as used by the MADAP library
parametersoptionally a string containing the parameters of the model in MADAP parameter format
Returns
the eisgenerator model string optionally including embedded parameters

◆ purgeEisParamBrackets()

void eis::purgeEisParamBrackets ( std::string &  in)

Given a eisgenerator model description string, this function will purge all the embedded parameters.

Parameters
inan eisgenerator model string

◆ relaxisToEis()

std::string eis::relaxisToEis ( const std::string &  in,
const std::vector< double > &  params = std::vector< double >() 
)

Translates a model string for RHD instruments RelaxIS to the format used by eisgenerator.

Exceptions
parse_errror
Parameters
inthe RelaxIS model string
paramsan optional vector of the parameters of the circuit elements
Returns
the eisgenerator model string