Spinnaker C++
4.0.0.116
Functions
GCUtilities Utility

Functions

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. More...
 
template<typename 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. More...
 
SPINNAKER_API bool DoesEnvironmentVariableExist (const Spinnaker::GenICam::gcstring &VariableName)
 Returns true if an environment variable exists. More...
 
SPINNAKER_API gcstring GetValueOfEnvironmentVariable (const gcstring &VariableName)
 Retrieve the value of an environment variable. More...
 
SPINNAKER_API bool GetValueOfEnvironmentVariable (const gcstring &VariableName, gcstring &VariableContent)
 Retrieve the value of an environment variable. More...
 
SPINNAKER_API gcstring UrlEncode (const gcstring &Input)
 Converts \ to / and replaces all unsave characters by their xx equivalent. More...
 
SPINNAKER_API gcstring UrlDecode (const gcstring &Input)
 Replaces xx escapes by their char equivalent. More...
 
SPINNAKER_API void ReplaceEnvironmentVariables (gcstring &Buffer, bool ReplaceBlankBy20=false)
 Replaces in a string and replace ' ' with %20. More...
 
SPINNAKER_API gcstring GetGenICamCacheFolder (void)
 Retrieve the path of the GenICam cache folder The path to the cache folder can be stored by calling SetGenICamCacheFolder(). More...
 
SPINNAKER_API gcstring GetGenICamLogConfig (void)
 Retrieve the path of the GenICam logging properties file. More...
 
SPINNAKER_API gcstring GetGenICamCLProtocolFolder (void)
 Retrieve the path of the CLProtocol folder The path to the CLProtocol folder can be stored by calling SetGenICamCLProtocolFolder(). More...
 
SPINNAKER_API void SetGenICamCacheFolder (const gcstring &path)
 Stores the path of the GenICam cache folder. More...
 
SPINNAKER_API void SetGenICamLogConfig (const gcstring &path)
 Stores the path of the GenICam logging properties file. More...
 
SPINNAKER_API void SetGenICamCLProtocolFolder (const gcstring &path)
 Stores the path of the CLProtocol folder. More...
 
SPINNAKER_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...
 
SPINNAKER_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...
 
SPINNAKER_API gcstring GetModulePathFromFunction (void *pFunction)
 Gets the full path to the module (DLL/SO) containing the given pFunction; empty string if not found. More...
 

Detailed Description

Function Documentation

SPINNAKER_API bool Spinnaker::GenICam::DoesEnvironmentVariableExist ( const Spinnaker::GenICam::gcstring VariableName)

Returns true if an environment variable exists.

SPINNAKER_API void Spinnaker::GenICam::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

SPINNAKER_API gcstring Spinnaker::GenICam::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.

SPINNAKER_API gcstring Spinnaker::GenICam::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.

SPINNAKER_API gcstring Spinnaker::GenICam::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.

SPINNAKER_API gcstring Spinnaker::GenICam::GetModulePathFromFunction ( void *  pFunction)

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

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

SPINNAKER_API gcstring Spinnaker::GenICam::GetValueOfEnvironmentVariable ( const gcstring &  VariableName)

Retrieve the value of an environment variable.

Exceptions
runtime_exceptionif not found
SPINNAKER_API bool Spinnaker::GenICam::GetValueOfEnvironmentVariable ( const gcstring &  VariableName,
gcstring &  VariableContent 
)

Retrieve the value of an environment variable.

Returns
true if environment variable was found, otherwise false
T Spinnaker::GenICam::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)

Td Spinnaker::GenICam::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)

SPINNAKER_API void Spinnaker::GenICam::ReplaceEnvironmentVariables ( gcstring &  Buffer,
bool  ReplaceBlankBy20 = false 
)

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

SPINNAKER_API void Spinnaker::GenICam::SetGenICamCacheFolder ( const gcstring &  path)

Stores the path of the GenICam cache folder.

SPINNAKER_API void Spinnaker::GenICam::SetGenICamCLProtocolFolder ( const gcstring &  path)

Stores the path of the CLProtocol folder.

SPINNAKER_API void Spinnaker::GenICam::SetGenICamLogConfig ( const gcstring &  path)

Stores the path of the GenICam logging properties file.

SPINNAKER_API void Spinnaker::GenICam::Tokenize ( const gcstring &  str,
gcstring_vector &  tokens,
const gcstring &  delimiters = " " 
)

splits str input string into a list of tokens using the delimiter

Parameters
strstring to be split
tokensresult of the splitting operation
delimitersdelimiters for the splitting
SPINNAKER_API gcstring Spinnaker::GenICam::UrlDecode ( const gcstring &  Input)

Replaces xx escapes by their char equivalent.

SPINNAKER_API gcstring Spinnaker::GenICam::UrlEncode ( const gcstring &  Input)

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

Contact Support Spinnaker® SDK Programmer's Guide and API Reference