Files | Classes | Macros | Typedefs | Enumerations | Functions
Base_PublicUtilities

Files

file  GCBase.h
 Common GenICam base include file.
 
file  GCError.h
 GenICam Common Error Values.
 
file  GCException.h
 
file  GCNamespace.h
 GenICam versioned namespace.
 
file  GCRTSSUtilities.h
 GenICam RTSS utilities.
 
file  GCString.h
 Portable string implementation.
 
file  GCStringVector.h
 Portable string vector implementation.
 
file  GCSynch.h
 Definition of Lock classes.
 
file  GCTypes.h
 Platform-dependent type definitions.
 
file  GCUtilities.h
 GenICam common utilities.
 
file  GenICamFwd.h
 Forward declarations for GenICam types.
 

Classes

class  GENICAM_NAMESPACE::CGlobalLock
 Named global lock which can be used over process boundaries. More...
 
class  GENICAM_NAMESPACE::CGlobalLockUnlocker
 unlocks the global lock object on destruction More...
 
class  GENICAM_NAMESPACE::CLock
 A lock class. More...
 
class  GENICAM_NAMESPACE::gcstring
 A string class which is a clone of std::string. More...
 
class  GENICAM_NAMESPACE::GenericException
 GenICam's exception class. More...
 
class  GENICAM_NAMESPACE::LockableObject< Object >
 Instance-Lock for an object. More...
 

Macros

#define DECLARE_EXCEPTION(name)
 Creates an exception with the same functionality as the GenericException but being of different type. More...
 

Typedefs

typedef float float32_t
 32 bit floating point More...
 
typedef double float64_t
 64 bit floating point More...
 
typedef int32_t GENICAM_NAMESPACE::GC_ERROR
 Gen Cam Error. More...
 

Enumerations

enum  GENICAM_NAMESPACE::GCErrorID {
  GENICAM_NAMESPACE::GC_ERR_SUCCESS = 0, GENICAM_NAMESPACE::GC_ERR_INVALID_BUFFER_SIZE = -1, GENICAM_NAMESPACE::GC_ERR_INVALID_HANDLE = -2, GENICAM_NAMESPACE::GC_ERR_INVALID_ID = -3,
  GENICAM_NAMESPACE::GC_ERR_ACCESS_DENIED = -4, GENICAM_NAMESPACE::GC_ERR_NO_DATA = -5, GENICAM_NAMESPACE::GC_ERR_ERROR = -6, GENICAM_NAMESPACE::GC_ERR_INVALID_PARAMETER = -7,
  GENICAM_NAMESPACE::GC_ERR_TIMEOUT = -8, GENICAM_NAMESPACE::GC_ERR_INVALID_FILENAME = -9, GENICAM_NAMESPACE::GC_ERR_INVALID_ADDRESS = -10, GENICAM_NAMESPACE::GC_ERR_FILE_IO = -11
}
 Define a list which maps error ids to error descriptions The list is filled in the cpp file. More...
 
enum  GENICAM_NAMESPACE::GCModuleID {
  GENICAM_NAMESPACE::GC_MOD_SYSTEM = 0x0, GENICAM_NAMESPACE::GC_MOD_TLICLIENT = 0x20000000, GENICAM_NAMESPACE::GC_MOD_TLISYSTEM = 0x10000000, GENICAM_NAMESPACE::GC_MOD_FACTORY = 0x08000000,
  GENICAM_NAMESPACE::GC_MOD_GENAPI = 0x04000000
}
 Modules were errors can come from. More...
 

Functions

std::istream & GENICAM_NAMESPACE::getline (std::istream &is, GENICAM_NAMESPACE::gcstring &str)
 STL getline. More...
 
std::istream & GENICAM_NAMESPACE::getline (std::istream &is, GENICAM_NAMESPACE::gcstring &str, char delim)
 STL getline. More...
 
std::ostream & operator<< (std::ostream &ostr, const GENICAM_NAMESPACE::gcstring &str)
 STL operator out. More...
 
std::istream & operator>> (std::istream &istr, GENICAM_NAMESPACE::gcstring &str)
 STL operator in. More...
 
GCBASE_API void GENICAM_NAMESPACE::ReplaceEnvironmentVariables (gcstring &Buffer, bool ReplaceBlankBy20=false)
 Replaces in a string and replace ' ' with %20. 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

Macro Definition Documentation

#define DECLARE_EXCEPTION (   name)
Value:
class GCBASE_RTTI_CLASS_API name : public GENICAM_NAMESPACE::GenericException \
{ \
public: \
name( const char* pDescription, const char *pSourceFileName, int SourceLine ); \
name( const char* pDescription, const char *pSourceFileName, int SourceLine, const char* pExceptionType ); \
name( const char* pDescription, const char *pSourceFileName, int SourceLine, const char *pEntryPoint, const char *pErrorNodeName, const char* pExceptionType ); \
}
GenICam&#39;s exception class.
Definition: GCException.h:63

Creates an exception with the same functionality as the GenericException but being of different type.

Definition at line 120 of file GCException.h.

Typedef Documentation

typedef float float32_t

32 bit floating point

Definition at line 234 of file GCTypes.h.

typedef double float64_t

64 bit floating point

Definition at line 237 of file GCTypes.h.

typedef int32_t GENICAM_NAMESPACE::GC_ERROR

Gen Cam Error.

Definition at line 40 of file GCError.h.

Enumeration Type Documentation

Define a list which maps error ids to error descriptions The list is filled in the cpp file.

Enumerator
GC_ERR_SUCCESS 
GC_ERR_INVALID_BUFFER_SIZE 
GC_ERR_INVALID_HANDLE 
GC_ERR_INVALID_ID 
GC_ERR_ACCESS_DENIED 
GC_ERR_NO_DATA 
GC_ERR_ERROR 
GC_ERR_INVALID_PARAMETER 
GC_ERR_TIMEOUT 
GC_ERR_INVALID_FILENAME 
GC_ERR_INVALID_ADDRESS 
GC_ERR_FILE_IO 

Definition at line 45 of file GCError.h.

Modules were errors can come from.

Enumerator
GC_MOD_SYSTEM 
GC_MOD_TLICLIENT 
GC_MOD_TLISYSTEM 
GC_MOD_FACTORY 
GC_MOD_GENAPI 

Definition at line 63 of file GCError.h.

Function Documentation

std::istream& GENICAM_NAMESPACE::getline ( std::istream &  is,
GENICAM_NAMESPACE::gcstring str 
)
inline

STL getline.

Definition at line 188 of file GCString.h.

std::istream& GENICAM_NAMESPACE::getline ( std::istream &  is,
GENICAM_NAMESPACE::gcstring str,
char  delim 
)
inline

STL getline.

Definition at line 205 of file GCString.h.

std::ostream& operator<< ( std::ostream &  ostr,
const GENICAM_NAMESPACE::gcstring str 
)
inline

STL operator out.

Definition at line 225 of file GCString.h.

std::istream& operator>> ( std::istream &  istr,
GENICAM_NAMESPACE::gcstring str 
)
inline

STL operator in.

Definition at line 241 of file GCString.h.

GCBASE_API void GENICAM_NAMESPACE::ReplaceEnvironmentVariables ( gcstring Buffer,
bool  ReplaceBlankBy20 = false 
)

Replaces in a string and replace ' ' with %20.

GCBASE_API GENICAM_NAMESPACE::gcstring GENICAM_NAMESPACE::UrlDecode ( const GENICAM_NAMESPACE::gcstring Input)

Replaces xx escapes by their char equivalent.

GCBASE_API gcstring GENICAM_NAMESPACE::UrlEncode ( const GENICAM_NAMESPACE::gcstring Input)

Converts \ to / and replaces all unsafe characters by their xx equivalent.



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