PortWriteList.h
Go to the documentation of this file.
1 //-----------------------------------------------------------------------------
2 // (c) 2009 by Basler Vision Technologies
3 // Section: Vision Components
4 // Project: GenApi
5 // Author: Fritz Dierks
6 // $Header$
7 //
8 // License: This file is published under the license of the EMVA GenICam Standard Group.
9 // A text file describing the legal terms is included in your installation as 'GenICam_license.pdf'.
10 // If for some reason you are missing this file please contact the EMVA or visit the website
11 // (http://www.genicam.org) for a full copy.
12 //
13 // THIS SOFTWARE IS PROVIDED BY THE EMVA GENICAM STANDARD GROUP "AS IS"
14 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15 // THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE EMVA GENICAM STANDARD GROUP
17 // OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
20 // OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
21 // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22 // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
23 // POSSIBILITY OF SUCH DAMAGE.
24 //-----------------------------------------------------------------------------
31 #ifndef GENAPI_PORTWRITELIST_H
32 #define GENAPI_PORTWRITELIST_H
33 
34 #include <GenApi/IPortRecorder.h>
35 #include <list>
36 
37 #ifdef _MSC_VER
38 # pragma warning ( push )
39 # pragma warning ( disable : 4251 ) // XXX needs to have dll-interface to be used by clients of class YYY
40 #endif
41 
42 namespace GENAPI_NAMESPACE
43 {
44 
47  {
48  public:
51 
53  ~CPortWriteList();
54 
55  /*---------------------------------------------------------------*/
56  // IPortWriteList
57  /*---------------------------------------------------------------*/
58 
60  virtual void Write(const void *pBuffer, int64_t Address, int64_t Length);
61 
63  virtual void Replay(IPort* pPort);
64 
66  // Default = -1
67  virtual void SetCookie(const int64_t Value);
68 
70  virtual int64_t GetCookie();
71 
72  protected:
74  typedef struct
75  {
78  char *pData;
80 
82  std::list<WriteCommand_t> *m_pWriteCommands;
83 
86  };
87 
88 }
89 
90 #ifdef _MSC_VER
91 # pragma warning ( pop )
92 #endif
93 
94 #endif // ifndef GENAPI_PORTWRITELIST_H
std::list< WriteCommand_t > * m_pWriteCommands
a list holding the write commands
Definition: PortWriteList.h:82
GENICAM_INTERFACE GENAPI_DECL_ABSTRACT IPortWriteList
Definition: IPortRecorder.h:45
__int64 int64_t
Definition: config-win32.h:21
GENICAM_INTERFACE GENAPI_DECL_ABSTRACT int64_t Address
Definition: IPort.h:57
#define GENAPI_DECL
Definition: GenApiDll.h:55
int64_t m_Cookie
A cookie helper for caching.
Definition: PortWriteList.h:85
Container holding a list of port write commands.
Definition: PortWriteList.h:46
virtual void SetCookie(const int64_t Value)=0
Sets a cookie in case the port implementation want to cache a command list.
GENICAM_INTERFACE GENAPI_DECL_ABSTRACT int64_t int64_t Length
Definition: IPort.h:57
Definition of interface IPort.
virtual void Replay(IPort *pPort)=0
Replays the write command to the given port interface.
virtual int64_t GetCookie()=0
Gets the cookie a port implementation may have set for caching a command list.
GENICAM_INTERFACE GENAPI_DECL_ABSTRACT IPort
Interface for ports.
Definition: IPort.h:57
The data associated with a write command.
Definition: PortWriteList.h:74
virtual void Write(const void *pBuffer, int64_t Address, int64_t Length)=0
Writes a chunk of bytes to the port.
Lexical analyzer for CIntSwissKnife.
Definition: Autovector.h:48


rc_genicam_api
Author(s): Heiko Hirschmueller
autogenerated on Wed Mar 17 2021 02:48:41