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

#include <Endpoint.hpp>

Public Member Functions

 Endpoint (helics_endpoint hep) HELICS_NOTHROW
 
 Endpoint () HELICS_NOTHROW
 
 Endpoint (const Endpoint &endpoint) HELICS_NOTHROW
 
Endpointoperator= (const Endpoint &endpoint)
 
 operator helics_endpoint ()
 
helics_endpoint baseObject () const
 
bool isValid () const
 
bool hasMessage () const
 
void setDefaultDestination (const std::string &dest)
 
const char * getDefaultDestination () const
 
uint64_t pendingMessages () const
 
Message getMessage ()
 
Message createMessage ()
 
void sendMessage (const char *data, size_t data_size)
 
void sendMessage (const std::string &dest, const char *data, size_t data_size)
 
void sendMessage (const char *data, size_t data_size, helics_time time)
 
void sendMessage (const std::string &dest, const char *data, size_t data_size, helics_time time)
 
void sendMessage (const std::string &data)
 
void sendMessage (const std::string &dest, const std::string &data)
 
void sendMessage (const std::string &data, helics_time time)
 
void sendMessage (const std::string &dest, const std::string &data, helics_time time)
 
void sendMessage (const std::vector< char > &data)
 
void sendMessage (const std::string &dest, const std::vector< char > &data)
 
void sendMessage (const std::vector< char > &data, helics_time time)
 
void sendMessage (const std::string &dest, const std::vector< char > &data, helics_time time)
 
void sendMessage (const Message &message)
 
void sendMessageZeroCopy (Message &message)
 
const char * getName () const
 
const char * getType ()
 
const char * getInfo () const
 
void setInfo (const std::string &info)
 

Detailed Description

Class to manage helics endpoint operations

Constructor & Destructor Documentation

◆ Endpoint() [1/3]

helicscpp::Endpoint::Endpoint ( helics_endpoint  hep)
inlineexplicit

construct from a helics_endpoint object

◆ Endpoint() [2/3]

helicscpp::Endpoint::Endpoint ( )
inline

default constructor

◆ Endpoint() [3/3]

helicscpp::Endpoint::Endpoint ( const Endpoint endpoint)
inline

copy constructor

Member Function Documentation

◆ baseObject()

helics_endpoint helicscpp::Endpoint::baseObject ( ) const
inline

get the base helics_endpoint object for use in the c API functions

Referenced by helicscpp::Message::newMessageObject().

◆ createMessage()

Message helicscpp::Endpoint::createMessage ( )
inline

create a message object

References helicsEndpointCreateMessageObject().

◆ getDefaultDestination()

const char* helicscpp::Endpoint::getDefaultDestination ( ) const
inline

get the default destination for an endpoint

References helicsEndpointGetDefaultDestination().

◆ getInfo()

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

get the interface information field of the filter

References helicsEndpointGetInfo().

◆ getMessage()

Message helicscpp::Endpoint::getMessage ( )
inline

Get a packet from an endpoint

References helicsEndpointGetMessageObject().

◆ getName()

const char* helicscpp::Endpoint::getName ( ) const
inline

get the name of the endpoint

References helicsEndpointGetName().

◆ getType()

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

get the specified type of the endpoint

References helicsEndpointGetType().

◆ isValid()

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

check if the input is valid

References helics_true, and helicsEndpointIsValid().

◆ operator helics_endpoint()

helicscpp::Endpoint::operator helics_endpoint ( )
inline

cast to a helics_endpoint object

◆ operator=()

Endpoint& helicscpp::Endpoint::operator= ( const Endpoint endpoint)
inline

copy assignment

◆ pendingMessages()

uint64_t helicscpp::Endpoint::pendingMessages ( ) const
inline

Returns the number of pending receives for endpoint

References helicsEndpointPendingMessageCount().

◆ sendMessage() [1/13]

void helicscpp::Endpoint::sendMessage ( const char *  data,
size_t  data_size 
)
inline

Methods for sending a message send a data block and length

Parameters
datapointer to data location
data_sizethe length of the data

References data, and helicsEndpointSendMessageRaw().

◆ sendMessage() [2/13]

void helicscpp::Endpoint::sendMessage ( const char *  data,
size_t  data_size,
helics_time  time 
)
inline

send a data block and length

Parameters
datapointer to data location
data_sizethe length of the data
timethe time to send the message

References data, and helicsEndpointSendEventRaw().

◆ sendMessage() [3/13]

void helicscpp::Endpoint::sendMessage ( const Message message)
inline

send a message object

References helicsEndpointSendMessageObject().

◆ sendMessage() [4/13]

void helicscpp::Endpoint::sendMessage ( const std::string &  data)
inline

send a string to the target destination

Parameters
datathe information to send

References data, and helicsEndpointSendMessageRaw().

◆ sendMessage() [5/13]

void helicscpp::Endpoint::sendMessage ( const std::string &  data,
helics_time  time 
)
inline

send a string at a particular time

Parameters
datathe information to send
timethe time the message should be delivered

References data, and helicsEndpointSendEventRaw().

◆ sendMessage() [6/13]

void helicscpp::Endpoint::sendMessage ( const std::string &  dest,
const char *  data,
size_t  data_size 
)
inline

send a data block and length

Parameters
deststring name of the destination
datapointer to data location
data_sizethe length of the data

References data, and helicsEndpointSendMessageRaw().

◆ sendMessage() [7/13]

void helicscpp::Endpoint::sendMessage ( const std::string &  dest,
const char *  data,
size_t  data_size,
helics_time  time 
)
inline

send a data block and length

Parameters
destdestination to send the message to
datapointer to data location
data_sizethe length of the data
timethe time to send the message

References data, and helicsEndpointSendEventRaw().

◆ sendMessage() [8/13]

void helicscpp::Endpoint::sendMessage ( const std::string &  dest,
const std::string &  data 
)
inline

send a string to a particular destination

Parameters
destthe target endpoint to send the data to
datathe information to send

References data, and helicsEndpointSendMessageRaw().

◆ sendMessage() [9/13]

void helicscpp::Endpoint::sendMessage ( const std::string &  dest,
const std::string &  data,
helics_time  time 
)
inline

send a string to a particular destination at a particular time

Parameters
destthe target endpoint to send the data to
datathe information to send
timethe time the message should be delivered

References data, and helicsEndpointSendEventRaw().

◆ sendMessage() [10/13]

void helicscpp::Endpoint::sendMessage ( const std::string &  dest,
const std::vector< char > &  data 
)
inline

send a vector of data to a particular destination

Parameters
destthe target endpoint to send the data to
datathe information to send

References data, and helicsEndpointSendMessageRaw().

◆ sendMessage() [11/13]

void helicscpp::Endpoint::sendMessage ( const std::string &  dest,
const std::vector< char > &  data,
helics_time  time 
)
inline

send a vector of data to a particular destination at a particular time

Parameters
destthe target endpoint to send the data to
datathe information to send
timethe time the message should be delivered

References data, and helicsEndpointSendEventRaw().

◆ sendMessage() [12/13]

void helicscpp::Endpoint::sendMessage ( const std::vector< char > &  data)
inline

send a vector of data to the target destination

Parameters
datathe information to send

References data, and helicsEndpointSendMessageRaw().

◆ sendMessage() [13/13]

void helicscpp::Endpoint::sendMessage ( const std::vector< char > &  data,
helics_time  time 
)
inline

send a vector of data to the target destination at a particular time

Parameters
datathe information to send
timethe time the message should be delivered

References data, and helicsEndpointSendEventRaw().

◆ sendMessageZeroCopy()

void helicscpp::Endpoint::sendMessageZeroCopy ( Message message)
inline

◆ setDefaultDestination()

void helicscpp::Endpoint::setDefaultDestination ( const std::string &  dest)
inline

set the default destination for an endpoint

References helicsEndpointSetDefaultDestination().

◆ setInfo()

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

set the interface information field of the filter

References helicsEndpointSetInfo().


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