helics  2.8.1
Public Member Functions | List of all members
helicscpp::Publication Class Reference

#include <Publication.hpp>

Public Member Functions

 Publication (helics_publication hpub) HELICS_NOTHROW
 
 Publication () HELICS_NOTHROW
 
 Publication (const Publication &publication)
 
Publicationoperator= (const Publication &publication)
 
 operator helics_publication () const
 
helics_publication baseObject () const
 
bool isValid () const
 
void publish (const char *data, int len)
 
void publish (const char *str)
 
void publish (const std::string &str)
 
void publish (int64_t val)
 
void publish (double val)
 
void publish (std::complex< double > cmplx)
 
void publish (const std::vector< double > &data)
 
void publish (const double *data, int length)
 
void publish (const std::string &name, double val)
 
void publish (bool val)
 
const char * getKey () const
 
const char * getUnits () const
 
const char * getType () const
 
const char * getInfo () const
 
void setInfo (const std::string &info)
 

Detailed Description

C++98 interface for a publication object

Constructor & Destructor Documentation

◆ Publication() [1/3]

helicscpp::Publication::Publication ( helics_publication  hpub)
inlineexplicit

construct from a helics_publication

◆ Publication() [2/3]

helicscpp::Publication::Publication ( )
inline

default constructor

◆ Publication() [3/3]

helicscpp::Publication::Publication ( const Publication publication)
inline

copy constructor

Member Function Documentation

◆ baseObject()

helics_publication helicscpp::Publication::baseObject ( ) const
inline

return the underlying helics_publication object

◆ getInfo()

const char* helicscpp::Publication::getInfo ( ) const
inline

get the interface information field of the publication

References helicsPublicationGetInfo().

◆ getKey()

const char* helicscpp::Publication::getKey ( ) const
inline

get the key for the publication

References helicsPublicationGetKey().

◆ getType()

const char* helicscpp::Publication::getType ( ) const
inline

get the type for the publication

References helicsPublicationGetType().

◆ getUnits()

const char* helicscpp::Publication::getUnits ( ) const
inline

get the units of the publication

References helicsPublicationGetUnits().

◆ isValid()

bool helicscpp::Publication::isValid ( ) const
inline

check if the publication is valid

References helics_true, and helicsPublicationIsValid().

◆ operator helics_publication()

helicscpp::Publication::operator helics_publication ( ) const
inline

cast operator to the underlying helics_publication object

◆ operator=()

Publication& helicscpp::Publication::operator= ( const Publication publication)
inline

copy assignment

◆ publish() [1/10]

void helicscpp::Publication::publish ( bool  val)
inline

publish a boolean value

References helics_false, helics_true, and helicsPublicationPublishBoolean().

◆ publish() [2/10]

void helicscpp::Publication::publish ( const char *  data,
int  len 
)
inline

Methods to publish values publish raw data from a pointer and length

References data, and helicsPublicationPublishRaw().

◆ publish() [3/10]

void helicscpp::Publication::publish ( const char *  str)
inline

publish a string from a char *

References helicsPublicationPublishString().

◆ publish() [4/10]

void helicscpp::Publication::publish ( const double *  data,
int  length 
)
inline

publish a vector of doubles

References data, and helicsPublicationPublishVector().

◆ publish() [5/10]

void helicscpp::Publication::publish ( const std::string &  name,
double  val 
)
inline

publish a named point with a string and double

References helicsPublicationPublishNamedPoint().

◆ publish() [6/10]

void helicscpp::Publication::publish ( const std::string &  str)
inline

publish a string value

References helicsPublicationPublishString().

◆ publish() [7/10]

void helicscpp::Publication::publish ( const std::vector< double > &  data)
inline

publish a vector of doubles

References data, and helicsPublicationPublishVector().

◆ publish() [8/10]

void helicscpp::Publication::publish ( double  val)
inline

publish a double

References helicsPublicationPublishDouble().

◆ publish() [9/10]

void helicscpp::Publication::publish ( int64_t  val)
inline

publish an int64_t value

References helicsPublicationPublishInteger().

◆ publish() [10/10]

void helicscpp::Publication::publish ( std::complex< double >  cmplx)
inline

publish a complex number

References helicsPublicationPublishComplex().

◆ setInfo()

void helicscpp::Publication::setInfo ( const std::string &  info)
inline

set the interface information field of the publication

References helicsPublicationSetInfo().


The documentation for this class was generated from the following file: