config.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_CONFIG
00037 #define RC_GENICAM_API_CONFIG
00038 
00039 #include <GenApi/GenApi.h>
00040 #include <GenApi/ChunkAdapter.h>
00041 
00042 #include <memory>
00043 #include <string>
00044 #include <vector>
00045 
00046 /*
00047   This module provides convenience functions for setting and retrieving values
00048   from a GenICam nodemap.
00049 */
00050 
00051 namespace rcg
00052 {
00053 
00065 bool callCommand(const std::shared_ptr<GenApi::CNodeMapRef> &nodemap, const char *name,
00066                  bool exception=false);
00067 
00080 bool setBoolean(const std::shared_ptr<GenApi::CNodeMapRef> &nodemap, const char *name,
00081                 bool value, bool exception=false);
00082 
00095 bool setInteger(const std::shared_ptr<GenApi::CNodeMapRef> &nodemap, const char *name,
00096                 int64_t value, bool exception=false);
00097 
00110 bool setIPV4Address(const std::shared_ptr<GenApi::CNodeMapRef> &nodemap, const char *name,
00111                     const char *value, bool exception);
00112 
00125 bool setFloat(const std::shared_ptr<GenApi::CNodeMapRef> &nodemap, const char *name,
00126               double value, bool exception=false);
00127 
00140 bool setEnum(const std::shared_ptr<GenApi::CNodeMapRef> &nodemap, const char *name,
00141              const char *value, bool exception=false);
00142 
00158 bool setString(const std::shared_ptr<GenApi::CNodeMapRef> &nodemap, const char *name,
00159                const char *value, bool exception=false);
00160 
00172 bool getBoolean(const std::shared_ptr<GenApi::CNodeMapRef> &nodemap, const char *name,
00173                 bool exception=false, bool igncache=false);
00174 
00191 int64_t getInteger(const std::shared_ptr<GenApi::CNodeMapRef> &nodemap, const char *name,
00192                    int64_t *vmin=0, int64_t *vmax=0, bool exception=false, bool igncache=false);
00193 
00210 double getFloat(const std::shared_ptr<GenApi::CNodeMapRef> &nodemap, const char *name,
00211                 double *vmin=0, double *vmax=0, bool exception=false, bool igncache=false);
00212 
00223 std::string getEnum(const std::shared_ptr<GenApi::CNodeMapRef> &nodemap, const char *name,
00224                     bool exception=false);
00225 
00239 std::string getEnum(const std::shared_ptr<GenApi::CNodeMapRef> &nodemap, const char *name,
00240                     std::vector<std::string> &list, bool exception=false);
00241 
00256 std::string getString(const std::shared_ptr<GenApi::CNodeMapRef> &nodemap, const char *name,
00257                       bool exception=false, bool igncache=false);
00258 
00269 void checkFeature(const std::shared_ptr<GenApi::CNodeMapRef> &nodemap, const char *name,
00270                   const char *value, bool igncache=false);
00271 
00288 std::shared_ptr<GenApi::CChunkAdapter> getChunkAdapter(const std::shared_ptr<GenApi::CNodeMapRef> &nodemap,
00289                                                        const std::string &tltype);
00290 
00291 
00309 class Buffer;
00310 
00311 std::string getComponetOfPart(const std::shared_ptr<GenApi::CNodeMapRef> &nodemap,
00312                               const Buffer *buffer, uint32_t part);
00313 
00314 }
00315 
00316 #endif


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