GenICam common utilities. More...

Functions
template<typename Td , typename Ts >
Td	INTEGRAL_CAST2 (Ts s)

template<typename T >
T	INTEGRAL_CAST (int64_t ll)

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

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

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

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

GCBASE_API gcstring	GetValueOfEnvironmentVariable (const gcstring &VariableName)

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

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)

GCBASE_API gcstring	GetGenICamCacheFolder (void)
	Retrieve the path of the GenICam cache folder. More...

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

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

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

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

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

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 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	GetModulePathFromFunction (void *pFunction)
	true = only subdirectories (ex . and ..) are retrieved; false = only files are retrieved More...

Function Documentation

◆ INTEGRAL_CAST2()

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)

◆ INTEGRAL_CAST()

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)

◆ 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

◆ GetGenICamCacheFolder()

GCBASE_API gcstring GENICAM_NAMESPACE::GetGenICamCacheFolder ( void )

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.

◆ GetGenICamLogConfig()

GCBASE_API gcstring GENICAM_NAMESPACE::GetGenICamLogConfig ( void )

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.

◆ GetGenICamCLProtocolFolder()

GCBASE_API gcstring GENICAM_NAMESPACE::GetGenICamCLProtocolFolder ( void )

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.

◆ Tokenize()

GCBASE_API void GENICAM_NAMESPACE::Tokenize	(	const gcstring &	str,
		gcstring_vector &	tokens,
		const gcstring &	delimiters = `" "`
	)

Parameters

str	string to be split
tokens	result of the splitting operation
delimiters	delimiters for the splitting

◆ GetFiles()

GCBASE_API void GENICAM_NAMESPACE::GetFiles	(	const gcstring &	FileTemplate,
		gcstring_vector &	FileNames,
		const bool	DirectoriesOnly = `false`
	)