mvIMPACT Acquire SDK C++
IDevFileStreamBase< CharType, Traits > Class Template Reference

An output stream buffer derived from std::basic_istream used to read from a file on a device. More...

#include <mvIMPACT_acquire_GenICam_FileStream.h>

Inheritance diagram for IDevFileStreamBase< CharType, Traits >:
[legend]

Public Types

typedef IDevFileStreamBuf< CharType, Traits > filebuf_type
 
typedef std::basic_ios< CharType, Traits > ios_type
 
typedef std::basic_istream< CharType, Traits > istream_type
 

Public Member Functions

void close (void)
 Close the file on the device.
 
bool is_open (void) const
 Determines if a file is open.
 
void open (mvIMPACT::acquire::Device *pDev, const char *pFileName, std::ios_base::openmode mode=std::ios_base::in)
 Opens a file on the device.
 
filebuf_typerdbuf (void) const
 Returns the address of the stored stream buffer.
 
std::streamsize size (void) const
 Returns the size of the file on the device.
 

Detailed Description

template<typename CharType, typename Traits>
class mvIMPACT::acquire::GenICam::IDevFileStreamBase< CharType, Traits >

An output stream buffer derived from std::basic_istream used to read from a file on a device.

Note
See description of the std::basic_istream in a STL implementation of your choice to find out more about how to use this object.

Member Typedef Documentation

◆ filebuf_type

typedef IDevFileStreamBuf<CharType, Traits> filebuf_type

◆ ios_type

typedef std::basic_ios<CharType, Traits> ios_type

◆ istream_type

typedef std::basic_istream<CharType, Traits> istream_type

Member Function Documentation

◆ close()

void close ( void  )
inline

Close the file on the device.

◆ is_open()

bool is_open ( void  ) const
inline

Determines if a file is open.

Returns
  • true if the file is open
  • false otherwise

◆ open()

void open ( mvIMPACT::acquire::Device pDev,
const char *  pFileName,
std::ios_base::openmode  mode = std::ios_base::in 
)
inline

Opens a file on the device.

The member function calls rdbuf -> open(_Filename, _Mode | ios_base::in). If open fails, the function calls setstate(failbit), which may throw an ios_base::failure exception.

Parameters
pDevA pointer to a mvIMPACT::acquire::Device object obtained from a mvIMPACT::acquire::DeviceManager object.
pFileNamename of the file to open
modeopen mode

◆ rdbuf()

filebuf_type * rdbuf ( void  ) const
inline

Returns the address of the stored stream buffer.

Returns
The address of the stored stream buffer.

◆ size()

std::streamsize size ( void  ) const
inline

Returns the size of the file on the device.