INGOR
Public Member Functions | List of all members
ytIO Class Reference

IO routine abstractions. More...

#include <ytIO.h>

Public Member Functions

ytIO_writer ytIO_getWriter (const char *name)
 Returns a network file writer. More...
 
ytIO_writer ytIO_getWriterMsg (const char *name, int mode, const char *module)
 Returns a network file writer with messages. More...
 
ytIO_reader ytIO_getReader (const char *name)
 Returns a network file reader. More...
 

Detailed Description

IO routine abstractions.

See also
ytING, ytSGN3, ytTXT, ytPaList, ytNodeList

Member Function Documentation

◆ ytIO_getReader()

ytIO_reader ytIO_getReader ( const char *  name)

Returns a network file reader.

This uses the substring after the last occurrence of "." (dot) as the name of file type. Therefore, the file name with an extension identical to the file type can also be used as the argument name.

Parameters
name
Returns
network file reader, or NULL if name is not found.

◆ ytIO_getWriter()

ytIO_writer ytIO_getWriter ( const char *  name)

Returns a network file writer.

This uses the substring after the last occurrence of "." (dot) as the name of file type. Therefore, the file name with an extension identical to the file type can also be used as the argument name.

Parameters
name
Returns
network file writer, or NULL if name is not found.

◆ ytIO_getWriterMsg()

ytIO_writer ytIO_getWriterMsg ( const char *  name,
int  mode,
const char *  module 
)

Returns a network file writer with messages.

This is the same as ytIO_getWriter() except that you can choose the behavior when the file format name name is not found.

Parameters
namefile format name. See Network File Formats.
modeytIO_MODE_ERROR: exit the program with error code 1
ytIO_MODE_WARNING: prints warning messages and return NULL.
ytIO_MODE_NONE: do nothing even if the file format is not found.

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