YASK
Yet Another Stencil Kit: a software framework for creating HPC stencil code. Copyright 2014-2023 Intel Corporation.
Loading...
Searching...
No Matches
Public Member Functions | List of all members
yask::yask_output_factory Class Reference

Factory to create output objects. More...

#include <yask_common_api.hpp>

Public Member Functions

virtual yask_file_output_ptr new_file_output (const std::string &file_name) const
 Create a file output object.
 
virtual yask_string_output_ptr new_string_output () const
 Create a string output object.
 
virtual yask_stdout_output_ptr new_stdout_output () const
 Create a stdout output object.
 
virtual yask_null_output_ptr new_null_output () const
 Create a null output object.
 

Detailed Description

Factory to create output objects.

Member Function Documentation

◆ new_file_output()

virtual yask_file_output_ptr yask::yask_output_factory::new_file_output ( const std::string &  file_name) const
virtual

Create a file output object.

This object is used to write output to a file.

Returns
Pointer to new output object or null pointer if file cannot be opened.
Parameters
[in]file_nameName of file to open. Any existing file will be truncated.

◆ new_string_output()

virtual yask_string_output_ptr yask::yask_output_factory::new_string_output ( ) const
virtual

Create a string output object.

This object is used to write output to a string.

Returns
Pointer to new output object.

◆ new_stdout_output()

virtual yask_stdout_output_ptr yask::yask_output_factory::new_stdout_output ( ) const
virtual

Create a stdout output object.

This object is used to write output to the standard output stream.

Returns
Pointer to new output object.

◆ new_null_output()

virtual yask_null_output_ptr yask::yask_output_factory::new_null_output ( ) const
virtual

Create a null output object.

This object is used to discard output.

Returns
Pointer to new output object.

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