C++ Interface¶

Defines

RAPIDJSON_YGGDRASIL¶: Flag for checking if YggInterface.hpp has already been included.

class YggInput¶

#include <YggInterface.hpp>

C++ interface to yggInput_t functionality.

The YggInput class is a basic wrapper around the C yggInput_t structure and associated functions from the YggInterface.h header. It provides the user with C++ style access to basic input via an IPC queue.

Subclassed by YggAnyInput, YggAsciiFileInput, YggGenericInput, YggJSONArrayInput, YggJSONObjectInput, YggObjInput, YggPlyInput

Public Functions

inline YggInput(const char *name)¶

Constructor for YggInput.

Parameters:: name – [in] constant character pointer to name of input queue. This should be the argument to an input driver in the yaml specification file.

inline YggInput(const std::string name)¶

Constructor for YggInput w/ C++ std::string.

Parameters:: name – [in] const std::string Name of input queue. This should be the argument to an input driver in the yaml specification file.

inline YggInput(yggInput_t x)¶: Empty constructor for inheritance.

inline YggInput(const char *name, const char *fmt)¶

Constructor for YggInput with format.

Parameters:

name – [in] constant character pointer to name of input queue. This should be the argument to an input driver in the yaml specification file.
fmt – [in] character pointer to format string for parsing messages.

inline YggInput(const std::string name, const std::string fmt)¶

Constructor for YggInput with format.

Parameters:

name – [in] const std::string Name of input queue. This should be the argument to an input driver in the yaml specification file.
fmt – [in] const std::string Format string for parsing messages.

inline YggInput(const char *name, dtype_t *datatype)¶

Constructor for YggIntput with explicit datatype.

Parameters:

name – [in] constant character pointer to name of input queue. This should be the argument to an input driver in the yaml specification file.
datatype – [in] Pointer to a dtype_t data structure containing type informaiton. containing type information.

inline YggInput(const std::string name, dtype_t *datatype)¶

Constructor for YggIntput with explicit datatype.

Parameters:

name – [in] const std::string Name of input queue. This should be the argument to an input driver in the yaml specification file.
datatype – [in] Pointer to a dtype_t data structure containing type informaiton. containing type information.

inline void _destroy_pi()¶: Alias to allow freeing of underlying C struct at the class level.

inline ~YggInput()¶: Destructor for YggInput. See ygg_free in YggInterface.h for details.

inline yggInput_t pi()¶

Return the yggInput_t structure.

Returns:: yggInput_t structure underlying the class.

template<typename T> inline int recvVar(T &data)¶

Receive a message into a single variable.

Template Parameters:: T – Expected data type to be received.
Parameters:: data – [in] Variable to received message into.
Returns:: integer specifying if the receive was succesful. Values >= 0 indicate success.

inline int recvVar(rapidjson::Document &data)¶

inline int recv(char *data, const size_t len)¶

Receive a message shorter than YGG_MSG_MAX from the input queue. See ygg_recv in YggInterface.h for additional details.

Parameters:

data – [out] character pointer to allocated buffer where the message should be saved.
len – [in] size_t length of the allocated message buffer in bytes.

Returns:

int -1 if message could not be received. Length of the received message if message was received.

inline int recv(const int nargs, ...)¶

Receive and parse a message shorter than YGG_MSG_MAX from the input queue. See yggRecv from YggInterface.h for details.

Parameters:

nargs – [in] int Number of arguments being passed.
... – [out] mixed arguments that should be assigned parameters extracted using the format string. Since these will be assigned, they should be pointers to memory that has already been allocated.

Returns:

integer specifying if the receive was succesful. Values >= 0 indicate success.

inline int recvRealloc(const int nargs, ...)¶

Receive and parse a message from the input queue, allowing destination variables to be reallocated. The pointers passed must be on heap.

Parameters:

nargs – [in] int Number of arguments being passed.
... – [out] mixed arguments that should be assigned parameters extracted using the format string. Since these will be assigned, they should be pointers to memory that has already been allocated.

Returns:

integer specifying if the receive was succesful. Values >= 0 indicate success.

inline int recv_nolimit(char **data, const size_t len)¶

Receive a message larger than YGG_MSG_MAX from the input queue. See ygg_recv_nolimit in YggInterface.h for additional details.

Parameters:

data – [out] character pointer to allocated buffer where the message should be saved.
len – [in] size_t length of the allocated message buffer in bytes.

Returns:

int -1 if message could not be received. Length of the received message if message was received.

inline int recv_nolimit(const int nargs, ...)¶

Receive and parse a message larger than YGG_MSG_MAX from the input queue. See yggRecv from YggInterface.h for details.

Parameters:

nargs – [in] int Number of arguments being passed.
... – [out] mixed arguments that should be assigned parameters extracted using the format string. Since these will be assigned, they should be pointers to memory that has already been allocated.

Returns:

integer specifying if the receive was succesful. Values >= 0 indicate success.

class YggOutput¶

#include <YggInterface.hpp>

C++ interface to yggOutput_t functionality.

The YggOutput class is a basic wrapper around the C yggOutput_t structure and associated functions from the YggInterface.h header. It provides the user with C++ style access to basic output via an IPC queue.

Subclassed by YggAnyOutput, YggAsciiFileOutput, YggGenericOutput, YggJSONArrayOutput, YggJSONObjectOutput, YggObjOutput, YggPlyOutput

Public Functions

inline YggOutput(const char *name)¶

Constructor for YggOutput.

Parameters:: name – [in] constant character pointer to name of output queue. This should be the argument to an output driver in the yaml specification file.

inline YggOutput(const std::string name)¶

Constructor for YggOutput.

Parameters:: name – [in] const std::string name of output queue. This should be the argument to an output driver in the yaml specification file.

inline YggOutput(const char *name, const char *fmt)¶

Constructor for YggOutput with format.

Parameters:

name – [in] constant character pointer to name of output queue. This should be the argument to an output driver in the yaml specification file.
fmt – [in] character pointer to format string for formatting variables.

inline YggOutput(const std::string name, const std::string fmt)¶

Constructor for YggOutput with format.

Parameters:

name – [in] const std::string name of output queue. This should be the argument to an output driver in the yaml specification file.
fmt – [in] const std::string format string for formatting variables.

inline YggOutput(const char *name, dtype_t *datatype)¶

Constructor for YggOutput with explicit datatype.

Parameters:

name – [in] constant character pointer to name of output queue. This should be the argument to an output driver in the yaml specification file.
datatype – [in] Pointer to a dtype_t data structure containing type informaiton.

inline YggOutput(const std::string name, dtype_t *datatype)¶

Constructor for YggOutput with explicit datatype.

Parameters:

name – [in] const std::string name of output queue. This should be the argument to an output driver in the yaml specification file.
datatype – [in] Pointer to a dtype_t data structure containing type informaiton.

inline YggOutput(yggOutput_t x)¶: Empty constructor for inheritance.

inline void _destroy_pi()¶: Alias to allow freeing of underlying C struct at the class level.

inline ~YggOutput()¶: Destructor for YggOutput. See ygg_free in YggInterface.h for details.

inline yggOutput_t pi()¶

Return the yggOutput_t structure.

Returns:: yggOutput_t structure underlying the class.

template<typename T> inline int sendVar(const T &data)¶

Send a single variable as a message.

Template Parameters:: T – Type of variable to send.
Parameters:: data – [in] Variable to send as a message.
Returns:: int 0 if send succesfull, -1 if send unsuccessful.

inline int sendVar(const rapidjson::Document &data)¶

inline int send(const char *data, const size_t len)¶

Send a message smaller than YGG_MSG_MAX to the output queue. If the message is larger than YGG_MSG_MAX an error code will be returned. See ygg_send in YggInterface.h for details.

Parameters:

data – [in] character pointer to message that should be sent.
len – [in] size_t length of message to be sent.

Returns:

int 0 if send succesfull, -1 if send unsuccessful.

inline int send(const int nargs, ...)¶

Format and send a message smaller than YGG_MSG_MAX to the output queue. See yggSend from YggInterface.h for details.

Parameters:

nargs – [in] int Number of arguments being passed.
... – [in] arguments for formatting.

Returns:

integer specifying if the send was succesful. Values >= 0 indicate success.

inline int send_nolimit(const char *data, const size_t len)¶

Send a message larger than YGG_MSG_MAX to the output queue. See ygg_send_nolimit in YggInterface.h for details.

Parameters:

data – [in] character pointer to message that should be sent.
len – [in] size_t length of message to be sent.

Returns:

int 0 if send succesfull, -1 if send unsuccessful.

inline int send_nolimit(const int nargs, ...)¶

Format and send a message larger than YGG_MSG_MAX to the output queue. See yggSend from YggInterface.h for details.

Parameters:

nargs – [in] int Number of arguments being passed.
... – [in] arguments for formatting.

Returns:

integer specifying if the send was succesful. Values >= 0 indicate success.

inline int send_eof()¶

Send EOF message to output file, closing it.

Returns:: int 0 if send was succesfull. All other values indicate errors.

class YggRpc¶

#include <YggInterface.hpp>

C++ interface to yggRpc_t functionality.

The YggRpc class is a basic wrapper around the C yggRpc_t structure and associated functions from the YggInterface.h header. It provides the user with C++ style access to basic RPC messaging via IPC queues.

Subclassed by YggRpcClient, YggRpcServer

Public Functions

inline YggRpc(yggRpc_t x)¶: Empty constructor for inheritance.

inline void _destroy_pi()¶: Alias to allow freeing of underlying C struct at the class level.

inline ~YggRpc()¶: Destructor for YggRpc. See ygg_free in YggInterface.h for details.

inline yggRpc_t pi()¶

Return the yggRpc_t structure.

Returns:: yggRpc_t structure underlying the class.

inline int send(const int nargs, ...)¶

Format and send a message to an RPC output queue. See rpcSend from YggInterface.h for details.

Parameters:

nargs – [in] int Number of arguments being passed.
... – [in] arguments for formatting.

Returns:

integer specifying if the send was succesful. Values >= 0 indicate success.

inline int recv(const int nargs, ...)¶

Receive and parse a message from an RPC input queue. See rpcRecv from YggInterface.h for details.

Parameters:

nargs – [in] int Number of arguments being passed.
... – [out] mixed arguments that should be assigned parameters extracted using the format string. Since these will be assigned, they should be pointers to memory that has already been allocated.

Returns:

integer specifying if the receive was succesful. Values >= 0 indicate success.

inline int recvRealloc(const int nargs, ...)¶

Receive and parse a message from an RPC input queue, allowing destination memory to be reallocated as necessary. See rpcRecv from YggInterface.h for details.

Parameters:

nargs – [in] int Number of arguments being passed.
... – [out] mixed arguments that should be assigned parameters extracted using the format string. Since these will be assigned and reallocated if they are not large enough, they should be references to pointer for heap memory that may or may not have already been allocated.

Returns:

integer specifying if the receive was succesful. Values >= 0 indicate success.

template<typename T> inline int sendVar(const T &data)¶

Send a single variable as a message.

Template Parameters:: T – Type of variable to send.
Parameters:: data – [in] Variable to send as a message.
Returns:: int 0 if send succesfull, -1 if send unsuccessful.

inline int sendVar(const rapidjson::Document &data)¶

template<typename T> inline int recvVar(T &data)¶

Receive a message into a single variable.

Template Parameters:: T – Expected data type to be received.
Parameters:: data – [in] Variable to received message into.
Returns:: integer specifying if the receive was succesful. Values >= 0 indicate success.

inline int recvVar(rapidjson::Document &data)¶

class YggRpcServer : public YggRpc ¶

#include <YggInterface.hpp>

C++ interface to yggRpc_t server-side functionality. The YggRpcServer class is a basic wrapper around the C yggRpc_t structure and associated server-side functions from the YggInterface.h header. It provides the user with C++ style access to basic RPC server operations.

Public Functions

inline YggRpcServer(const char *name, const char *inFormat, const char *outFormat)¶

Constructor for YggRpcServer.

Parameters:

name – [in] constant character pointer name used for input and output queues.
inFormat – [in] character pointer to format that should be used for parsing input.
outFormat – [in] character pointer to format that should be used for formatting output.

inline YggRpcServer(const std::string name, const std::string inFormat, const std::string outFormat)¶

Constructor for YggRpcServer.

Parameters:

name – [in] constant std::string name used for input and output queues.
inFormat – [in] const std::string format that should be used for parsing input.
outFormat – [in] const std::string format that should be used for formatting output.

inline YggRpcServer(const std::string name, dtype_t *inType, dtype_t *outType)¶

Constructor for YggRpcServer with explicit datatype.

Parameters:

name – [in] constant std::string name used for input and output queues.
inType – [in] Pointer to a dtype_t data structure containing type info for data that will be received by the server
outType – [in] Pointer to a dtype_t data structure containing type info for data that will be sent by the server.

class YggRpcClient : public YggRpc ¶

#include <YggInterface.hpp>

C++ interface to yggRpc_t client-side functionality. The YggRpcClient class is a basic wrapper around the C yggRpc_t structure and associated client-side functions from the YggInterface.h header. It provides the user with C++ style access to basic RPC client operations.

Subclassed by YggTimesync

Public Functions

inline YggRpcClient(yggRpc_t x)¶: Empty constructor for inheritance.

inline YggRpcClient(const char *name, const char *outFormat, const char *inFormat)¶

Constructor for YggRpcClient.

Parameters:

name – [in] constant character pointer name used for input and output queues.
outFormat – [in] character pointer to format that should be used for formatting output.
inFormat – [in] character pointer to format that should be used for parsing input.

inline YggRpcClient(const std::string name, const std::string outFormat, const std::string inFormat)¶

Constructor for YggRpcClient.

Parameters:

name – [in] constant std::string name used for input and output queues.
outFormat – [in] const std::string format that should be used for formatting output.
inFormat – [in] const std::string format that should be used for parsing input.

inline YggRpcClient(const std::string name, dtype_t *outType, dtype_t *inType)¶

Constructor for YggRpcClient with explicit datatype.

Parameters:

name – [in] constant std::string name used for input and output queues.
outType – [in] Pointer to a dtype_t data structure containing type info for data that will be sent by the client.
inType – [in] Pointer to a dtype_t data structure containing type info for data that will be received by the client

inline int call(const int nargs, ...)¶

Send request to an RPC server from the client and wait for a response, preserving the current sizes of memory at the provided output variable references. See rpcCall in YggInterface.h for details.

Parameters:

nargs – [in] int Number of arguments being passed.
... – [inout] mixed arguments that include those that should be formatted using the output format string, followed by those that should be assigned parameters extracted using the input format string. These that will be assigned should be pointers to memory that has already been allocated.

Returns:

integer specifying if the receive was succesful. Values >= 0 indicate success.

inline int callRealloc(const int nargs, ...)¶

Send request to an RPC server from the client and wait for a response, allowing the memory pointed to by the pointers that the output variables reference to be reallocated. See rpcCall in YggInterface.h for details.

Parameters:

nargs – [in] int Number of arguments being passed.
... – [inout] mixed arguments that include those that should be formatted using the output format string, followed by those that should be assigned parameters extracted using the input format string. These that will be assigned should be references to pointers for heap memory that may or may not have already been allocated. These will be reallocated if they are not large enough to receive data from the incoming message.

Returns:

integer specifying if the receive was succesful. Values >= 0 indicate success.

class YggTimesync : public YggRpcClient ¶

#include <YggInterface.hpp>

C++ interface to timestep synchronization functionality. The YggTimesync class is a basic wrapper around the C yggRpc_t structure and associated client-side functions from the YggInterface.h header. It provides the user with C++ style access to basic RPC client operations.

Public Functions

inline YggTimesync(const char *name = "timesync", const char *t_units = "")¶

Constructor for YggTimesync.

Parameters:

name – [in] constant character pointer name used for input and output queues.
t_units – [in] const char* Units that should be used for the timestep. “” indicates no units.

inline YggTimesync(const std::string name = "timesync", const std::string t_units = "")¶

Constructor for YggTimesync.

Parameters:

name – [in] const std::string name used for input and output queues.
t_units – [in] const std::string Units that should be used for the timestep. “” indicates no units.

class YggAsciiFileOutput : public YggOutput ¶

#include <YggInterface.hpp>

C++ interface to yggAsciiFileOutput_t functionality. The YggAsciiFileOutput class is a basic wrapper around the C yggAsciiFileOutput_t structure and associated functions from the YggInterface.h header. It provides the user with C++ style access to basic ASCII file output operations.

Subclassed by YggAsciiArrayOutput, YggAsciiTableOutput

Public Functions

inline YggAsciiFileOutput(const char *name)¶

Constructor for YggAsciiFileOutput.

Parameters:: name – [in] constant character pointer to the name of an output channel.

inline YggAsciiFileOutput(const std::string name)¶

Constructor for YggAsciiFileOutput.

Parameters:: name – [in] constant std::string the name of an output channel.

inline YggAsciiFileOutput(yggOutput_t x)¶: Empty constructor for inheritance.

inline int send_line(const char *line)¶

Send a single line to a file or queue.

Parameters:: line – [in] character pointer to line that should be sent.
Returns:: int 0 if send was succesfull. All other values indicate errors.

class YggAsciiFileInput : public YggInput ¶

#include <YggInterface.hpp>

C++ interface to yggAsciiFileInput_t functionality. The YggAsciiFileInput class is a basic wrapper around the C yggAsciiFileInput_t structure and associated functions from the YggInterface.h header. It provides the user with C++ style access to basic ASCII file input operations.

Subclassed by YggAsciiArrayInput, YggAsciiTableInput

Public Functions

inline YggAsciiFileInput(const char *name)¶

Constructor for YggAsciiFileInput.

Parameters:: name – [in] constant character pointer to the name of an input channel.

inline YggAsciiFileInput(const std::string name)¶

Constructor for YggAsciiFileInput.

Parameters:: name – [in] constant std::string the name of an input channel.

inline YggAsciiFileInput(yggInput_t x)¶: Empty constructor for inheritance.

inline int recv_line(char *line, const size_t n)¶

Receive a single line from an associated file or queue. See af_recv_line in YggInterface.h for details.

Parameters:

line – [out] character pointer to allocate memory where the received line should be stored.
n – [in] size_t Size of the allocated memory block in bytes.

Returns:

int Number of bytes read/received. Negative values indicate that there was either an error or the EOF message was received.

class YggAsciiTableOutput : public YggAsciiFileOutput ¶

#include <YggInterface.hpp>

C++ interface to yggAsciiTableOutput_t functionality.

The YggAsciiTableOutput class is a basic wrapper around the C yggAsciiTableOutput_t structure and associated functions from the YggInterface.h header. It provides the user with C++ style access to basic ASCII table output operations.

Public Functions

inline YggAsciiTableOutput(const char *name, const char *format_str)¶

Constructor for YggAsciiTableOutput.

Parameters:

name – [in] constant character pointer to the name of an output channel.
format_str – [in] character pointer to format string that should be used to format rows into table lines.

inline YggAsciiTableOutput(const std::string name, const std::string format_str)¶

Constructor for YggAsciiTableOutput.

Parameters:

name – [in] constant std::string the name of an output channel.
format_str – [in] const std::string format string that should be used to format rows into table lines.

class YggAsciiArrayOutput : public YggAsciiFileOutput ¶

#include <YggInterface.hpp>

C++ interface to yggAsciiTableOutput_t functionality with arrays.

The YggAsciiArrayOutput class is a basic wrapper around the C yggAsciiTableOutput_t structure and associated functions from the YggInterface.h header. It provides the user with C++ style access to basic ASCII table output operations.

Public Functions

inline YggAsciiArrayOutput(const char *name, const char *format_str)¶

Constructor for YggAsciiArrayOutput.

Parameters:

name – [in] constant character pointer to the name of an output channel.
format_str – [in] character pointer to format string that should be used to format arrays into a table.

inline YggAsciiArrayOutput(const std::string name, const std::string format_str)¶

Constructor for YggAsciiArrayOutput.

Parameters:

name – [in] constant std::string the name of an output channel.
format_str – [in] const std::string format string that should be used to format arrays into a table.

class YggAsciiTableInput : public YggAsciiFileInput ¶

#include <YggInterface.hpp>

C++ interface to yggAsciiTableInput_t functionality.

The YggAsciiTableInput class is a basic wrapper around the C yggAsciiTableInput_t structure and associated functions from the YggInterface.h header. It provides the user with C++ style access to basic ASCII table input operations.

Public Functions

inline YggAsciiTableInput(const char *name)¶

Constructor for YggAsciiTableInput. Due to issues with the C++ version of vsscanf, flags and precision indicators for floating point format specifiers (e.g. e, f), must be removed so that table input can be properly parsed.

Parameters:: name – [in] constant character pointer to the name of an input channel.

inline YggAsciiTableInput(const std::string name)¶

Constructor for YggAsciiTableInput. Due to issues with the C++ version of vsscanf, flags and precision indicators for floating point format specifiers (e.g. e, f), must be removed so that table input can be properly parsed.

Parameters:: name – [in] constant std::string the name of an input channel.

class YggAsciiArrayInput : public YggAsciiFileInput ¶

#include <YggInterface.hpp>

C++ interface to yggAsciiTableInput_t functionality for arrays.

The YggAsciiArrayInput class is a basic wrapper around the C yggAsciiTableInput_t structure and associated functions from the YggInterface.h header. It provides the user with C++ style access to basic ASCII table input operations.

Public Functions

inline YggAsciiArrayInput(const char *name)¶

Constructor for YggAsciiArrayInput. Due to issues with the C++ version of vsscanf, flags and precision indicators for floating point format specifiers (e.g. e, f), must be removed so that table input can be properly parsed.

Parameters:: name – [in] constant character pointer to the name of an input channel.

inline YggAsciiArrayInput(const std::string name)¶

Constructor for YggAsciiArrayInput. Due to issues with the C++ version of vsscanf, flags and precision indicators for floating point format specifiers (e.g. e, f), must be removed so that table input can be properly parsed.

Parameters:: name – [in] constant std::string the name of an input channel.

class YggPlyOutput : public YggOutput ¶

#include <YggInterface.hpp>

C++ interface to yggPlyOutput_t functionality. The YggPlyOutput class is a basic wrapper around the C yggPlyOutput_t structure and associated functions from the YggInterface.h header. It provides the user with C++ style access to basic ASCII file output operations.

Public Functions

inline YggPlyOutput(const char *name)¶

Constructor for YggPlyOutput.

Parameters:: name – [in] constant character pointer to the name of an output channel.

inline YggPlyOutput(const std::string name)¶

Constructor for YggPlyOutput.

Parameters:: name – [in] constant std::string the name of an output channel.

inline YggPlyOutput(yggOutput_t x)¶: Empty constructor for inheritance.

class YggPlyInput : public YggInput ¶

#include <YggInterface.hpp>

C++ interface to yggPlyInput_t functionality. The YggPlyInput class is a basic wrapper around the C yggPlyInput_t structure and associated functions from the YggInterface.h header. It provides the user with C++ style access to basic ASCII file input operations.

Public Functions

inline YggPlyInput(const char *name)¶

Constructor for YggPlyInput.

Parameters:: name – [in] constant character pointer to the name of an input channel.

inline YggPlyInput(const std::string name)¶

Constructor for YggPlyInput.

Parameters:: name – [in] constant std::string the name of an input channel.

inline YggPlyInput(yggInput_t x)¶: Empty constructor for inheritance.

class YggObjOutput : public YggOutput ¶

#include <YggInterface.hpp>

C++ interface to yggObjOutput_t functionality. The YggObjOutput class is a basic wrapper around the C yggObjOutput_t structure and associated functions from the YggInterface.h header. It provides the user with C++ style access to basic ASCII file output operations.

Public Functions

inline YggObjOutput(const char *name)¶

Constructor for YggObjOutput.

Parameters:: name – [in] constant character pointer to the name of an output channel.

inline YggObjOutput(const std::string name)¶

Constructor for YggObjOutput.

Parameters:: name – [in] constant std::string the name of an output channel.

inline YggObjOutput(yggOutput_t x)¶: Empty constructor for inheritance.

class YggObjInput : public YggInput ¶

#include <YggInterface.hpp>

C++ interface to yggObjInput_t functionality. The YggObjInput class is a basic wrapper around the C yggObjInput_t structure and associated functions from the YggInterface.h header. It provides the user with C++ style access to basic ASCII file input operations.

Public Functions

inline YggObjInput(const char *name)¶

Constructor for YggObjInput.

Parameters:: name – [in] constant character pointer to the name of an input channel.

inline YggObjInput(const std::string name)¶

Constructor for YggObjInput.

Parameters:: name – [in] constant std::string the name of an input channel.

inline YggObjInput(yggInput_t x)¶: Empty constructor for inheritance.

class YggGenericOutput : public YggOutput ¶

#include <YggInterface.hpp>

C++ interface to yggGenericOutput_t functionality. The YggGenericOutput class is a basic wrapper around the C yggGenericOutput_t structure and associated functions from the YggInterface.h header. It provides the user with C++ style access to basic ASCII file output operations.

Public Functions

inline YggGenericOutput(const char *name)¶

Constructor for YggGenericOutput.

Parameters:: name – [in] constant character pointer to the name of an output channel.

inline YggGenericOutput(const std::string name)¶

Constructor for YggGenericOutput.

Parameters:: name – [in] constant std::string the name of an output channel.

inline YggGenericOutput(yggOutput_t x)¶: Empty constructor for inheritance.

class YggGenericInput : public YggInput ¶

#include <YggInterface.hpp>

C++ interface to yggGenericInput_t functionality. The YggGenericInput class is a basic wrapper around the C yggGenericInput_t structure and associated functions from the YggInterface.h header. It provides the user with C++ style access to basic ASCII file input operations.

Public Functions

inline YggGenericInput(const char *name)¶

Constructor for YggGenericInput.

Parameters:: name – [in] constant character pointer to the name of an input channel.

inline YggGenericInput(const std::string name)¶

Constructor for YggGenericInput.

Parameters:: name – [in] constant std::string the name of an input channel.

inline YggGenericInput(yggInput_t x)¶: Empty constructor for inheritance.

class YggAnyOutput : public YggOutput ¶

#include <YggInterface.hpp>

C++ interface to yggAnyOutput_t functionality. The YggAnyOutput class is a basic wrapper around the C yggAnyOutput_t structure and associated functions from the YggInterface.h header. It provides the user with C++ style access to basic ASCII file output operations.

Public Functions

inline YggAnyOutput(const char *name)¶

Constructor for YggAnyOutput.

Parameters:: name – [in] constant character pointer to the name of an output channel.

inline YggAnyOutput(const std::string name)¶

Constructor for YggAnyOutput.

Parameters:: name – [in] constant std::string the name of an output channel.

inline YggAnyOutput(yggOutput_t x)¶: Empty constructor for inheritance.

class YggAnyInput : public YggInput ¶

#include <YggInterface.hpp>

C++ interface to yggAnyInput_t functionality. The YggAnyInput class is a basic wrapper around the C yggAnyInput_t structure and associated functions from the YggInterface.h header. It provides the user with C++ style access to basic ASCII file input operations.

Public Functions

inline YggAnyInput(const char *name)¶

Constructor for YggAnyInput.

Parameters:: name – [in] constant character pointer to the name of an input channel.

inline YggAnyInput(const std::string name)¶

Constructor for YggAnyInput.

Parameters:: name – [in] constant std::string the name of an input channel.

inline YggAnyInput(yggInput_t x)¶: Empty constructor for inheritance.

class YggJSONArrayOutput : public YggOutput ¶

#include <YggInterface.hpp>

C++ interface to yggJSONArrayOutput_t functionality. The YggJSONArrayOutput class is a basic wrapper around the C yggJSONArrayOutput_t structure and associated functions from the YggInterface.h header. It provides the user with C++ style access to basic ASCII file output operations.

Public Functions

inline YggJSONArrayOutput(const char *name)¶

Constructor for YggJSONArrayOutput.

Parameters:: name – [in] constant character pointer to the name of an output channel.

inline YggJSONArrayOutput(const std::string name)¶

Constructor for YggJSONArrayOutput.

Parameters:: name – [in] constant std::string the name of an output channel.

inline YggJSONArrayOutput(yggOutput_t x)¶: Empty constructor for inheritance.

class YggJSONArrayInput : public YggInput ¶

#include <YggInterface.hpp>

C++ interface to yggJSONArrayInput_t functionality. The YggJSONArrayInput class is a basic wrapper around the C yggJSONArrayInput_t structure and associated functions from the YggInterface.h header. It provides the user with C++ style access to basic ASCII file input operations.

Public Functions

inline YggJSONArrayInput(const char *name)¶

Constructor for YggJSONArrayInput.

Parameters:: name – [in] constant character pointer to the name of an input channel.

inline YggJSONArrayInput(const std::string name)¶

Constructor for YggJSONArrayInput.

Parameters:: name – [in] constant std::string the name of an input channel.

inline YggJSONArrayInput(yggInput_t x)¶: Empty constructor for inheritance.

class YggJSONObjectOutput : public YggOutput ¶

#include <YggInterface.hpp>

C++ interface to yggJSONObjectOutput_t functionality. The YggJSONObjectOutput class is a basic wrapper around the C yggJSONObjectOutput_t structure and associated functions from the YggInterface.h header. It provides the user with C++ style access to basic ASCII file output operations.

Public Functions

inline YggJSONObjectOutput(const char *name)¶

Constructor for YggJSONObjectOutput.

Parameters:: name – [in] constant character pointer to the name of an output channel.

inline YggJSONObjectOutput(const std::string name)¶

Constructor for YggJSONObjectOutput.

Parameters:: name – [in] constant std::string the name of an output channel.

inline YggJSONObjectOutput(yggOutput_t x)¶: Empty constructor for inheritance.

class YggJSONObjectInput : public YggInput ¶

#include <YggInterface.hpp>

C++ interface to yggJSONObjectInput_t functionality. The YggJSONObjectInput class is a basic wrapper around the C yggJSONObjectInput_t structure and associated functions from the YggInterface.h header. It provides the user with C++ style access to basic ASCII file input operations.

Public Functions

inline YggJSONObjectInput(const char *name)¶

Constructor for YggJSONObjectInput.

Parameters:: name – [in] constant character pointer to the name of an input channel.

inline YggJSONObjectInput(const std::string name)¶

Constructor for YggJSONObjectInput.

Parameters:: name – [in] constant std::string the name of an input channel.

inline YggJSONObjectInput(yggInput_t x)¶: Empty constructor for inheritance.