device.h

Go to the documentation of this file.

/*
 * This file is part of the rc_genicam_api package.
 *
 * Copyright (c) 2017 Roboception GmbH
 * All rights reserved
 *
 * Author: Heiko Hirschmueller
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its contributors
 * may be used to endorse or promote products derived from this software without
 * specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef RC_GENICAM_API_DEVICE
#define RC_GENICAM_API_DEVICE
 
#include "interface.h"
 
#include <mutex>
 
#include <GenApi/EventAdapterGeneric.h>
 
namespace rcg
{
 
class Stream;
 
class Device : public std::enable_shared_from_this<Device>
{
  public:
 
    enum ACCESS {READONLY, CONTROL, EXCLUSIVE};
 
    Device(const std::shared_ptr<Interface> &parent,
           const std::shared_ptr<const GenTLWrapper> &gentl, const char *id);
    ~Device();
 
    std::shared_ptr<Interface> getParent() const;
 
    const std::string &getID() const;
 
    void open(ACCESS access);
 
    void close();
 
    void enableModuleEvents();
 
    int getAvailableModuleEvents();
 
    int64_t getModuleEvent(int64_t timeout=-1);
 
    void abortWaitingForModuleEvents();
 
    std::vector<std::shared_ptr<Stream> > getStreams();
 
    std::string getVendor();
 
    std::string getModel();
 
    std::string getTLType();
 
    std::string getDisplayName();
 
    std::string getAccessStatus();
 
    std::string getUserDefinedName();
 
    std::string getSerialNumber();
 
    std::string getVersion();
 
    uint64_t getTimestampFrequency();
 
    std::shared_ptr<GenApi::CNodeMapRef> getNodeMap(const char *xml=0);
 
    std::shared_ptr<GenApi::CNodeMapRef> getRemoteNodeMap(const char *xml=0);
 
    std::shared_ptr<CPort> getRemotePort();
 
    void *getHandle() const;
 
  private:
 
    Device(class Device &); // forbidden
    Device &operator=(const Device &); // forbidden
 
    std::shared_ptr<Interface> parent;
    std::shared_ptr<const GenTLWrapper> gentl;
    std::string id;
 
    std::mutex mtx;
 
    int n_open;
    void *dev;
    void *rp;
    void *event;
    std::vector<uint8_t> event_buffer;
    std::vector<uint8_t> event_value;
 
    std::shared_ptr<CPort> cport, rport;
    std::shared_ptr<GenApi::CNodeMapRef> nodemap, rnodemap;
    std::shared_ptr<GenApi::CEventAdapterGeneric> eventadapter;
 
    std::vector<std::weak_ptr<Stream> > slist;
};
 
std::vector<std::shared_ptr<Device> > getDevices(uint64_t timeout);
std::vector<std::shared_ptr<Device> > getDevices();
 
std::shared_ptr<Device> getDevice(const char *devid, uint64_t timeout);
std::shared_ptr<Device> getDevice(const char *devid);
 
}
 
#endif