All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
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  virtual ~CPortWriteList();
54  private:
55  CPortWriteList(const CPortWriteList&); // copy constructor not implemented
56  CPortWriteList& operator=(const CPortWriteList&); // assignment operator is not implemented
57  public:
58  /*---------------------------------------------------------------*/
59  // IPortWriteList
60  /*---------------------------------------------------------------*/
61 
63  virtual void Write(const void *pBuffer, int64_t Address, int64_t Length);
64 
66  virtual void Replay(IPort* pPort);
67 
69  // Default = -1
70  virtual void SetCookie(const int64_t Value);
71 
73  virtual int64_t GetCookie();
74 
75  protected:
77  typedef struct
78  {
81  char *pData;
83 
85  std::list<WriteCommand_t> *m_pWriteCommands;
86 
89  };
90 
91 }
92 
93 #ifdef _MSC_VER
94 # pragma warning ( pop )
95 #endif
96 
97 #endif // ifndef GENAPI_PORTWRITELIST_H
GENAPI_NAMESPACE
Lexical analyzer for CIntSwissKnife.
Definition: Destructible.h:30
GENAPI_NAMESPACE::IPortWriteList
GENICAM_INTERFACE GENAPI_DECL_ABSTRACT IPortWriteList
Definition: IPortRecorder.h:45
GENAPI_NAMESPACE::GetCookie
virtual int64_t GetCookie()=0
Gets the cookie a port implementation may have set for caching a command list.
GENAPI_DECL
#define GENAPI_DECL
Definition: GenApiDll.h:55
GENAPI_NAMESPACE::Write
virtual void Write(const void *pBuffer, int64_t Address, int64_t Length)=0
Writes a chunk of bytes to the port.
GENAPI_NAMESPACE::SetCookie
virtual void SetCookie(const int64_t Value)=0
Sets a cookie in case the port implementation want to cache a command list.
GENAPI_NAMESPACE::CPortWriteList::WriteCommand_t::Length
int64_t Length
Definition: PortWriteList.h:80
GENAPI_NAMESPACE::CPortWriteList::WriteCommand_t::Address
int64_t Address
Definition: PortWriteList.h:79
GENAPI_NAMESPACE::CPortWriteList::WriteCommand_t::pData
char * pData
Definition: PortWriteList.h:81
GENAPI_NAMESPACE::Address
GENICAM_INTERFACE GENAPI_DECL_ABSTRACT int64_t Address
Definition: IPort.h:57
GENAPI_NAMESPACE::Length
GENICAM_INTERFACE GENAPI_DECL_ABSTRACT int64_t int64_t Length
Definition: IPort.h:57
GENAPI_NAMESPACE::CPortWriteList
Container holding a list of port write commands.
Definition: PortWriteList.h:46
GENAPI_NAMESPACE::CPortWriteList::WriteCommand_t
The data associated with a write command.
Definition: PortWriteList.h:77
GENAPI_NAMESPACE::CPortWriteList::m_Cookie
int64_t m_Cookie
A cookie helper for caching.
Definition: PortWriteList.h:88
int64_t
__int64 int64_t
Definition: config-win32.h:21
GENAPI_NAMESPACE::Replay
virtual void Replay(IPort *pPort)=0
Replays the write command to the given port interface.
GENAPI_NAMESPACE::CPortWriteList::m_pWriteCommands
std::list< WriteCommand_t > * m_pWriteCommands
a list holding the write commands
Definition: PortWriteList.h:85
GENAPI_NAMESPACE::IPort
GENICAM_INTERFACE GENAPI_DECL_ABSTRACT IPort
Interface for ports.
Definition: IPort.h:57
IPortRecorder.h
Definition of interface IPort.
GENAPI_NAMESPACE::operator=
virtual IBoolean & operator=(bool Value)
Set node value.
Definition: IBoolean.h:64


rc_genicam_api
Author(s): Heiko Hirschmueller
autogenerated on Wed Dec 4 2024 03:10:11