All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
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/IPortStacked.h>
38 #include <GenApi/Synch.h>
40 
41 #ifdef _MSC_VER
42 # pragma warning ( push )
43 # pragma warning ( disable : 4251 ) // XXX needs to have dll-interface to be used by clients of class YYY
44 #endif
45 
46 namespace GENAPI_NAMESPACE
47 {
48 
49  //*************************************************************
50  // INodeMap interface
51  //*************************************************************
52 
57  GENICAM_INTERFACE GENAPI_DECL_ABSTRACT INodeMap
58  {
60  virtual void GetNodes(NodeList_t &Nodes) const = 0;
61 
63  virtual INode* GetNode( const GENICAM_NAMESPACE::gcstring& Name) const = 0;
64 
66  virtual void InvalidateNodes() const = 0;
67 
69  virtual bool Connect( IPort* pPort, const GENICAM_NAMESPACE::gcstring& PortName) const = 0;
70 
72  virtual bool Connect( IPort* pPort) const = 0;
73 
75  virtual bool Connect(IPortStacked* pPort, const GENICAM_NAMESPACE::gcstring& PortName) = 0;
76 
78  virtual bool Connect(IPortStacked* pPort) = 0;
79 
81 
84 
86  virtual void Poll( int64_t ElapsedTime ) = 0;
87 
89  virtual CLock& GetLock() const = 0;
90 
92  virtual uint64_t GetNumNodes() const = 0;
93 
95  virtual bool ParseSwissKnifes( GENICAM_NAMESPACE::gcstring_vector *pErrorList = NULL ) const = 0;
96 
98  virtual CNodeWriteConcatenator *NewNodeWriteConcatenator() const = 0;
99 
101  virtual bool ConcatenatedWrite(CNodeWriteConcatenator *, bool featureStreaming = true, GENICAM_NAMESPACE::gcstring_vector *pErrorList = NULL) = 0;
102 
105 
106  };
107 }
108 
109 #ifdef _MSC_VER
110 # pragma warning ( pop )
111 #endif
112 
113 #endif // ifndef GENAPI_INODEMAP_H
GENAPI_NAMESPACE
Lexical analyzer for CIntSwissKnife.
Definition: Destructible.h:30
GENAPI_NAMESPACE::Connect
virtual bool Connect(IPort *pPort, const GENICAM_NAMESPACE::gcstring &PortName) const =0
Connects a port to a port node with given name.
GENICAM_INTERFACE
#define GENICAM_INTERFACE
Definition: GenICamFwd.h:33
GENICAM_NAMESPACE::gcstring
A string class which is a clone of std::string.
Definition: GCString.h:52
IPortStacked.h
Definition of interface IPort.
GENAPI_NAMESPACE::SetSuppressCallbackMode
virtual void SetSuppressCallbackMode(ECallbackSuppressMode)=0
Set suppress callback mode.
GENAPI_NAMESPACE::NewNodeWriteConcatenator
virtual CNodeWriteConcatenator * NewNodeWriteConcatenator() const =0
Create a new write concatenator object.
GENAPI_NAMESPACE::GetLock
virtual CLock & GetLock() const =0
Returns the lock which guards the node map.
GENAPI_NAMESPACE::ECallbackSuppressMode
enum GENAPI_NAMESPACE::_ECallbackSuppressMode ECallbackSuppressMode
typedef for callback suppression mod
INode.h
Definition of interface INode and types NodeList_t and CallbackHandleType:
GENAPI_NAMESPACE::ParseSwissKnifes
virtual bool ParseSwissKnifes(GENICAM_NAMESPACE::gcstring_vector *pErrorList=NULL) const =0
Parse all Swissknife equations.
GENAPI_NAMESPACE::GetNumNodes
virtual uint64_t GetNumNodes() const =0
Get the number of nodes in the map.
GENAPI_NAMESPACE::INodeMap
GENICAM_INTERFACE INodeMap
Interface to access the node map.
Definition: INode.h:52
GENAPI_NAMESPACE::Poll
virtual bool Poll(int64_t ElapsedTime)=0
Invalidates the node if the polling time has elapsed.
GENAPI_NAMESPACE::IPortStacked
GENICAM_INTERFACE GENAPI_DECL_ABSTRACT IPortStacked
Interface for ports.
Definition: IPortStacked.h:63
GENAPI_NAMESPACE::GetNode
virtual INode * GetNode(const GENICAM_NAMESPACE::gcstring &Name) const =0
Retrieves the node from the central map by Name.
IPort.h
Definition of interface IPort.
GENAPI_NAMESPACE::INode
GENICAM_INTERFACE INode
Interface common to all nodes.
Definition: ICategory.h:51
GENAPI_NAMESPACE::ConcatenatedWrite
virtual bool ConcatenatedWrite(CNodeWriteConcatenator *, bool featureStreaming=true, GENICAM_NAMESPACE::gcstring_vector *pErrorList=NULL)=0
Execute the transaction.
GCBase.h
Common GenICam base include file.
int64_t
__int64 int64_t
Definition: config-win32.h:21
GENAPI_NAMESPACE::IPort
GENICAM_INTERFACE GENAPI_DECL_ABSTRACT IPort
Interface for ports.
Definition: IPort.h:57
GENAPI_NAMESPACE::GetDeviceName
virtual GENICAM_NAMESPACE::gcstring GetDeviceName() const =0
Get a name of the device.
ConcatenatedWrite.h
This file contains the public definition of the node write concatenator classes.
GENAPI_NAMESPACE::InvalidateNodes
virtual void InvalidateNodes() const =0
Invalidates all nodes.
Synch.h
Definition of Lock classes.
GENAPI_NAMESPACE::NodeList_t
node_vector NodeList_t
a list of node references
Definition: INode.h:55


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