NVIDIA Index example code nvidia_logo_transpbg.gif Up
nv::index_common::io::File Class Reference

#include <large_file_io.h>

Classes

class  File_impl
 

Public Types

enum  {
  FILE_FLAG_NONE = 0x00u ,
  FILE_FLAG_SEQUENTIAL_READ = 0x01u ,
  FILE_FLAG_NO_SYSTEM_CACHE = 0x02u
}
 

Public Member Functions

 File ()
 
 File (mi::Uint32 gzip_compression_level)
 
 File (const std::string &file_path, std::ios_base::openmode open_mode=std::ios_base::in|std::ios_base::out, mi::Uint32 file_flags=FILE_FLAG_NONE)
 
virtual ~File ()
 
bool open (const std::string &file_path, std::ios_base::openmode open_mode=std::ios_base::in|std::ios_base::out, mi::Uint32 file_flags=FILE_FLAG_NONE)
 
bool is_open () const
 
void close ()
 
mi::Uint64 read (void *output_buffer, mi::Uint64 start_position, mi::Uint64 num_bytes_to_read)
 
mi::Uint64 write (const void *input_buffer, mi::Uint64 start_position, mi::Uint64 num_bytes_to_write)
 
mi::Uint64 read (void *output_buffer, mi::Uint64 num_bytes_to_read)
 
mi::Uint64 write (const void *input_buffer, mi::Uint64 num_bytes_to_write)
 
bool flush_buffers () const
 
mi::Uint64 size () const
 
const std::string & file_path () const
 
 operator bool () const
 

Protected Attributes

File_implm_file_impl
 

Detailed Description

Definition at line 24 of file large_file_io.h.

Member Enumeration Documentation

 anonymous enum

anonymous enum

Constructor & Destructor Documentation

 File() [1/3]

nv::index_common::io::File::File ( )

Definition at line 930 of file large_file_io.cpp.

 File() [2/3]

nv::index_common::io::File::File ( mi::Uint32  gzip_compression_level)
explicit

Definition at line 935 of file large_file_io.cpp.

 File() [3/3]

nv::index_common::io::File::File ( const std::string &  file_path,
std::ios_base::openmode  open_mode = std::ios_base::in | std::ios_base::out,
mi::Uint32  file_flags = FILE_FLAG_NONE 
)
explicit

Definition at line 946 of file large_file_io.cpp.

 ~File()

nv::index_common::io::File::~File ( )
virtual

Definition at line 955 of file large_file_io.cpp.

Member Function Documentation

 close()

void nv::index_common::io::File::close ( )

Definition at line 983 of file large_file_io.cpp.

 file_path()

const std::string & nv::index_common::io::File::file_path ( ) const

Definition at line 1031 of file large_file_io.cpp.

 flush_buffers()

bool nv::index_common::io::File::flush_buffers ( ) const

Definition at line 1019 of file large_file_io.cpp.

 is_open()

bool nv::index_common::io::File::is_open ( ) const

Definition at line 977 of file large_file_io.cpp.

 open()

bool nv::index_common::io::File::open ( const std::string &  file_path,
std::ios_base::openmode  open_mode = std::ios_base::in | std::ios_base::out,
mi::Uint32  file_flags = FILE_FLAG_NONE 
)

Definition at line 963 of file large_file_io.cpp.

 operator bool()

nv::index_common::io::File::operator bool ( ) const

Definition at line 1037 of file large_file_io.cpp.

 read() [1/2]

mi::Uint64 nv::index_common::io::File::read ( void *  output_buffer,
mi::Uint64  num_bytes_to_read 
)

Definition at line 1005 of file large_file_io.cpp.

 read() [2/2]

mi::Uint64 nv::index_common::io::File::read ( void *  output_buffer,
mi::Uint64  start_position,
mi::Uint64  num_bytes_to_read 
)

Definition at line 989 of file large_file_io.cpp.

 size()

mi::Uint64 nv::index_common::io::File::size ( ) const

Definition at line 1025 of file large_file_io.cpp.

 write() [1/2]

mi::Uint64 nv::index_common::io::File::write ( const void *  input_buffer,
mi::Uint64  num_bytes_to_write 
)

Definition at line 1012 of file large_file_io.cpp.

 write() [2/2]

mi::Uint64 nv::index_common::io::File::write ( const void *  input_buffer,
mi::Uint64  start_position,
mi::Uint64  num_bytes_to_write 
)

Definition at line 997 of file large_file_io.cpp.

Member Data Documentation

 m_file_impl

File_impl* nv::index_common::io::File::m_file_impl
protected

Definition at line 75 of file large_file_io.h.


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