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

C++ interface to psiAsciiTableOutput_t functionality. More...

#include <PsiInterface.hpp>

Public Member Functions

 PsiAsciiTableOutput (const char *name, char *format_str, int dst_type=1)
 Constructor for PsiAsciiTableOutput. More...
 
 ~PsiAsciiTableOutput ()
 Destructor for PsiAsciiTableOutput. See cleanup_pato in PsiInterface.h for details.
 
int send (char *data, int len)
 Send a nolimit message to a table output queue. See at_psi_send in PsiInterface.h for details. More...
 
int send_eof ()
 Send a nolimit EOF message to a table output queue. See at_send_eof in PsiInterface for details. More...
 
int send_row (int nargs,...)
 Format and send a row to the table file/queue. See at_send_row in PsiInterface.h for details. More...
 
int send_array (int nargs, int nrows,...)
 Format and send table columns to the table file/queue. See at_send_array in PsiInterface.h for details. More...
 

Detailed Description

C++ interface to psiAsciiTableOutput_t functionality.

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

Constructor & Destructor Documentation

◆ PsiAsciiTableOutput()

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

Constructor for PsiAsciiTableOutput.

Parameters
[in]nameconstant character pointer to path of local table or name of an output queue.
[in]format_strcharacter pointer to format string that should be used to format rows into table lines.
[in]dst_typeint 0 if name refers to a local table, 1 if it is a queue.

Member Function Documentation

◆ send()

int PsiAsciiTableOutput::send ( char *  data,
int  len 
)
inline

Send a nolimit message to a table output queue. See at_psi_send in PsiInterface.h for details.

Parameters
[in]datacharacter pointer to message that should be sent.
[in]lenint length of message to be sent.
Returns
int 0 if send succesfull, -1 if send unsuccessful.

◆ send_array()

int PsiAsciiTableOutput::send_array ( int  nargs,
int  nrows,
  ... 
)
inline

Format and send table columns to the table file/queue. See at_send_array in PsiInterface.h for details.

Parameters
[in]nargsint Number of arguments being passed.
[in]nrowsint Number of rows in the columns.
[in]...Pointers to memory containing table columns that should be formatted.
Returns
int 0 if send succesfull, -1 if send unsuccessful.

◆ send_eof()

int PsiAsciiTableOutput::send_eof ( )
inline

Send a nolimit EOF message to a table output queue. See at_send_eof in PsiInterface for details.

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

◆ send_row()

int PsiAsciiTableOutput::send_row ( int  nargs,
  ... 
)
inline

Format and send a row to the table file/queue. See at_send_row in PsiInterface.h for details.

Parameters
[in]nargsint Number of arguments being passed.
[in]...Row elements that should be formatted.
Returns
int 0 if send succesfull, -1 if send unsuccessful.

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