Namespaces | Macros | Functions
GCUtilities.h File Reference

GenICam common utilities. More...

#include <GenICamVersion.h>
#include <Base/GCTypes.h>
#include <Base/GCString.h>
#include <Base/GCStringVector.h>
#include <Base/GCException.h>
#include <Base/GCLinkage.h>
Include dependency graph for GCUtilities.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces

 GENICAM_NAMESPACE
 

Macros

#define __ERR__   __OUTPUT_FORMATER__("ERROR")
 
#define __LINE_STR__   EXPAND_TO_STRINGISE(__LINE__)
 
#define __LOCATION__   __FILE__ "(" __LINE_STR__ ")"
 
#define __OUTPUT_FORMATER__(_type)   __LOCATION__ " : " _type " : "
 
#define __TODO__   __OUTPUT_FORMATER__("TBD")
 
#define __WARN__   __OUTPUT_FORMATER__("WARNING")
 
#define _TO_STRING(__stN)   #__stN
 
#define EXPAND_TO_STRINGISE(__stN)   _TO_STRING( __stN )
 
#define GC_COUNTOF(arr)   (sizeof (arr) / sizeof (arr)[0] )
 
#define GENICAM_DEPRECATED(FUNCTION)   FUNCTION
 
#define GENICAM_UNUSED(unused_var)   ((void)(unused_var))
 
#define USE_TEMP_CACHE_FILE   1
 
#define USE_TEMP_CACHE_FILE   1
 

Functions

GCBASE_API bool GENICAM_NAMESPACE::DoesEnvironmentVariableExist (const gcstring &VariableName)
 Returns true if an environment variable exists. More...
 
GCBASE_API void GENICAM_NAMESPACE::GetFiles (const gcstring &FileTemplate, gcstring_vector &FileNames, const bool DirectoriesOnly=false)
 Gets a list of files or directories matching a given FileTemplate. More...
 
GCBASE_API gcstring GENICAM_NAMESPACE::GetGenICamCacheFolder (void)
 Retrieve the path of the GenICam cache folder. More...
 
GCBASE_API gcstring GENICAM_NAMESPACE::GetGenICamCLProtocolFolder (void)
 Retrieve the path of the CLProtocol folder. More...
 
GCBASE_API gcstring GENICAM_NAMESPACE::GetGenICamLogConfig (void)
 Retrieve the path of the GenICam logging properties file. More...
 
GCBASE_API gcstring GENICAM_NAMESPACE::GetModulePathFromFunction (void *pFunction)
 

true = only subdirectories (ex . and ..) are retrieved; false = only files are retrieved

More...
 
GCBASE_API gcstring GENICAM_NAMESPACE::GetValueOfEnvironmentVariable (const gcstring &VariableName)
 Retrieve the value of an environment variable. More...
 
GCBASE_API bool GENICAM_NAMESPACE::GetValueOfEnvironmentVariable (const gcstring &VariableName, gcstring &VariableContent)
 Retrieve the value of an environment variable. More...
 
template<typename T >
GENICAM_NAMESPACE::INTEGRAL_CAST (int64_t ll)
 This verifies at runtime if there was no loss of data if an int64_t was downcast to type T (e.g. int32_t) More...
 
template<typename Td , typename Ts >
Td GENICAM_NAMESPACE::INTEGRAL_CAST2 (Ts s)
 This verifies at runtime if there was no loss of data if an type Ts (e.g. int64t) was downcast to type Td (e.g. int32_t) More...
 
GCBASE_API void GENICAM_NAMESPACE::ReplaceEnvironmentVariables (gcstring &Buffer, bool ReplaceBlankBy20=false)
 Replaces in a string and replace ' ' with %20. More...
 
GCBASE_API void GENICAM_NAMESPACE::SetGenICamCacheFolder (const gcstring &path)
 Stores the path of the GenICam cache folder. More...
 
GCBASE_API void GENICAM_NAMESPACE::SetGenICamCLProtocolFolder (const gcstring &path)
 Stores the path of the CLProtocol folder. More...
 
GCBASE_API void GENICAM_NAMESPACE::SetGenICamLogConfig (const gcstring &path)
 Stores the path of the GenICam logging properties file. More...
 
GCBASE_API void GENICAM_NAMESPACE::Tokenize (const gcstring &str, gcstring_vector &tokens, const gcstring &delimiters=" ")
 splits str input string into a list of tokens using the delimiter More...
 
GCBASE_API GENICAM_NAMESPACE::gcstring GENICAM_NAMESPACE::UrlDecode (const GENICAM_NAMESPACE::gcstring &Input)
 Replaces xx escapes by their char equivalent. More...
 
GCBASE_API gcstring GENICAM_NAMESPACE::UrlEncode (const GENICAM_NAMESPACE::gcstring &Input)
 Converts \ to / and replaces all unsafe characters by their xx equivalent. More...
 

Detailed Description

GenICam common utilities.

Definition in file GCUtilities.h.

Macro Definition Documentation

#define __ERR__   __OUTPUT_FORMATER__("ERROR")

Definition at line 227 of file GCUtilities.h.

#define __LINE_STR__   EXPAND_TO_STRINGISE(__LINE__)

Definition at line 221 of file GCUtilities.h.

#define __LOCATION__   __FILE__ "(" __LINE_STR__ ")"

Definition at line 222 of file GCUtilities.h.

#define __OUTPUT_FORMATER__ (   _type)    __LOCATION__ " : " _type " : "

Definition at line 223 of file GCUtilities.h.

#define __TODO__   __OUTPUT_FORMATER__("TBD")

Definition at line 228 of file GCUtilities.h.

#define __WARN__   __OUTPUT_FORMATER__("WARNING")

Definition at line 226 of file GCUtilities.h.

#define _TO_STRING (   __stN)    #__stN

Definition at line 219 of file GCUtilities.h.

#define EXPAND_TO_STRINGISE (   __stN)    _TO_STRING( __stN )

Definition at line 220 of file GCUtilities.h.

#define GC_COUNTOF (   arr)    (sizeof (arr) / sizeof (arr)[0] )

Definition at line 93 of file GCUtilities.h.

#define GENICAM_DEPRECATED (   FUNCTION)    FUNCTION

Definition at line 205 of file GCUtilities.h.

#define GENICAM_UNUSED (   unused_var)    ((void)(unused_var))

Definition at line 197 of file GCUtilities.h.

#define USE_TEMP_CACHE_FILE   1

Definition at line 58 of file GCUtilities.h.

#define USE_TEMP_CACHE_FILE   1

Definition at line 58 of file GCUtilities.h.



rc_genicam_api
Author(s): Heiko Hirschmueller
autogenerated on Wed Mar 17 2021 02:48:41