Graph Framework
Loading...
Searching...
No Matches
output::result_file Class Reference

Class representing a netcdf based output file. More...

#include <output.hpp>

Public Member Functions

 result_file (const std::string &filename, const size_t num_rays)
 Construct a new result file.
 
 result_file (const std::string &filename)
 Open a new result file.
 
 ~result_file ()
 Destructor.
 
void end_define_mode () const
 End define mode.
 
int get_ncid () const
 Get ncid.
 
size_t get_num_rays () const
 Get the number of rays.
 
int get_num_rays_dim () const
 Get the number of rays dimension.
 
int get_unlimited_dim () const
 Get unlimited dimension.
 
size_t get_unlimited_size () const
 Get unlimited size.
 
void sync_file () const
 Sync the file.
 

Detailed Description

Class representing a netcdf based output file.

Constructor & Destructor Documentation

◆ result_file() [1/2]

output::result_file::result_file ( const std::string &  filename,
const size_t  num_rays 
)
inline

Construct a new result file.

Parameters
[in]filenameName of the result file.
[in]num_raysNumber of rays.

◆ result_file() [2/2]

output::result_file::result_file ( const std::string &  filename)
inline

Open a new result file.

Parameters
[in]filenameName of the result file.

Member Function Documentation

◆ get_ncid()

int output::result_file::get_ncid ( ) const
inline

Get ncid.

Returns
The netcdf file id.

◆ get_num_rays()

size_t output::result_file::get_num_rays ( ) const
inline

Get the number of rays.

Returns
The number of rays.

◆ get_num_rays_dim()

int output::result_file::get_num_rays_dim ( ) const
inline

Get the number of rays dimension.

Returns
The number of rays dimension.

◆ get_unlimited_dim()

int output::result_file::get_unlimited_dim ( ) const
inline

Get unlimited dimension.

Returns
The unlimited dimension.

◆ get_unlimited_size()

size_t output::result_file::get_unlimited_size ( ) const
inline

Get unlimited size.

Returns
The size of the unlimited dimension.

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