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

C++ interface to psiAsciiFileOutput_t functionality. More...

#include <PsiInterface.hpp>

Public Member Functions

 PsiAsciiFileOutput (const char *name, int dst_type=1)
 Constructor for PsiAsciiFileOutput. More...
 
 ~PsiAsciiFileOutput ()
 Destructor for PsiAsciiFileOutput. See cleanup_pafo in PsiInterface.h for details.
 
int send_eof ()
 Send EOF message to output file, closing it. See af_send_eof in PsiInterface.h for details. More...
 
int send_line (char *line)
 Send a single line to a file or queue. See af_send_line in PsiInterface.h for details. More...
 

Detailed Description

C++ interface to psiAsciiFileOutput_t functionality.

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

Constructor & Destructor Documentation

◆ PsiAsciiFileOutput()

PsiAsciiFileOutput::PsiAsciiFileOutput ( const char *  name,
int  dst_type = 1 
)
inline

Constructor for PsiAsciiFileOutput.

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

Member Function Documentation

◆ send_eof()

int PsiAsciiFileOutput::send_eof ( )
inline

Send EOF message to output file, closing it. See af_send_eof in PsiInterface.h for details.

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

◆ send_line()

int PsiAsciiFileOutput::send_line ( char *  line)
inline

Send a single line to a file or queue. See af_send_line in PsiInterface.h for details.

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

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