cis_config
Public Member Functions | List of all members
PsiAsciiFileInput Class Reference

C++ interface to psiAsciiFileInput_t functionality. More...

#include <PsiInterface.hpp>

Public Member Functions

 PsiAsciiFileInput (const char *name, int src_type=1)
 Constructor for PsiAsciiFileInput. More...
 
 ~PsiAsciiFileInput ()
 Destructor for PsiAsciiFileInput. See cleanup_pafi in PsiInterface.h for details.
 
int recv_line (char *line, size_t n)
 Receive a single line from an associated file or queue. See af_recv_line in PsiInterface.h for details. More...
 

Detailed Description

C++ interface to psiAsciiFileInput_t functionality.

The PsiAsciiFileInput class is a basic wrapper around the C psiAsciiFileInput_t structure and associated functions from the PsiInterface.h header. It provides the user with C++ style access to basic ASCII file input operations.

Constructor & Destructor Documentation

◆ PsiAsciiFileInput()

PsiAsciiFileInput::PsiAsciiFileInput ( const char *  name,
int  src_type = 1 
)
inline

Constructor for PsiAsciiFileInput.

Parameters
[in]nameconstant character pointer to path of local file or name of an input queue.
[in]src_typeint 0 if name refers to a local file, 1 if it is a queue.

Member Function Documentation

◆ recv_line()

int PsiAsciiFileInput::recv_line ( char *  line,
size_t  n 
)
inline

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

Parameters
[out]linecharacter pointer to allocate memory where the received line should be stored.
[in]nsize_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.

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