INodeMap.h
Go to the documentation of this file.
1 //-----------------------------------------------------------------------------
2 // (c) 2006 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_INODEMAP_H
32 #define GENAPI_INODEMAP_H
33 
34 #include <Base/GCBase.h>
35 #include <GenApi/INode.h>
36 #include <GenApi/IPort.h>
37 #include <GenApi/Synch.h>
38 
39 #ifdef _MSC_VER
40 # pragma warning ( push )
41 # pragma warning ( disable : 4251 ) // XXX needs to have dll-interface to be used by clients of class YYY
42 #endif
43 
44 namespace GENAPI_NAMESPACE
45 {
46 
47  //*************************************************************
48  // INodeMap interface
49  //*************************************************************
50 
55  interface GENAPI_DECL_ABSTRACT INodeMap
56  {
58  virtual void GetNodes(NodeList_t &Nodes) const = 0;
59 
61  virtual INode* GetNode( const GENICAM_NAMESPACE::gcstring& Name) const = 0;
62 
64  virtual void InvalidateNodes() const = 0;
65 
67  virtual bool Connect( IPort* pPort, const GENICAM_NAMESPACE::gcstring& PortName) const = 0;
68 
70  virtual bool Connect( IPort* pPort) const = 0;
71 
73 
76 
78  virtual void Poll( int64_t ElapsedTime ) = 0;
79 
81  virtual CLock& GetLock() const = 0;
82 
84  virtual uint64_t GetNumNodes() const = 0;
85 
87  virtual bool ParseSwissKnifes( GENICAM_NAMESPACE::gcstring_vector *pErrorList = NULL ) const = 0;
88  };
89 }
90 
91 #ifdef _MSC_VER
92 # pragma warning ( pop )
93 #endif
94 
95 #endif // ifndef GENAPI_INODEMAP_H
Definition of interface INode and types NodeList_t and CallbackHandleType:
virtual INode * GetNode(const GENICAM_NAMESPACE::gcstring &Name) const =0
Retrieves the node from the central map by Name.
interface GENAPI_DECL_ABSTRACT IPort
Interface for ports.
Definition: IPort.h:57
__int64 int64_t
Definition: config-win32.h:21
interface GENAPI_DECL_ABSTRACT INodeMap
Interface to access the node map.
Definition: INodeMap.h:56
Common GenICam base include file.
virtual bool Connect(IPort *pPort, const GENICAM_NAMESPACE::gcstring &PortName) const =0
Connects a port to a port node with given name.
node_vector NodeList_t
a list of node references
Definition: INode.h:55
virtual bool ParseSwissKnifes(GENICAM_NAMESPACE::gcstring_vector *pErrorList=NULL) const =0
Parse all Swissknife equations.
virtual uint64_t GetNumNodes() const =0
Get the number of nodes in the map.
A string class which is a clone of std::string.
Definition: GCString.h:52
Definition of interface IPort.
virtual GENICAM_NAMESPACE::gcstring GetDeviceName() const =0
Get a name of the device.
Definition of Lock classes.
interface GENAPI_DECL_ABSTRACT INode
Interface common to all nodes.
Definition: INode.h:60
virtual bool Poll(int64_t ElapsedTime)=0
Invalidates the node if the polling time has elapsed.
Part of the generic device API.
Definition: Autovector.h:48
A lock class.
Definition: Synch.h:63
virtual CLock & GetLock() const =0
Returns the lock which guards the node map.
virtual void InvalidateNodes() const =0
Invalidates all nodes.


rc_genicam_api
Author(s): Heiko Hirschmueller
autogenerated on Thu Jun 6 2019 19:10:54