Pleora Technologies Inc. eBUS SDK v7.0.1.7536 API



PvGenFile.h
1 // *****************************************************************************
2 //
3 // Copyright (c) 2009, Pleora Technologies Inc., All rights reserved.
4 //
5 // *****************************************************************************
6 
7 #ifndef __PVGENFILE_H__
8 #define __PVGENFILE_H__
9 
10 #include <PvGenParameterArray.h>
11 #include <PvStringList.h>
12 
13 
14 typedef enum
15 {
17  PvGenOpenModeWrite = 0,
19  PvGenOpenModeRead = 1,
21  PvGenOpenModeUndefined = 999
22 
23 } PvGenOpenMode;
24 
25 
26 namespace PvGenICamLib
27 {
28  class GenFile;
29 }
30 
31 
40 class PV_GENICAM_API PvGenFile
41 {
42 public:
43 
47  PvGenFile();
48 
52  virtual ~PvGenFile();
53 
76  PvResult Open( PvGenParameterArray *aArray, const PvString &aFilename, PvGenOpenMode aMode );
77 
90  PvResult Close();
91 
97  bool IsOpened() const;
98 
117  PvResult WriteFrom( const PvString &aLocalFilename );
118 
132  PvResult ReadTo( const PvString &aLocalFilename );
133 
150  PvResult Write( const uint8_t *aBuffer, int64_t aLength, int64_t &aBytesWritten );
151 
168  PvResult Read( uint8_t *aBuffer, int64_t aLength, int64_t &aBytesRead );
169 
194  PvResult GetStatus( PvString &aStatus );
195 
207  PvString GetLastErrorMessage() const;
208 
221  PvResult GetProgress( int64_t &aCompleted, int64_t &aTotal );
222 
242  static bool IsSupported( PvGenParameterArray *aArray );
243 
252  static bool IsReadable( PvGenParameterArray *aArray, const PvString &aFilename );
253 
262  static bool IsWritable( PvGenParameterArray *aArray, const PvString &aFilename );
263 
270  static void GetFiles( PvGenParameterArray *aArray, PvStringList &aFiles );
271 
272 private:
273 
274  // Not implemented
275  PvGenFile( const PvGenFile & );
276  const PvGenFile &operator=( const PvGenFile & );
277 
278  PvGenICamLib::GenFile *mThis;
279 };
280 
281 #endif
PvResult
Result information.
Definition: PvResult.h:29
PvString
String class.
Definition: PvString.h:25
PvGenParameterArray
GenICam feature array.
Definition: PvGenParameterArray.h:72
PvStringList
Class used to hold a group of PvString objects.
Definition: PvStringList.h:19
PvGenFile
Allows reading/writing to files hosted on the device.
Definition: PvGenFile.h:40

Copyright (c) 2002-2026 Pleora Technologies Inc.
www.pleora.com