interface.h
Go to the documentation of this file.
00001 /*
00002  * This file is part of the rc_genicam_api package.
00003  *
00004  * Copyright (c) 2017 Roboception GmbH
00005  * All rights reserved
00006  *
00007  * Author: Heiko Hirschmueller
00008  *
00009  * Redistribution and use in source and binary forms, with or without
00010  * modification, are permitted provided that the following conditions are met:
00011  *
00012  * 1. Redistributions of source code must retain the above copyright notice,
00013  * this list of conditions and the following disclaimer.
00014  *
00015  * 2. Redistributions in binary form must reproduce the above copyright notice,
00016  * this list of conditions and the following disclaimer in the documentation
00017  * and/or other materials provided with the distribution.
00018  *
00019  * 3. Neither the name of the copyright holder nor the names of its contributors
00020  * may be used to endorse or promote products derived from this software without
00021  * specific prior written permission.
00022  *
00023  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00024  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00025  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00026  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
00027  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
00028  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
00029  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
00030  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
00031  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
00032  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00033  * POSSIBILITY OF SUCH DAMAGE.
00034  */
00035 
00036 #ifndef RC_GENICAM_API_INTERFACE
00037 #define RC_GENICAM_API_INTERFACE
00038 
00039 #include "system.h"
00040 
00041 #include <mutex>
00042 
00043 namespace rcg
00044 {
00045 
00046 class Device;
00047 
00054 class Interface : public std::enable_shared_from_this<Interface>
00055 {
00056   public:
00057 
00063     Interface(const std::shared_ptr<System> &parent,
00064               const std::shared_ptr<const GenTLWrapper> &gentl, const char *id);
00065     ~Interface();
00066 
00073     std::shared_ptr<System> getParent() const;
00074 
00081     const std::string &getID() const;
00082 
00089     void open();
00090 
00096     void close();
00097 
00106     std::vector<std::shared_ptr<Device> > getDevices();
00107 
00116     std::shared_ptr<Device> getDevice(const char *devid);
00117 
00127     std::string getDisplayName();
00128 
00138     std::string getTLType();
00139 
00149     std::shared_ptr<GenApi::CNodeMapRef> getNodeMap();
00150 
00157     void *getHandle() const;
00158 
00159   private:
00160 
00161     Interface(class Interface &); // forbidden
00162     Interface &operator=(const Interface &); // forbidden
00163 
00164     std::shared_ptr<System> parent;
00165     std::shared_ptr<const GenTLWrapper> gentl;
00166     std::string id;
00167 
00168     std::mutex mtx;
00169 
00170     int n_open;
00171     void *ifh;
00172 
00173     std::shared_ptr<CPort> cport;
00174     std::shared_ptr<GenApi::CNodeMapRef> nodemap;
00175 
00176     std::vector<std::weak_ptr<Device> > dlist;
00177 };
00178 
00179 }
00180 
00181 #endif


rc_genicam_api
Author(s): Heiko Hirschmueller
autogenerated on Thu Jun 6 2019 18:42:47