ChimeraTK-DeviceAccess 03.25.00
Loading...
Searching...
No Matches
ChimeraTK::Utilities Namespace Reference

Functions

DeviceDescriptor parseDeviceDesciptor (std::string cddString)
 Parse a ChimeraTK device descriptor (CDD) and return the information in the DeviceDescriptor struct.
 
bool isDeviceDescriptor (std::string theString)
 Check whether the given string seems to be a CDD.
 
Sdm parseSdm (const std::string &sdmString)
 Parse an SDM URI and return the device information in the Sdm struct.
 
Sdm parseDeviceString (const std::string &deviceString)
 Parse an old-style device string (either path to device node or map file name for dummies)
 
std::size_t shmDummyInstanceIdHash (const std::string &address, const std::map< std::string, std::string > &parameters)
 Generates shm dummy instanceId hash from address and parameter map, Intended for use with parseDeviceDesciptor return value.
 
std::string createShmName (std::size_t instanceIdHash, const std::string &mapFileName, const std::string &userName)
 Generates shm dummy name from parameter hashes.
 
bool isSdm (const std::string &theString)
 Check wehter the given string seems to be an SDM.
 
size_t countOccurence (std::string theString, char delimiter)
 Check if the given string only contains alphanumeric characters.
 
DeviceInfoMap::DeviceInfo aliasLookUp (const std::string &aliasName, const std::string &dmapFilePath)
 Search for an alias in a given DMap file and return the DeviceInfo entry.
 
std::vector< std::string > getAliasList ()
 Returns the list of device aliases from the DMap file set using BackendFactory::setDMapFilePath.
 
void printStackTrace ()
 Print a call stack trace (but continue executing the process normally).
 

Function Documentation

◆ aliasLookUp()

DeviceInfoMap::DeviceInfo ChimeraTK::Utilities::aliasLookUp ( const std::string &  aliasName,
const std::string &  dmapFilePath 
)

Search for an alias in a given DMap file and return the DeviceInfo entry.

If the alias is not found, the DeviceInfo will have empty strings.

Definition at line 288 of file Utilities.cpp.

◆ countOccurence()

size_t ChimeraTK::Utilities::countOccurence ( std::string  theString,
char  delimiter 
)

Check if the given string only contains alphanumeric characters.

Definition at line 23 of file Utilities.cpp.

◆ createShmName()

std::string ChimeraTK::Utilities::createShmName ( std::size_t  instanceIdHash,
const std::string &  mapFileName,
const std::string &  userName 
)

Generates shm dummy name from parameter hashes.

Definition at line 366 of file Utilities.cpp.

◆ getAliasList()

std::vector< std::string > ChimeraTK::Utilities::getAliasList ( )

Returns the list of device aliases from the DMap file set using BackendFactory::setDMapFilePath.

Definition at line 297 of file Utilities.cpp.

◆ isDeviceDescriptor()

bool ChimeraTK::Utilities::isDeviceDescriptor ( std::string  theString)

Check whether the given string seems to be a CDD.

There is no guarantee that the CDD is well-formed, the function just looks for the signature of a CDD.

Definition at line 39 of file Utilities.cpp.

◆ isSdm()

bool ChimeraTK::Utilities::isSdm ( const std::string &  theString)

Check wehter the given string seems to be an SDM.

There is no guarantee that the SDM is well-formed, the finction just looks for the signatore of an SDM.

Definition at line 30 of file Utilities.cpp.

◆ parseDeviceDesciptor()

DeviceDescriptor ChimeraTK::Utilities::parseDeviceDesciptor ( std::string  cddString)

Parse a ChimeraTK device descriptor (CDD) and return the information in the DeviceDescriptor struct.

Definition at line 49 of file Utilities.cpp.

◆ parseDeviceString()

Sdm ChimeraTK::Utilities::parseDeviceString ( const std::string &  deviceString)

Parse an old-style device string (either path to device node or map file name for dummies)

Definition at line 262 of file Utilities.cpp.

◆ parseSdm()

Sdm ChimeraTK::Utilities::parseSdm ( const std::string &  sdmString)

Parse an SDM URI and return the device information in the Sdm struct.

Definition at line 191 of file Utilities.cpp.

◆ printStackTrace()

void ChimeraTK::Utilities::printStackTrace ( )

Print a call stack trace (but continue executing the process normally).

Can be used for debugging. C++ names will be demangled, if possible.

Definition at line 335 of file Utilities.cpp.

◆ shmDummyInstanceIdHash()

std::size_t ChimeraTK::Utilities::shmDummyInstanceIdHash ( const std::string &  address,
const std::map< std::string, std::string > &  parameters 
)

Generates shm dummy instanceId hash from address and parameter map, Intended for use with parseDeviceDesciptor return value.

Definition at line 354 of file Utilities.cpp.