Public utilities of the GenICam Base module

Files
file	GCArray.h
	A fixed size array class.
file	GCBase.h
	Common GenICam base include file.
file	GCError.h
	GenICam Common Error Values
file	GCException.h
	Standard GenICam Exceptions.
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	GenericException
	GenICam's exception class. More...
class	gcstring
	A string class which is a clone of std::string. More...
class	CLock
	A lock class. More...
class	LockableObject< Object >
	Instance-Lock for an object. More...
class	CGlobalLock
	Named global lock which can be used over process boundaries. More...
class	CGlobalLockUnlocker
	unlocks the global lock object on destruction More...

Macros
#define	DECLARE_EXCEPTION(name)

Typedefs
typedef int32_t	GC_ERROR
typedef float	float32_t
	32 bit floating point
typedef double	float64_t
	64 bit floating point

Enumerations
enum	GCErrorID
enum	GCModuleID

Functions
std::istream &	getline (std::istream &is, GENICAM_NAMESPACE::gcstring &str)
std::istream &	getline (std::istream &is, GENICAM_NAMESPACE::gcstring &str, char delim)
std::ostream &	operator<< (std::ostream &ostr, const GENICAM_NAMESPACE::gcstring &str)
std::istream &	operator>> (std::istream &istr, GENICAM_NAMESPACE::gcstring &str)
GCBASE_API gcstring	UrlEncode (const GENICAM_NAMESPACE::gcstring &Input)
GCBASE_API GENICAM_NAMESPACE::gcstring	UrlDecode (const GENICAM_NAMESPACE::gcstring &Input)
GCBASE_API void	ReplaceEnvironmentVariables (gcstring &Buffer, bool ReplaceBlankBy20=false)

Detailed Description

Macro Definition Documentation

DECLARE_EXCEPTION

#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 ); \
            }

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

Typedef Documentation

GC_ERROR

typedef int32_t GC_ERROR

Gen Cam Error

Enumeration Type Documentation

GCErrorID

enum GCErrorID

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

GCModuleID

enum GCModuleID

Modules were errors can come from

Function Documentation

getline() [1/2]

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

STL getline

getline() [2/2]

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

STL getline

operator<<()

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

STL operator out

operator>>()

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

STL operator in

UrlEncode()

GCBASE_API gcstring GENICAM_NAMESPACE::UrlEncode

(

const GENICAM_NAMESPACE::gcstring &

Input

)

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

UrlDecode()

GCBASE_API GENICAM_NAMESPACE::gcstring GENICAM_NAMESPACE::UrlDecode

(

const GENICAM_NAMESPACE::gcstring &

Input

)

Replaces xx escapes by their char equivalent

ReplaceEnvironmentVariables()

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

Replaces in a string and replace ' ' with %20