Public Member Functions | Private Member Functions | Private Attributes
GENAPI_NAMESPACE::FileProtocolAdapter Class Reference

Adapter between the std::iostreambuf and the SFNC Features representing the device filesystem. More...

#include <Filestream.h>

List of all members.

Public Member Functions

virtual bool attach (GENAPI_NAMESPACE::INodeMap *pInterface)
 attach file protocol adapter to nodemap
virtual bool closeFile (const char *pFileName)
 close a file on the device
virtual bool deleteFile (const char *pFileName)
 Delete the content of the file.
 FileProtocolAdapter ()
 Constructor.
virtual int64_t getBufSize (const char *pFileName, std::ios_base::openmode mode)
 fetch max FileAccessBuffer length for a file
virtual bool openFile (const char *pFileName, std::ios_base::openmode mode)
 open a file on the device
virtual GenICam_streamsize read (char *buf, int64_t offs, GenICam_streamsize len, const char *pFileName)
 read data from the device into a buffer
virtual GenICam_streamsize write (const char *buf, int64_t offs, int64_t len, const char *pFileName)
 writes data into a file.
virtual ~FileProtocolAdapter ()

Private Member Functions

 FileProtocolAdapter (const FileProtocolAdapter &)
FileProtocolAdapteroperator= (const FileProtocolAdapter &)
void WaitUntilFileOperationExecuteDone (bool Validate=true)

Private Attributes

FileProtocolAdapterImpl * m_pImpl

Detailed Description

Adapter between the std::iostreambuf and the SFNC Features representing the device filesystem.

Adapter between the std::iostreambuf and the SFNC Features representing the device filesystem

The adapter assumes, that the features provide stdio fileaccess compatible semantic

Definition at line 104 of file Filestream.h.


Constructor & Destructor Documentation

Constructor.


Member Function Documentation

virtual bool GENAPI_NAMESPACE::FileProtocolAdapter::attach ( GENAPI_NAMESPACE::INodeMap *  pInterface) [virtual]

attach file protocol adapter to nodemap

Parameters:
pInterfaceNodeMap of the device to which the FileProtocolAdapter is attached
Returns:
true if attach was successful, false if not
virtual bool GENAPI_NAMESPACE::FileProtocolAdapter::closeFile ( const char *  pFileName) [virtual]

close a file on the device

Parameters:
pFileNamefile name of the file to open. The file name must exist in the Enumeration FileSelector
Returns:
true on success, false on error
virtual bool GENAPI_NAMESPACE::FileProtocolAdapter::deleteFile ( const char *  pFileName) [virtual]

Delete the content of the file.

Parameters:
pFileNamefile name of the file to open. The file name must exist in the Enumeration FileSelector
Returns:
true on success, false on error
virtual int64_t GENAPI_NAMESPACE::FileProtocolAdapter::getBufSize ( const char *  pFileName,
std::ios_base::openmode  mode 
) [virtual]

fetch max FileAccessBuffer length for a file

Parameters:
pFileNamefile name of the file to open. The file name must exist in the Enumeration FileSelector
modemode to open the file. The mode must exist in the Enumeration FileOpenMode
Returns:
max length of FileAccessBuffer in the given mode on the given file
virtual bool GENAPI_NAMESPACE::FileProtocolAdapter::openFile ( const char *  pFileName,
std::ios_base::openmode  mode 
) [virtual]

open a file on the device

Parameters:
pFileNamefile name of the file to open. The file name must exist in the Enumeration FileSelector
modemode to open the file. The mode must exist in the Enumeration FileOpenMode
Returns:
true on success, false on error
FileProtocolAdapter& GENAPI_NAMESPACE::FileProtocolAdapter::operator= ( const FileProtocolAdapter ) [private]
virtual GenICam_streamsize GENAPI_NAMESPACE::FileProtocolAdapter::read ( char *  buf,
int64_t  offs,
GenICam_streamsize  len,
const char *  pFileName 
) [virtual]

read data from the device into a buffer

Parameters:
buftarget buffer
offsoffset in the device file to read from
lencount of bytes to read
pFileNamefile name of the file to write into The file name must exist in the Enumeration FileSelector
Returns:
count of bytes successfully read
virtual GenICam_streamsize GENAPI_NAMESPACE::FileProtocolAdapter::write ( const char *  buf,
int64_t  offs,
int64_t  len,
const char *  pFileName 
) [virtual]

writes data into a file.

Parameters:
bufsource buffer
offsoffset into the device file
lencount of bytes to write
pFileNamefile name of the file to write into The file name must exist in the Enumeration FileSelector
Returns:
count of bytes written

Member Data Documentation

FileProtocolAdapterImpl* GENAPI_NAMESPACE::FileProtocolAdapter::m_pImpl [private]

Definition at line 241 of file Filestream.h.


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


rc_visard_driver
Author(s): Heiko Hirschmueller , Christian Emmerich , Felix Ruess
autogenerated on Thu Jun 6 2019 20:43:11