Classes
class	AutoLock

class	CGlobalLock
	Named global lock which can be used over process boundaries. More...

class	CGlobalLockUnlocker
	unlocks the global lock object on destruction More...

class	CLock
	A lock class. More...

class	CLockEx
	This class is for testing purposes only. It should not be used for client code because it exists only for Windows but not for Linux since it uses internal data structures of a Win32 object. More...

class	CLog
	This logging class initializes the logger. More...

class	ExceptionReporter
	printf like creation of exceptions More...

class	gcarray

class	gcstring
	A string class which is a clone of std::string. More...

class	GenericException
	GenICam's exception class. More...

class	ILogger

class	ILoggerFactory

class	LockableObject
	Instance-Lock for an object. More...

struct	Version_t
	version More...

Typedefs
typedef int32_t	GC_ERROR
	Gen Cam Error. More...

Enumerations
enum	GCErrorID { GC_ERR_SUCCESS = 0, GC_ERR_INVALID_BUFFER_SIZE = -1, GC_ERR_INVALID_HANDLE = -2, GC_ERR_INVALID_ID = -3, GC_ERR_ACCESS_DENIED = -4, GC_ERR_NO_DATA = -5, GC_ERR_ERROR = -6, GC_ERR_INVALID_PARAMETER = -7, GC_ERR_TIMEOUT = -8, GC_ERR_INVALID_FILENAME = -9, GC_ERR_INVALID_ADDRESS = -10, 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	GCModuleID { GC_MOD_SYSTEM = 0x0, GC_MOD_TLICLIENT = 0x20000000, GC_MOD_TLISYSTEM = 0x10000000, GC_MOD_FACTORY = 0x08000000, GC_MOD_GENAPI = 0x04000000 }
	Modules were errors can come from. More...

Functions
	DECLARE_EXCEPTION (AccessException)
	Exception to be thrown to indicate an access error. More...

	DECLARE_EXCEPTION (BadAllocException)

	DECLARE_EXCEPTION (DynamicCastException)
	Exception to be thrown to indicate the result of a dynamic cast was zero. More...

	DECLARE_EXCEPTION (InvalidArgumentException)
	Exception fired if an argument is invalid. More...

	DECLARE_EXCEPTION (LogicalErrorException)
	Exception to be thrown to indicate logical errors in program flow. More...

	DECLARE_EXCEPTION (OutOfRangeException)
	Exception fired if an argument is out of range. More...

	DECLARE_EXCEPTION (PropertyException)
	Exception fired if a property access fails. More...

	DECLARE_EXCEPTION (RuntimeException)
	Runtime exception. More...

	DECLARE_EXCEPTION (TimeoutException)
	Exception to be thrown to indicate an timeout error. More...

GCBASE_API bool	DoesEnvironmentVariableExist (const gcstring &VariableName)
	Returns true if an environment variable exists. More...

	GENFW_DECLARE_EXCEPTION (FileIOException)
	Exception fired if a file read or a file write operation fails. More...

	GENFW_DECLARE_EXCEPTION (FileNotFoundException)
	Exception fired if a file is not found. More...

	GENFW_DECLARE_EXCEPTION (FormatException)
	Exception fired if a type parsed by a method is not of the specified format. More...

GCBASE_API bool	GetCacheFileDirectory (gcstring &CacheFileDirectory)
	Returns the directory where cache files are located. More...

GCBASE_API void	GetCandidateCacheFilePaths (gcstring_vector &CacheFileNames, const gcstring &CacheFileDirectory)

GCBASE_API void	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	GetGenICamCacheFolder (void)
	Retrieve the path of the GenICam cache folder. More...

GCBASE_API gcstring	GetGenICamCLProtocolFolder (void)
	Retrieve the path of the CLProtocol folder. More...

GCBASE_API gcstring	GetGenICamLogConfig (void)
	Retrieve the path of the GenICam logging properties file. More...

GCBASE_API void	GetLastErrorMessage (gcstring &Message)

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

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

GCBASE_API gcstring	GetModulePathFromFunction (void *pFunction)
	true = only subdirectories (ex . and ..) are retrieved; false = only files are retrieved More...

GCBASE_API gcstring	GetValueOfEnvironmentVariable (const gcstring &VariableName)
	Retrieve the value of an environment variable. More...

GCBASE_API bool	GetValueOfEnvironmentVariable (const gcstring &VariableName, gcstring &VariableContent)
	Retrieve the value of an environment variable. More...

GCBASE_API bool	HasValidExtension (const gcstring &FileName)
	Returns the truth value for the proposition: The given file has the valid file extension. More...

GCBASE_API bool	HasValidLength (const gcstring &FileName)
	Returns the truth value for the proposition: The given file name has the valid length. More...

template<typename T >
T	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	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	ReplaceEnvironmentVariables (gcstring &Buffer, bool ReplaceBlankBy20=false)
	Replaces in a string and replace ' ' with %20. More...

GCBASE_API void	SetGenICamCacheFolder (const gcstring &path)
	Stores the path of the GenICam cache folder. More...

GCBASE_API void	SetGenICamCLProtocolFolder (const gcstring &path)
	Stores the path of the CLProtocol folder. More...

GCBASE_API void	SetGenICamLogConfig (const gcstring &path)
	Stores the path of the GenICam logging properties file. More...

GCBASE_API void	ThrowBadAlloc (const char *source, int line)

GCBASE_API void	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	UrlDecode (const GENICAM_NAMESPACE::gcstring &Input)
	Replaces xx escapes by their char equivalent. More...

GCBASE_API gcstring	UrlEncode (const GENICAM_NAMESPACE::gcstring &Input)
	Converts \ to / and replaces all unsafe characters by their xx equivalent. More...

Function Documentation

◆ DECLARE_EXCEPTION() [1/9]

GENICAM_NAMESPACE::DECLARE_EXCEPTION ( AccessException )

Exception to be thrown to indicate an access error.

◆ DECLARE_EXCEPTION() [2/9]

GENICAM_NAMESPACE::DECLARE_EXCEPTION ( BadAllocException )

◆ DECLARE_EXCEPTION() [3/9]

GENICAM_NAMESPACE::DECLARE_EXCEPTION ( DynamicCastException )

Exception to be thrown to indicate the result of a dynamic cast was zero.

◆ DECLARE_EXCEPTION() [4/9]

GENICAM_NAMESPACE::DECLARE_EXCEPTION ( InvalidArgumentException )

Exception fired if an argument is invalid.

◆ DECLARE_EXCEPTION() [5/9]

GENICAM_NAMESPACE::DECLARE_EXCEPTION ( LogicalErrorException )

Exception to be thrown to indicate logical errors in program flow.

◆ DECLARE_EXCEPTION() [6/9]

GENICAM_NAMESPACE::DECLARE_EXCEPTION ( OutOfRangeException )

Exception fired if an argument is out of range.

◆ DECLARE_EXCEPTION() [7/9]

GENICAM_NAMESPACE::DECLARE_EXCEPTION ( PropertyException )

Exception fired if a property access fails.

◆ DECLARE_EXCEPTION() [8/9]

GENICAM_NAMESPACE::DECLARE_EXCEPTION ( RuntimeException )

Runtime exception.

◆ DECLARE_EXCEPTION() [9/9]

GENICAM_NAMESPACE::DECLARE_EXCEPTION ( TimeoutException )

Exception to be thrown to indicate an timeout error.

◆ DoesEnvironmentVariableExist()

GCBASE_API bool GENICAM_NAMESPACE::DoesEnvironmentVariableExist ( const gcstring & VariableName )

Returns true if an environment variable exists.

◆ GENFW_DECLARE_EXCEPTION() [1/3]

GENICAM_NAMESPACE::GENFW_DECLARE_EXCEPTION ( FileIOException )

Exception fired if a file read or a file write operation fails.

◆ GENFW_DECLARE_EXCEPTION() [2/3]

GENICAM_NAMESPACE::GENFW_DECLARE_EXCEPTION ( FileNotFoundException )

Exception fired if a file is not found.

◆ GENFW_DECLARE_EXCEPTION() [3/3]

GENICAM_NAMESPACE::GENFW_DECLARE_EXCEPTION ( FormatException )

Exception fired if a type parsed by a method is not of the specified format.

◆ GetCacheFileDirectory()

GCBASE_API bool GENICAM_NAMESPACE::GetCacheFileDirectory ( gcstring & CacheFileDirectory )

Returns the directory where cache files are located.

◆ GetCandidateCacheFilePaths()

GCBASE_API void GENICAM_NAMESPACE::GetCandidateCacheFilePaths	(	gcstring_vector &	CacheFileNames,
		const gcstring &	CacheFileDirectory
	)

◆ GetFiles()

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.

Parameters

FileNames	> The file template. Can contain environment variables.
DirectoriesOnly	> A list of files matching the file template

◆ GetGenICamCacheFolder()

GCBASE_API gcstring GENICAM_NAMESPACE::GetGenICamCacheFolder ( void )

Retrieve the path of the GenICam cache folder.

The path to the cache folder can be stored by calling SetGenICamCacheFolder(). If GetGenICamCacheFolder() is called before SetGenICamCacheFolder(), it will return the value of environment variable GENICAM_CACHE_Vx_y. If this environment variable does not exist, an exception will be thrown.

◆ GetGenICamCLProtocolFolder()

GCBASE_API gcstring GENICAM_NAMESPACE::GetGenICamCLProtocolFolder ( void )

Retrieve the path of the CLProtocol folder.

The path to the CLProtocol folder can be stored by calling SetGenICamCLProtocolFolder(). If GetGenICamCLProtocolFolder() is called before SetGenICamCLProtocolFolder(), it will return the value of environment variable GENICAM_CLPROTOCOL. If this environment variable does not exist, an exception will be thrown.

◆ GetGenICamLogConfig()

GCBASE_API gcstring GENICAM_NAMESPACE::GetGenICamLogConfig ( void )

Retrieve the path of the GenICam logging properties file.

The path to the logging properties file can be stored by calling SetGenICamLogConfig(). If GetGenICamLogConfig() is called before SetGenICamLogConfig(), it will return the value of environment variable GENICAM_LOG_CONFIG_Vx_y. If this environment variable does not exist, an exception will be thrown.

◆ GetLastErrorMessage()

GCBASE_API void GENICAM_NAMESPACE::GetLastErrorMessage ( gcstring & Message )

◆ GetModulePathFromFunction()

GCBASE_API gcstring GENICAM_NAMESPACE::GetModulePathFromFunction ( void * pFunction )

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

Gets the full path to the module (DLL/SO) containing the given pFunction; empty string if not found.

◆ GetValueOfEnvironmentVariable() [1/2]

GCBASE_API gcstring GENICAM_NAMESPACE::GetValueOfEnvironmentVariable ( const gcstring & VariableName )

Retrieve the value of an environment variable.

Exceptions

runtime_exception if not found

◆ GetValueOfEnvironmentVariable() [2/2]

GCBASE_API bool GENICAM_NAMESPACE::GetValueOfEnvironmentVariable	(	const gcstring &	VariableName,
		gcstring &	VariableContent
	)

Retrieve the value of an environment variable.

Returns: true if environment variable was found, otherwise false

◆ HasValidExtension()

GCBASE_API bool GENICAM_NAMESPACE::HasValidExtension ( const gcstring & FileName )

Returns the truth value for the proposition: The given file has the valid file extension.

◆ HasValidLength()

GCBASE_API bool GENICAM_NAMESPACE::HasValidLength ( const gcstring & FileName )

Returns the truth value for the proposition: The given file name has the valid length.

◆ INTEGRAL_CAST()

template<typename T >

T GENICAM_NAMESPACE::INTEGRAL_CAST ( int64_t ll )

inline

This verifies at runtime if there was no loss of data if an int64_t was downcast to type T (e.g. int32_t)

Definition at line 113 of file GCUtilities.h.

◆ INTEGRAL_CAST2()

template<typename Td , typename Ts >

Td GENICAM_NAMESPACE::INTEGRAL_CAST2 ( Ts s )

inline

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)

Definition at line 101 of file GCUtilities.h.

◆ SetGenICamCacheFolder()

GCBASE_API void GENICAM_NAMESPACE::SetGenICamCacheFolder ( const gcstring & path )

Stores the path of the GenICam cache folder.

◆ SetGenICamCLProtocolFolder()

GCBASE_API void GENICAM_NAMESPACE::SetGenICamCLProtocolFolder ( const gcstring & path )

Stores the path of the CLProtocol folder.

◆ SetGenICamLogConfig()

GCBASE_API void GENICAM_NAMESPACE::SetGenICamLogConfig ( const gcstring & path )

Stores the path of the GenICam logging properties file.

◆ ThrowBadAlloc()

GCBASE_API void GENICAM_NAMESPACE::ThrowBadAlloc	(	const char *	source,
		int	line
	)

◆ Tokenize()

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