SCORPIO  1.8.0
List of all members | Public Attributes
file_desc_t Struct Reference

File descriptor structure. More...

#include <pio.h>

Collaboration diagram for file_desc_t:
Collaboration graph
[legend]

Public Attributes

iosystem_desc_tiosystem
 The IO system ID used to open this file. More...
 
int fh
 The ncid returned for this file by the underlying library (netcdf or pnetcdf). More...
 
char fname [PIO_MAX_NAME+1]
 
int pio_ncid
 The ncid that will be returned to the user. More...
 
int iotype
 The PIO_TYPE value that was used to open this file. More...
 
struct var_desc_t varlist [PIO_MAX_VARS]
 List of variables in this file (deprecated). More...
 
int num_unlim_dimids
 
int * unlim_dimids
 
int mode
 Mode used when file was opened. More...
 
struct wmulti_buffer buffer
 The wmulti_buffer is used to aggregate multiple variables with the same communication pattern prior to a write. More...
 
PIO_Offset rb_pend
 
PIO_Offset wb_pend
 
void * mvcache
 Data buffer per IO decomposition for this file. More...
 
struct spio_io_fstats_summary * io_fstats
 I/O statistics associated with this file. More...
 
struct file_desc_tnext
 Pointer to the next file_desc_t in the list of open files. More...
 
int do_io
 True if this task should participate in IO (only true for one task with netcdf serial files. More...
 
bool reserve_extra_header_space
 True if we need reserve some extra space in the header when creating NetCDF files to accommodate anticipated changes. More...
 
bool is_reopened
 True if this is an existing file reopened. More...
 

Detailed Description

File descriptor structure.

This structure holds information associated with each open file

Member Data Documentation

◆ buffer

struct wmulti_buffer file_desc_t::buffer

The wmulti_buffer is used to aggregate multiple variables with the same communication pattern prior to a write.

◆ do_io

int file_desc_t::do_io

True if this task should participate in IO (only true for one task with netcdf serial files.

◆ fh

int file_desc_t::fh

The ncid returned for this file by the underlying library (netcdf or pnetcdf).

◆ fname

char file_desc_t::fname[PIO_MAX_NAME+1]

◆ io_fstats

struct spio_io_fstats_summary* file_desc_t::io_fstats

I/O statistics associated with this file.

◆ iosystem

iosystem_desc_t* file_desc_t::iosystem

The IO system ID used to open this file.

◆ iotype

int file_desc_t::iotype

The PIO_TYPE value that was used to open this file.

◆ is_reopened

bool file_desc_t::is_reopened

True if this is an existing file reopened.

◆ mode

int file_desc_t::mode

Mode used when file was opened.

◆ mvcache

void* file_desc_t::mvcache

Data buffer per IO decomposition for this file.

Cache for storing data corresponding to multiple variables binned on the I/O decomposition used by the variable

◆ next

struct file_desc_t* file_desc_t::next

Pointer to the next file_desc_t in the list of open files.

◆ num_unlim_dimids

int file_desc_t::num_unlim_dimids

◆ pio_ncid

int file_desc_t::pio_ncid

The ncid that will be returned to the user.

◆ rb_pend

PIO_Offset file_desc_t::rb_pend

◆ reserve_extra_header_space

bool file_desc_t::reserve_extra_header_space

True if we need reserve some extra space in the header when creating NetCDF files to accommodate anticipated changes.

◆ unlim_dimids

int* file_desc_t::unlim_dimids

◆ varlist

struct var_desc_t file_desc_t::varlist[PIO_MAX_VARS]

List of variables in this file (deprecated).

◆ wb_pend

PIO_Offset file_desc_t::wb_pend

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