sf Namespace Reference

Namespaces
namespace	backtrace
namespace	gii
namespace	gmi
namespace	ipj
namespace	lnx
namespace	numbers
namespace	qt
namespace	Ui
namespace	xgl

Classes
class	AcquisitionControl
class	AcquisitionControlPlugin
	Interface class to create the custom widget. More...
class	AcquisitionControlPropertyPage
class	AcquisitionEmulator
	Implements a repetitive signal acquisition emulator. More...
class	ActionButton
	A QPushButton which is associated with an action. More...
class	ActionButtonPlugin
	Interface class to create the custom widget. More...
class	AddItemDialog
struct	Allocator
	Memory allocator class. More...
class	AmplitudePalette
class	Application
class	ApplicationPropertyPage
class	ApplicationSettings
	Keeps the application up-to-date with changes in the settings file. More...
class	AppModuleAction
	Holds a single application module action. More...
class	AppModuleActions
class	AppModuleFileType
class	AppModuleInterface
	Base/Interface class for application modules. This class should provide functionality for loading libraries dynamically and creating implementations. More...
class	AscanGraph
class	AscanGraphPlugin
	Interface class to create the custom widget. More...
class	AscanPropertyPage
class	AxesCoordEdit
	Widget for editing sf::Variable value types integer, floating point and single line string. More...
class	AxesCoordEditPlugin
	Interface class to create the custom widget. More...
class	AxesCoordPropertyPage
	The AxesCoordPropertyPage class represents a custom dialog window. More...
class	BscanGraph
class	BscanGraphPlugin
	Interface class to create the custom widget. More...
class	BscanPropertyPage
class	BufferChopper
	Chops a buffer up in to smaller pieces. More...
class	BufferStitcher
	Stitches a buffer from a multiple of writes. More...
class	CalibrationSet
	Holds a single calibration set of parameters. More...
class	CaptureListModel
	List model implementation which can capture output streams from std::cout, std::clog and std::cerr by assigning the stream buffer. The stream buffer can also be used to assign to a custom std::ostream. More...
class	ClientConnection
	Class handling the connection exchanging data using a QIODevice. More...
class	CodeEditor
class	CodeEditorAppModule
class	CommonItemDelegate
	Allows a list model to determine the editor for a field. More...
class	Condition
	Wrapper for the pthread_cond mechanism. More...
class	ConfigStore
	Class to store application configuration. Uses the global application settings or a given ini-file. More...
class	ContainerPropertyPage
class	ConversionDialog
class	ConversionListModel
	List model for manipulating the passed script manager. More...
class	CustomFields
class	debug_ostream
	Debug output stream. More...
class	DockTitleBar
	Custom title bar widget for a QDockWidget instance. Provides a title, dock/undock button, and close button. Emits a signal when dock state should be toggled. More...
class	Draw
	contains functions for drawing general stuff for graphs. More...
class	DrawWidget
	Simple widget which redirects the painting event to a Qt signal method. More...
class	DrawWidgetPlugin
	Interface class to create the custom widget. More...
struct	DynamicLibraryInfo
	Information on a dynamic library file using the _DL_INFORMATION macro. More...
class	Editor
class	EditorPlugin
	Interface class to create the custom widget. More...
class	EditorPropertyPage
class	ElapseTimer
	Timer for turning true when a certain amount of time has passed. More...
class	ElementInformation
	Holds the information on the transducer. More...
class	EventCounter
class	Exception
	Exception implementation. More...
class	ExceptionBase
	Exception implementation inherited from std::exception. More...
class	ExceptionSystemCall
	Exception implementation for system calls failing within a wrapper class. More...
class	FileFindObject
class	FileMappedStorage
	This class provides storing of huge amounts of data using file mapping. Mapping only what is needed into memory. More...
class	FindReplaceDialog
	Find and replace dialog for a QPlainTextEdit widget. More...
class	FlagsIterator
	Wrapper class to iterate over the flags set. More...
class	FollowersDialog
class	FollowersListModel
	List model for manipulating the passed script manager. More...
class	Formatter
	Class implements a formater like QString from Qt. More...
class	FormBuilder
	Derived class to be able to prevent some properties to be stored when written to file. More...
class	FormDialog
	Creates a dialog from ui-type file. More...
class	FunctionRegistry
	Registry managing function registration and lookup. More...
class	GiiCustomWidgets
	Implementation of interface class for the creation of GII custom widgets. More...
class	GiiScriptInterpreter
	Script extending and linking the script to the generic information interface elements. More...
class	GlobalShortcut
	The GlobalShortcut class provides a global shortcut aka "hotkey". More...
class	GmiCustomWidgets
	Implementation of interface class for the creation of GII custom widgets. More...
class	GmiEmulator
class	GmiServer
class	GmiServerPropertyPage
class	Graph
	Class for drawing a graph having optional rulers and grid. This class uses sf::Draw class for drawing a graph rulers and grid. Use this class as a private class for a custom widget which produces a graph. More...
struct	group_t
class	HierarchyViewer
class	HintWindow
	Floating window like tool tip available to the script engine as well. More...
class	IdPropertyList
	Class making checking of widgets Information ID's easier. More...
class	IFileMapper
	class for file mapping More...
class	InformationBase
	Base class for all generic information objects to be able to put them in a typed list together. More...
class	InformationIdEdit
	Line edit having a button. More...
class	InformationIdEditPlugin
	Interface class to create the custom widget. More...
class	InformationIdList
	Manages a vector InformationTypes::IdVector. This instance can be used to assign to a sf::VariableIdList instance. More...
class	InformationIds
	Abstract class to store information id's in a configuration string. Used to be implemented twice, one as the actual containing and the other containing only the id's. More...
class	InformationItemModel
	Item model for viewing Variables in a tree view. More...
class	InformationMonitor
	Dialog showing the information on a single sf::Variable or sf::ResultData instance. More...
class	InformationPacket
	Packet manipulation class. More...
class	InformationSelectDialog
	Dialog for selecting single or multiple variable or result-data information id's. More...
class	InformationServer
class	InformationService
	Implements a connection between to application exporting and importing generic information. More...
class	InformationTypes
	Base class for all generic information objects to be able to put them in a typed list together. More...
class	IniProfile
	Class for reading and writing ini-profiles. More...
class	IniProfileObject
class	IniProfileSettings
class	IntervalTimer
	Timer class that has fixed time intervals at which it becomes true. More...
struct	is_iterable
struct	is_iterable< T, std::void_t< decltype(std::begin(std::declval< T >())), decltype(std::end(std::declval< T >()))> >
class	JsHighlighter
class	LayoutButton
	Button control opening another layout from file. More...
class	LayoutButtonPlugin
	Interface class to create the custom widget. More...
class	LayoutButtonPropertyPage
class	LayoutCustomWidgets
	Implementation of interface class for the creation of GII custom widgets. More...
class	LayoutData
class	LayoutEditor
class	LayoutEditorAppModule
class	LayoutEditorPropertyPage
class	LayoutTabs
	Widget for editing sf::Variable value types integer, floating point and single line string. More...
class	LayoutTabsPlugin
	Interface class to create the custom widget. More...
class	LineBuffer
	Special std::streambuf class for capturing lines. More...
class	LineEdit
	Line edit having its added actions as QToolButton's right of the QLineEdit. More...
class	LineEditPlugin
	Interface class to create the custom widget. More...
class	ListenerList
	Base class used as container for classes having listeners created by sf::TListener template. More...
class	ListModel
class	Locale
	Sets the numeric locale for a specific scope. More...
class	LocalVariable
	Create a local variable by calling the protected constructor. More...
class	MainWindow
class	MainWindowPropertyPage
class	ManualControlDialog
	The Dialog class represents a custom dialog window. More...
class	MaterialPropertyPage
	The MaterialPropertyPage class represents a custom dialog window. More...
class	Md5Hash
	Class replacing obsolete SSL 3.0 library MD5 functionality. More...
class	MiscCustomWidgets
	Implementation of interface class for the creation of Misc custom widgets. More...
class	MiscellaneousPropertyPage
class	ModuleConfiguration
class	ModuleConfigurationDialog
class	MultiDocInterface
	Interface for MDI document widgets handling files. More...
class	MultiDocInterfaceSignals
	Class to connect signals to the clients of a document. Since the class sf::MultiDocInterface cannot inheriting QObject because of Qt not allowing multiple inheritance of a QObject derived class. So this class is an intermediate. More...
class	Mutex
	Lightweight intra process thread synchronization. More...
class	notify_exception
class	ObjectExtension
	Interface class to multiple inherit when the sf::FormWriter class needs to be restricted in writing object properties. More...
class	ObjectHierarchyModel
	Item model for viewing Variables in a tree view. More...
class	ObjectPropertyModel
	List model for QObject properties. More...
class	OpenGLCustomWidgets
	Implementation of interface class for the creation of GII custom widgets. More...
class	OpenGLRenderer
	Pure virtual class to implement rendering separated from the widget and makes the sf::OpenGLWidget the placeholder. More...
class	OpenGLWidget
	Widget for rendering a OpenGHL scene. More...
class	OpenGLWidgetPlugin
	Interface class to create the custom widget. More...
class	PaletteColors
	Type to hold palette colors. More...
class	PaletteInterface
	Base class for the interface. More...
class	PaletteServer
	Server for color palettes used in images for coloring on basis of index. More...
class	PaletteServerPropertyPage
class	PartProject
struct	passwd_t
	Extends struct passwd and auto allocates needed memory. Used as a result type with auto memory cleanup . More...
class	PerformanceTimer
	High resolution timer for testing performance. More...
class	Persistent
	Class to multiple inherit which adds functions to read and write properties from a given object. The object can be the class itself or a child instance. More...
class	PlainTextEditMdi
class	PositionPropertyPage
class	ProjectAppModule
	Application module implementation for inspection projects. More...
class	ProjectConfig
class	ProjectData
class	ProjectModule
	Singleton. More...
class	ProjectPropertyPage
class	ProjectScriptObject
	Object for scripts to interact with the inspection project. More...
class	ProjectWidget
class	PropertyPage
	Widget to create a page in a PropertySheet dialog. More...
class	PropertyPagePlugin
	Interface class to create the custom widget. More...
class	PropertySheetDialog
	Dialog containing multiple property pages. More...
class	QString_QMatrix4x4
class	QtSync
	QSync provides a interface to build classes that act like monitors. More...
class	QtThreadClosure
	Class for creating Qt threads easier. More...
struct	RANGE
class	Range
	Class to manage 64-bit integer ranges. More...
class	RangeManager
	This class manages range requests made by clients identified by ID's in the ranges. More...
class	Resource
	Class for accessing resources like SVG images as a QIcon. More...
class	ResultData
	Class for creating and referencing global created data called result data. This class allows linking of member functions of other classes to handle events generated by the data server and client. More...
class	ResultDataHandler
	Class used to give a ResultData instance access to virtual method of a derived class. More...
struct	ResultDataReference
class	ResultDataRequester
	Handles requests and events for indexed data sources. More...
class	ResultDataScriptObject
	Script object for exporting GII parameters to a script object. More...
class	ResultDataStatic
	Base class of the sf::ResultData having all global static data members. More...
class	ResultDataTypes
	This base class contains all local types of used in the sf::ResultData class. Multiple inheritance makes these types local for other classes as well. Making code more readable and also prevents name space problems. More...
class	reverse_adapter
	Creates an adapter to reverse iterate over e.g. a std::vector or std::array. More...
class	RsaInterface
	Base class for the repetitive signal acquisition interface. More...
class	RsaServer
	RSA implementation of an information server. More...
struct	RsaTypes
	Type holding all types for the RsaInterface in a single namespaced structure. More...
class	ScanBinder
	Abstract base class for implementing scan binders. More...
class	ScanEntry
class	ScanMethod
class	SceneServerEditorFactory
class	SceneServerTaskMenu
class	scope_delete
	Deletes the pointer of type T allocated by 'new' when this instance goes out of scope. More...
class	scope_free
	Frees the pointer of type T allocated by 'malloc' when this instance goes out of scope. More...
class	ScriptAppModule
class	ScriptEditor
class	ScriptEngine
	Simple script engine able. More...
class	ScriptEntry
	Script entry for the list contained by the manager. More...
class	ScriptGlobalEntry
	Pure virtual class to register script accessible entries through the use of sf::ScriptGlobalObject class. More...
class	ScriptGlobalObject
	Base class for a script to implementing. More...
class	ScriptGlobalStaticEntry
	sf::ScriptGlobalEntry derived class to link static functions or methods. More...
class	ScriptHighlighter
	Highlighter of a document class used by edit widgets. More...
class	ScriptInterpreter
	Script interpreter for running a loaded script. More...
class	ScriptLink
	Links a script to a script interpreter derived instance. More...
class	ScriptListModel
	Provides a model list for instructions and variables of a script. More...
class	ScriptManager
	Manages scripts for the application. More...
class	ScriptManagerListModel
	List model for manipulating the passed script manager. More...
class	ScriptManagerPropertyPage
class	ScriptObject
	Info structure for objects used in scripts. More...
class	Security
	Interface for regulating user access to parts of the code. This class is commonly declared as static. The boolean operator returns true if access is allowed. More...
class	SegmentFaultHandler
	Class which intercepts SIGSEGV signals caused in a callback lambda function and recovers from it. Useful in unit testing where a SIGSEGV is expected to happen. More...
class	SelectImplementationDialog
class	Semaphore
	Semaphore class built around posix sem_xxx functionality. More...
class	SerialNumberPropertyPage
	The SerialNumberPropertyPage class represents a custom dialog window. More...
class	ServerConnection
	Class handling the connection exchanging data using a QIODevice. More...
class	ServerConnector
class	ServiceAppModule
class	ServicePropertyPage
class	SimplePalette
class	SocketClient
class	SocketServer
class	StaticSustain
	Implements a class to hook a static function to the global main thread sustain call. More...
class	StorageInterface
	Base class for the interface. More...
class	StorageServer
	Storage server. More...
class	StoreInspectionDialog
	Dialog to select a part and project to 'open' or 'save'. More...
class	StoreProject
	Class to manage the storing of a part project. More...
class	StoreProjectDialog
	Dialog to select a part and project to 'open' or 'save'. More...
class	SustainBase
	Base class for template TSustain which enables repetitive calls from the main thread with a set frequency. More...
class	Sync
	Sync provides a system-independent interface to build classes that act like monitors, i.e., classes in which only one member can execute on a particular instance at any one time. Sync uses Mutex, so it is portable to all platforms that Mutex has been ported to. More...
class	TAPointer
	Pointer to an array of type T. Provides an array subscript operator and uses array delete[]. More...
class	TBitSet
	Template for creating large memory inexpensive bitmasks or bit sets. More...
class	TCalibrationSets
class	TClassRegistration
	Template class used to register derived classes from a (virtual) interface class. Registering name and description. Example More...
class	TClosure
	Encapsulates the std::function() template. More...
class	TContour
struct	TContourInfo
struct	TContourItem
	Container for a single data segment. More...
class	TDeque
	Counted deque having additional methods and operators for ease of usage. More...
class	TDynamicArray
	A dynamic buffer as typed array. Has range check on any index. More...
class	TDynamicBuffer
	Template for creating a dynamic buffer using an allocator. More...
class	TEnvelope
	Envelope-letter type of smart pointers. More...
class	TextEditor
class	TextEditorAppModule
class	TFifoClass
	Fifo template for classes and structure pointers. More...
class	Thread
	Thread wrapper class to be used for attachment to an existing thread or a new to be created thread. This class can only be used to derive from since the constructor Thread::Thread() is protected by design. at least the run() function must be overridden. More...
class	ThreadClosure
	Class which combines a thread class and closure template. More...
class	ThreadMain
	Wrapper class for the main thread. More...
class	ThreadRelay
	Provides a way to stop executing a thread until the main thread enables the thread again. More...
struct	TimeSpec
	Class wrapper for timespec structure to modify. More...
class	TIterator
class	TitleBarButton
class	TListener
	Template class used to bind listeners to a handler_type instance. More...
class	TMatrix22
	Generic 2 x 2 matrix template. More...
class	TMatrix44
	Generic 4 x 4 matrix template. More...
class	ToolInformation
	Holds the needed information on a tool to make calculations. More...
class	TPartInspection
class	TPointer
	Pointer to a single object. Provides member access operator -> More...
class	TPointerBase
	A pair of smart pointer template classes. Provides basic conversion operator to T*, as well as dereference (*), and 0-checking (!). These classes assume that they alone are responsible for deleting the object or array unless Relinquish() is called. More...
class	TQuaternion
	Generic type Quaternion. More...
class	TRectangle2D
	Class to store and manipulate a rectangle based on floating point values. More...
class	TResultDataHandler
class	TScriptGlobalEntry
	Template for creating a script global entry linking a dynamic created method. More...
class	TSet
	Template class for managing bit maks preferably when bits are defined as enumerate values. More...
class	TStaticSync
	TStaticSync provides a system-independent interface to build sets of classes that act somewhat like monitors, i.e., classes in which only one member function can execute at any one time regardless of which instance it is being called on. TStaticSync uses Mutex, so it is portable to all platforms that Mutex has been ported to. More...
class	TStringList
	String list with optional object association and sorting. More...
class	TStrings
	Counted vector of strings. More...
class	TSustain
	Template to make the sustain system call a class method regularly. More...
class	TTypedList
	Interface class for managing an indexed lists. Sends out events when about to change and when changed using sf::TClosure instances. More...
class	TVariableHandler
	Template for linking pointers of member function to Variable instances. More...
class	TVector
	Counted vector having additional methods and operators for ease of usage. This template class extends the std::vector template with easier to use methods for adding finding entries and an array operator. More...
class	TVector2D
	2-dimensional vector for math operations. More...
class	TVector3D
	3-dimensional vector for math operations. More...
class	UnitConversionAppModule
struct	UnitConversionEvent
	Structure passed to handle unit conversions. More...
class	UnitConversionPropertyPage
class	UnitConversionServer
	Implementation of a unit conversion server using an ini-file. This conversion class installs a handler using setUnitConversionHandler() using a UnitConversionServerClosure type of function. More...
class	UnitConversionServerEx
	Extended UnitConversionServer with master and slaved variables. More...
class	UnitConverter
	unit conversion class to easy the pain of conversions in dialogs. More...
class	Value
	Value container class able to performing arithmetic functions. More...
class	Variable
	Class for creating and referencing global or local created parameters or settings called variables. This class allows linking of member functions of other classes to handle events generated. See the Example on how to use this class and the 'TVariableHandler' template class. More...
class	VariableBar
	Widget for showing sf::Variable value types integer and floating point having a minimum and maximum value. More...
class	VariableBarPlugin
	Interface class to create the custom widget. More...
class	VariableCheckBox
	Widget for editing sf::Variable value types integer, floating point and single line string. More...
class	VariableCheckBoxPlugin
	Interface class to create the custom widget. More...
class	VariableCollector
class	VariableComboBox
	Widget for editing sf::Variable value types integer, floating point and single line string. More...
class	VariableComboBoxPlugin
	Interface class to create the custom widget. More...
class	VariableEdit
	Widget for editing sf::Variable value types integer, floating point and single line string. More...
class	VariableEditPlugin
	Interface class to create the custom widget. More...
class	VariableHandler
	Base class used for giving a Variable instance access to a member functions of a derived class. This class is not used directly and is used a base class for the TVariableHandler<T> template class. More...
class	VariableIdList
	Class handling. More...
class	VariableIdPropertyPage
class	VariableListModel
	List model for a sf::Variable list. More...
class	VariableListView
	Implements a tree view (table) for a variable list. More...
class	VariableListViewPlugin
	Interface class to create the custom widget. More...
struct	VariableReference
class	VariableScriptObject
	Script object for exporting GII parameters to a script object. More...
class	VariableStatic
	Base class of the sf::Variable having all global static data members. More...
class	VariableTypes
	This base class contains all local types of used in the Variable class. Multiple inheritance makes these types local for other classes as well. Making code more readable and also prevents name space problems. More...
class	VariableWidgetBase
	Base class for sf::Variable based widgets. More...
class	WidgetPropertyPage

Typedefs
typedef TClosure< bool, UnitConversionEvent & >	UnitConversionServerClosure
	Type of the server callback function.
typedef TStringList< std::string >	StringList
typedef TEnvelope< IniProfile >	IniEnvelope
typedef IniProfile::KeyValueMap	KeyValues
typedef bool(*	TAddProjectPropertyPage) (PropertySheetDialog *sheet, const QString &ref_name)
	Type for registering tool and element editor property pages.
typedef bool(*	TGenerateReportEvent) (ProjectData *data, QStringList *templates)
	Type for registering the report generation event handler.
typedef QFlags< EReportOption >	ReportOptions
	Reporting option flags.
typedef TSet< ETranslateOption >	TranslateOptions
	Bitmap set of translation options.
typedef TClosure< std::string, const std::string & >	ConfigLocationClosure
	Type of the callback function.
typedef TDynamicBuffer< Allocator >	DynamicBuffer
	Actual specialized dynamic buffer type using the default allocator.
typedef TStrings< std::string >	strings
	Vector of std::strings with additional functionality.
typedef TStrings< std::wstring >	wstrings
	Vector of std::wstrings with additional functionality.
typedef struct stat	stat_t
	Easier typename for 'struct stat'.
typedef struct passwd	passwd_type
typedef struct group	group_type
typedef QList< QRgb >	ColorTable
typedef TClosure< qreal, qreal >	ColorShiftCurve

Enumerations
enum	ECalibrationValueState { cvsEMPTY , cvsINITIALIZED , cvsASSIGNED }
	State of the calibration value. More...
enum	EMaterialType : int { mtMAT_ALL = -1 , mtMAT_LIQUID = 0 , mtMAT_SOLID , mtMAT_GAS }
	Enumerate type to identify a material. More...
enum	ECalibrationType : int { ctCAL_NONE = 0 , ctCAL_PRE , ctCAL_POST , ctCAL_LASTENTRY }
	Type to identify a scan area type. More...
enum	EInspectionState : int { isUNKNOWN = 0 , isACCEPTED , isREJECTED , isLASTENTRY }
	States for results of an inspection. More...
enum	ESystemPosition : int {   spSYSPOS_NONE = -1 , spSYSPOS_PARK , spSYSPOS_LOAD , spSYSPOS_TOOL ,   spSYSPOS_LASTENTRY }
	Fixed system dependent axis positions. More...
enum	EReportOption : int {   roFILE , roVIEW , roPRINT , roSHORTCUT ,   roSEND }
	Final reporting options. More...
enum	EContourItemType { citNONE , citARC , citPOINT }
enum	EContourItemPoint {   cipNONE = -1 , cipCENTER , cipSTART , cipSTOP ,   cipMID , cipLAST_ENTRY }
enum	ETranslateOption : int { toSECSOLUTION , toTOGGLESECSOL , toNOSURFACECALC }
	Translation options for the sf::TranslateToNipscanCoords() function/. More...
enum	EDebugOutputType : int {   dotThrow = 1U << 0U , dotMessageBox = 1U << 1U , dotStdLog = 1U << 2U , dotStdOut = 1U << 3U ,   dotStdErr = 1U << 4U , dotDebugString = 1U << 5U , dotDebugBreak = 1U << 6U , dotDefault = 1U << 7U }
enum	SceneOption : int {   soWireModel = 1 << 0 , soShowNormals = 1 << 1 , soPaint = 1 << 2 , soSwitch1 = 1 << 3 ,   soSwitch2 = 1 << 4 }
	Scene options for rendering. Use a full namespace type path when specifying a Q_PROPERTY(...) More...
enum	OrbitMode { omCamera , omModel , omLightDirection , omLightPosition }
	Modes for changing an OpenGL property of a scene. Use a full namespace type path when specifying a Q_PROPERTY(...) More...

Functions
bool _GII_FUNC	saveVariableValues (IniProfile &profile)
	Saves variable settings to the passed profile instance.
bool _GII_FUNC	loadVariableValues (IniProfile &profile, const std::function< bool(InformationTypes::id_type, Value &)> &func=nullptr)
_GII_FUNC std::ostream &	operator<< (std::ostream &os, const ResultData &)
	Stream operator for the setup std::string.
_GII_FUNC std::istream &	operator>> (std::istream &is, ResultData &)
	Stream operator for setting up this instance with a setup std::string.
_GII_FUNC void	setUnitConversionHandler (const UnitConversionServerClosure &closure={})
	Sets the callback function for a security server.
_GII_FUNC bool	getUnitConversion (const std::string &option, const std::string &from_unit, int from_precision, double &multiplier, double &offset, std::string &to_unit, int &to_precision)
	Returns true if a conversion could be made. Calculation to convert are: From -> To calculation: new_value = (value * multiplier) + offset; To -> From calculation: new_value = (value - offset) / multiplier;
_GII_FUNC std::ostream &	operator<< (std::ostream &os, const Variable &v)
_GII_FUNC std::istream &	operator>> (std::istream &is, Variable &v)
	Stream operator for the setup std::string.
_GII_FUNC std::ostream &	operator<< (std::ostream &os, const Variable::State::Vector &v)
	Stream operator for setting up this instance with a setup std::string.
_GMI_FUNC std::ostream &	operator<< (std::ostream &os, const gmi::AxesCoord &ac)
	Operator for writing the sf::gmi::AxesCoord to an output-stream.
_GMI_FUNC std::istream &	operator>> (std::istream &is, gmi::AxesCoord &ac)
	Operator for reading the sf::gmi::AxesCoord from an input stream.
constexpr std::string_view	SEC_TE_SELECTED ("Selected")
constexpr std::string_view	SEC_TE_SERIALS ("Serial Numbers")
constexpr std::string_view	SEC_TE_INFO ("Information")
constexpr std::string_view	SEC_MAT_SOUNDVEL ("Sound Velocity")
constexpr std::string_view	SEC_MAT_INFO ("Information")
constexpr std::string_view	KEY_MAT_LONGITUDINAL ("Longitudinal")
constexpr std::string_view	KEY_MAT_SHEAR ("Shear")
constexpr std::string_view	KEY_MAT_FORM ("Form")
constexpr std::string_view	SUBDIR_PART ("Part")
constexpr std::string_view	SUBDIR_TOOL ("Tool")
constexpr std::string_view	SUBDIR_ELEMENT ("Element")
constexpr std::string_view	SUBDIR_MATERIAL ("Material")
constexpr std::string_view	SUBDIR_SETTINGS ("Settings")
constexpr std::string_view	SUBDIR_TEMPLATE ("Template")
constexpr std::string_view	EXT_PROJECT (".iprj")
constexpr std::string_view	EXT_AREASCAN (".ascn")
constexpr std::string_view	EXT_AREASTATE (".ascns")
constexpr std::string_view	EXT_ELEMENT (".elem")
constexpr std::string_view	EXT_MATERIAL (".mater")
constexpr std::string_view	EXT_SETTINGS (".gisf")
constexpr std::string_view	EXT_FILTERS (".fltr")
constexpr std::string_view	EXT_TOOL (".tool")
constexpr std::string_view	FILE_PICTURE ("picture.jpg")
constexpr std::string_view	EXT_INSPECTION (".insp")
constexpr std::string_view	FILE_INSPECTION ("Inspection")
constexpr std::string_view	FILE_PARTSTATE ("PartState")
constexpr std::string_view	EXT_CALIB (".calib")
constexpr std::string_view	HLPCTX_SETUPFAIL ("fail_setup_change")
constexpr std::string_view	PROJECT_NAME_DELIM ("@")
constexpr std::string_view	PROJECT_FULL_DELIM ("|")
constexpr std::string_view	INSPECT_SERIAL_DELIM (">")
constexpr std::string_view	INSPECT_DATETIME_DELIM ("<")
constexpr std::string_view	SEC_INSP_GENERAL ("General")
constexpr std::string_view	SEC_INSP_CUSTOM ("Custom")
constexpr std::string_view	SEC_INSP_ANALYSIS ("Analysis")
constexpr std::string_view	SEC_INSP_AREA_PREFIX ("ScanArea,")
constexpr std::string_view	SEC_INSP_CALIB ("Calibration,")
constexpr std::string_view	KEY_INSP_SYSNAME ("System Name")
constexpr std::string_view	KEY_INSP_SYSUSER ("System User")
constexpr std::string_view	KEY_INSP_APPUSER ("Application User")
constexpr std::string_view	KEY_INSP_SCANUSER ("User Name")
constexpr std::string_view	KEY_INSP_DATETIME ("Date Time")
constexpr std::string_view	KEY_INSP_PART ("Part")
constexpr std::string_view	KEY_INSP_PROJECT ("Project")
constexpr std::string_view	KEY_INSP_SERIAL ("Serial")
constexpr std::string_view	KEY_INSP_STATE ("State")
constexpr std::string_view	KEY_INSP_CALTYPE ("CalType")
constexpr std::string_view	KEY_INSP_COMMENT ("Comment")
constexpr std::string_view	KEY_INSP_DATAFILE ("DataFile")
constexpr std::string_view	KEY_INSP_FINALIZED ("Finalized")
constexpr std::string_view	KEY_INSP_FINALIZEDATE ("Finalize Date")
constexpr std::string_view	KEY_INSP_FINALIZEUSER ("Finalize User")
constexpr std::string_view	SEC_CFG_GENERAL ("General")
constexpr std::string_view	KEY_CFG_DESIG_PREFIX ("Designation_")
constexpr std::string_view	KEY_CFG_SETTINGSGLOBAL ("Settings Global")
constexpr std::string_view	KEY_CFG_FILTERLISTGLOBAL ("Filter List Global")
constexpr std::string_view	SEC_MOD_SYSPOS ("System Positions")
constexpr std::string_view	STR_VERSION ("0.0")
constexpr std::string_view	SEC_GENERAL ("General")
constexpr std::string_view	KEY_VERSION ("Version")
constexpr std::string_view	KEY_CREATED ("Created At")
constexpr std::string_view	KEY_CREATOR ("Created By")
constexpr std::string_view	KEY_MODIFIED ("Modify Date")
constexpr std::string_view	KEY_MODIFIER ("Modify By")
constexpr std::string_view	SEC_SCANS ("Scans")
constexpr std::string_view	KEY_SCANCOUNT ("Scan Count")
constexpr std::string_view	KEY_SCANAREA ("Scan Area")
constexpr std::string_view	KEY_SCANMETHOD ("Scan Method")
constexpr std::string_view	KEY_SCANBINDER ("Scan Binder")
constexpr std::string_view	SEC_REPORT ("Report")
constexpr std::string_view	KEY_OPTIONS ("Options")
constexpr std::string_view	KEY_TEMPLATE ("Template")
QString	GetFilteredString (const QString &str, const QString &filter)
	Filters a string removing all characters from the given filter string.
QString _IPJ_FUNC	GetMaterialTypeName (EMaterialType)
	Gets the passed material type as a name.
EMaterialType _IPJ_FUNC	GetMaterialType (const QString &mat_type)
	Gets the passed calibration type name as enumerate value.
_IPJ_FUNC QString	GetCalibrationTypeName (ECalibrationType)
	Returns the passed calibration type as a name.
_IPJ_FUNC ECalibrationType	GetCalibrationType (const QString &cal_type)
	Returns the passed calibration type name as enumerate value.
_IPJ_FUNC QString	GetInspectionStateName (EInspectionState)
	Gets the passed inspection state as a name.
_IPJ_FUNC EInspectionState	GetInspectionState (const QString &state_name)
	Gets the passed inspection state name as enumerate value.
_IPJ_FUNC QString	GetSystemPositionName (ESystemPosition sp)
	Gets the passed system position name.
_IPJ_FUNC ESystemPosition	GetSystemPositionFromName (const QString &sp)
	Gets the system position from the name.
_IPJ_FUNC QString	GetSystemPositionInfo (ESystemPosition sp)
	Gets the current scan inspection state converted from the passed name.
_IPJ_FUNC ProjectModule *	getProjectModule ()
	Creates the project module when called for.
_IPJ_FUNC void	destroyProjectModule ()
	Deletes the project module if it was created.
_IPJ_FUNC QString	GetReportOptionDescription (EReportOption ro)
	Gets the option description of the passed style.
_IPJ_FUNC void	GetReportOptionDescriptions (QStringList &strings)
	Gets the description in a string list of the passed options.
_IPJ_FUNC QString	DateTimeToInspectStr (const QDateTime &dt)
	Converts a TDateTime to an inspection date time string.
_IPJ_FUNC QDateTime	InspectStrToDateTime (const QString &str)
	Converts an inspection date time string into a QDateTime value.
_IPJ_FUNC const char *	GetProjectNameFilter ()
	Returns characters that are not allowed to appear in the names.
_IPJ_FUNC std::string	compatCommaSepString (const std::string &str)
	Gets a '(' and ')' wrapped string when the given string is not.
constexpr std::string_view	DEFAULT_SCANBINDERNAME ("<default>")
constexpr std::string_view	SEC_BINDER_GENERAL ("Scan Binder")
constexpr std::string_view	KEY_IGNOREOFFSET ("Ignore Project Offset")
bool _KTM_FUNC	GetSurfaceMatrix (const Vector2D &surf_point, double surf_angle, double rot_angle, Matrix44 &surface)
	Gets the matrix of the surface of the contour info of a rotation symmetrical object.
bool _KTM_FUNC	GetSurfaceMatrix (const Vector2D &surf_point, double surf_angle, double rotangle, double anglexz, double angleyz, double anglexy, Matrix44 &surface)
	Gets the matrix of the surface of the contour info of a rotation symmetrical object.
void _KTM_CLASS	storeElementInfo (IniProfile &ini, const std::string &section, ElementInformation &eid, bool read)
bool _KTM_FUNC	TranslateToNipscanCoords (const Matrix44 &surface, const ToolInformation &tool, double beamlen, double &x, double &y, double &z, double &a, double &b, TranslateOptions options={})
	Gets the translating a matrix value to manipulator coordinates. This function should be part of a scan mode but will be needed else where too.
Vector3D _KTM_FUNC	getToolBeamVector (const ToolInformation &tool, double beam_len, double a, double b)
	Gets the vector which can be added to the xyz-axis position vector to get the focus position.
Vector3D _KTM_FUNC	getBeamVector (const ToolInformation &tool, double beam_len, double a, double b)
	Not clear where it is used for.???
bool _KTM_FUNC	CalcTangent (int select, const Vector2D &c1, double radius1, Vector2D &tg1, const Vector2D &c2, double radius2, Vector2D &tg2)
bool _KTM_FUNC	GetLineValues (const Vector2D &p, double angle, double &slope, double &yofs)
bool _KTM_FUNC	GetLineValues (const Vector2D &p1, const Vector2D &p2, double &slope, double &yofs)
bool _KTM_FUNC	GetIntersection (const Vector2D &p11, const Vector2D &p12, const Vector2D &p2, double angle2, Vector2D &ip)
bool _KTM_FUNC	GetIntersection (const Vector2D &center, double radius, const Vector2D &p, double angle, Vector2D &ip1, Vector2D &ip2)
template<typename T >
std::ostream &	operator<< (std::ostream &os, const TMatrix22< T > &mtx)
	Operator for writing the sf::TMatrix22 to an output-stream.
template<typename T >
std::istream &	operator>> (std::istream &is, TMatrix22< T > &mtx) noexcept(false)
	Operator for reading the sf::TMatrix22 from an input stream.
template<typename T >
TMatrix44< T >	operator* (const TMatrix44< T > &lm, const TMatrix44< T > &rm)
	Multiplies to matrices into a single one.
template<typename T >
std::ostream &	operator<< (std::ostream &os, const TMatrix44< T > &mtx)
	Operator for writing the matrix to an output-stream.
template<typename T >
std::istream &	operator>> (std::istream &is, TMatrix44< T > &mtx) noexcept(false)
	Operator for reading the matrix from an input stream.
template<typename T >
TQuaternion< T >	operator+ (const TQuaternion< T > &lhs, const TQuaternion< T > &rhs)
	Adds two quaternions.
template<typename T >
TQuaternion< T >	operator- (const TQuaternion< T > &lhs, const TQuaternion< T > &rhs)
	Subtracts two quaternions.
template<typename T >
TQuaternion< T >	operator* (const TQuaternion< T > &lhs, const TQuaternion< T > &rhs)
	Multiplies two quaternions.
template<typename T >
TQuaternion< T >	operator/ (const TQuaternion< T > &lhs, const TQuaternion< T > &rhs)
	Divides two quaternions.
template<typename T >
TQuaternion< T >	operator* (T c, const TQuaternion< T > &quat)
	Multiplies a scalar value with a quaternion.
template<typename T >
std::ostream &	operator<< (std::ostream &os, const TQuaternion< T > &quat)
	Operator for writing the sf::TQuaternion to an output-stream. Calls TQuaternion::toString() for the operator.
template<typename T >
std::istream &	operator>> (std::istream &is, TQuaternion< T > &quat) noexcept(false)
	Operator for reading the sf::TQuaternion from an input stream. Calls TQuaternion<T>::fromString() to perform this operator.
template<typename T >
std::istream &	operator>> (std::istream &is, TRectangle2D< T > &)
	Extracts the rectangle from an input stream.
template<typename T >
std::ostream &	operator<< (std::ostream &os, const TRectangle2D< T > &)
	Writes the rectangle into an output stream.
template<typename T >
TVector2D< T >	operator* (T c, const TVector2D< T > &v)
template<typename T >
TVector2D< T >	operator* (const TVector2D< T > &v, T c)
template<typename T >
std::istream &	operator>> (std::istream &is, TVector2D< T > &v) noexcept(false)
	Operator for reading a vector from a stream.
template<typename T >
std::ostream &	operator<< (std::ostream &os, const TVector2D< T > &v)
	Operator for writing a vector to a stream.
template<typename T >
TVector3D< T >	operator* (T c, const TVector3D< T > &v)
template<typename T >
TVector3D< T >	operator* (const TVector3D< T > &v, T c)
template<typename T >
std::istream &	operator>> (std::istream &is, TVector3D< T > &v) noexcept(false)
	Operator for reading a vector from a stream.
template<typename T >
std::ostream &	operator<< (std::ostream &os, const TVector3D< T > &v)
	Operator for writing a vector to a stream.
_MISC_FUNC void	setConfigLocationHandler (const ConfigLocationClosure &handler={})
	Sets the callback function for the getConfigLocation() function.
_MISC_FUNC std::string	getConfigLocation (const std::string &option={}, bool separator=false)
	Gets the configuration location/directory of the application.
std::ostream &	operator<< (std::ostream &os, const IniProfile &profile)
_MISC_FUNC bool	operator== (const Md5Hash::hash_type &h1, const Md5Hash::hash_type &h2)
	Compare operator for storing an MD5 hash.
bool	operator== (const Md5Hash &h1, const Md5Hash &h2)
	Compare operator for storing an MD5 hash.
std::ostream &	operator<< (std::ostream &os, const Md5Hash &hash)
	Stream operator for showing hexadecimal hash value.
_MISC_FUNC std::istream &	operator>> (std::istream &is, Md5Hash &h)
	Read hash from input stream.
_MISC_FUNC std::ostream &	operator<< (std::ostream &os, const Range &r)
	Output stream operator for a range.
_MISC_FUNC std::istream &	operator>> (std::istream &is, Range &r)
	Input stream operator for a range.
_MISC_FUNC std::ostream &	operator<< (std::ostream &os, const Range::Vector &rl)
	Output stream operator for a range vector.
_MISC_FUNC std::istream &	operator>> (std::istream &is, Range::Vector &rl)
	Input stream operator for a range vector.
_MISC_FUNC Value	calculator (const std::string &script, const Value &def)
	Calculator function that converts a formula of the passed string to a #sf::Value.
_MISC_FUNC Value::flt_type	calculator (const std::string &script, Value::flt_type def)
	Calculator function that converts a formula of the passed string to a floating point value.
_MISC_FUNC Value::flt_type	calculator (const std::string &script, Value::flt_type def, Value::flt_type x, Value::flt_type y=0.0, Value::flt_type z=0.0)
	Same as calculator() only the passed variable 'x', 'y', 'z' are available as a constant in the script.
_MISC_FUNC bool	setSustainTimer (int msec)
	This function will enable a timer that call all Sustain functions in the _defaultVector member of the 'TSustain' template class. Passing the repetition rate in milliseconds. if the passed time is zero the timer stops. Returns true if it was successful.
_MISC_FUNC int	getSustainTimer ()
	Gets the current sustain timer interval in milliseconds.
std::string	getLibraryName ()
	function to get the library filename this function is called from.
template<typename T >
std::ostream &	operator<< (std::ostream &os, TDeque< T > const &v)
	Output stream operator.
_MISC_FUNC std::ostream &	operator<< (std::ostream &os, const Value &v)
	Value class output stream operator.
_MISC_FUNC std::istream &	operator>> (std::istream &is, Value &v)
	Value class input stream operator.
_MISC_FUNC void	UserOutputDebugString (unsigned int type, const char *str) noexcept
	Allows the passed string to be presented in various ways.
_MISC_FUNC void	SetDefaultDebugOutput (unsigned int type)
	Set and get function for the type of output when DO_DEFAULT is passed.
_MISC_FUNC unsigned int	GetDefaultDebugOutput ()
	Returns the combination of EDebugOutputType which is the default output.
_MISC_FUNC std::string	getBacktrace ()
	Prints the backtrace to a stream.
_MISC_FUNC void	printBacktrace (std::ostream &os)
	Prints the backtrace to a stream.
_MISC_FUNC bool	isDebug ()
	Gets the debug status.
_MISC_FUNC bool	isDebuggerActive ()
	Gets the debugger active status.
_MISC_FUNC void	debugBreak ()
	Causes a break when debugging.
_MISC_FUNC void	freeConsole (bool always=false)
	Closes the console window.
_MISC_FUNC std::string	demangleTypeName (const char *name)
	Demangle the passed rtti mangled type name.
template<typename T >
std::string	getTypeName (const T ptr)
	Get the demangled type name of the passed pointer type.
_MISC_FUNC std::string	getLine (std::istream &is)
	Return a line from the input stream.
_MISC_FUNC bool	fileExists (const char *path)
	Checks if the passed path exist (by doing an access() using F_OK).
bool	fileExists (const std::string &path)
	Checks if the passed path exist (by doing an access() using F_OK).
_MISC_FUNC std::string	fileBaseName (const std::string &path)
	Same as basename() but using a std::string.
_MISC_FUNC std::string	fileDirName (const std::string &path)
	Same as dirname() but using a std::string.
_MISC_FUNC bool	fileUnlink (const std::string &path)
	Same as unlink() but using a std::string.
_MISC_FUNC bool	fileRename (const std::string &old_path, const std::string &new_path)
	Same as rename() but using a std::string.
_MISC_FUNC bool	findFiles (strings &files, const std::string &wildcard)
	Finds the files using the passed wildcard.
_MISC_FUNC std::string::value_type	getDirectorySeparator ()
	Returns OS dependent directory separation character.
_MISC_FUNC std::string	getDynamicLibraryExtension ()
	Returns OS dependent dynamic library extension.
_MISC_FUNC std::string	getTemporaryDirectory ()
	Returns the temporary directory.
_MISC_FUNC std::string	getWorkingDirectory ()
	Returns the working directory.
_MISC_FUNC std::string	getExecutableFilepath ()
	Returns the executable filepath.
_MISC_FUNC std::string	getExecutableDirectory ()
	Returns the executable directory.
_MISC_FUNC std::string	getExecutableName ()
	Returns the executable name.
template<typename T >
T	round (T value, T rnd)
	Rounds the passed value to a multiple of the rnd value.
template<typename T , typename S >
S	calculateOffset (T value, T min, T max, S len, bool clip)
	Calculates the offset for a given range and set point.
template<typename T >
T	clip (const T value, const T lower_limit, const T upper_limit)
	Template function clipping the given value between an upper_limit and lower_limit.
template<typename V , typename T >
bool	isInRange (const V value, const T from, const T to)
	Checks if the passed value is in the given range.
template<typename T >
T	random (T start, T stop)
	Generates random numbers within a specified integer range.
template<typename T >
T	modulo (T k, T n)
	Modulo template function.
template<typename T >
T	toAbs (T v)
	Gets the absolute value of a passed scalar value.
template<typename T >
T	ipow (T base, int exponent)
	Fast integer power-of function.
template<typename T >
constexpr T	toRadians (T degrees)
	Converts degrees to radians.
template<typename T >
constexpr T	toDegrees (T radians)
	Converts radians to degrees.
template<typename T >
bool	isEqual (T a, T b, T epsilon=std::numeric_limits< T >::epsilon())
	Compares 2 floating point values of the same type with a given epsilon.
template<typename T >
bool	isZero (T value, T epsilon=std::numeric_limits< T >::epsilon())
	Check if the passed value is zero or near zero according the given epsilon.
template<typename T >
bool	isValidValue (T value)
	Check if the passed value is not NaN or infinity.
template<typename T , typename... Args>
size_t	maxArgumentIndex (T first, Args... args)
	Finds the index of the largest element passed as an argument.
template<typename T , typename... Args>
size_t	minArgumentIndex (T first, Args... args)
	Finds the index of the smallest element passed as an argument.
template<typename T , size_t N>
size_t	maxArrayIndex (const std::array< T, N > &arr)
	Finds the largest element index of the passed array.
template<typename T , size_t N>
size_t	minArrayIndex (const std::array< T, N > &arr)
	Finds the largest element index of the passed array.
_MISC_FUNC int	precision (double value)
	Returns the precision of the passed floating point value. This is the amount of characters after the point without the trailing zeros. When the value is 12300.00 the value returned is 3. When the value is 0.0123 the value returned is also 3.
_MISC_FUNC int	digits (double value)
	Returns the amount of digits which are significant for the value. When the value is 12300.00 the value returned is -2. When the value is 0.0123 the value returned is 4.
template<typename T >
std::pair< T, int >	getMantissaExponent (T value)
	Gets the mantissa and exponent part of a floating point value.
template<typename T >
int	magnitude (T value)
	Gets the order of magnitude of the passed floating point value. Examples: magnitude(0.001234) => -2 magnitude(0.123400) => 0 magnitude(12340.00) => 5.
_MISC_FUNC int	magnitudeObsolete (double value)
	Gets the order of magnitude of the passed double value. Examples: magnitude(0.001234) => -2 magnitude(0.123400) => 0 magnitude(12340.00) => 5.
_MISC_FUNC int	requiredDigits (double round_val, double min_val, double max_val)
	Gets the amount of required digits needed when drawing a scale.
template<typename T >
void	delete_null (T &p)
	Deletes object and clears pointer.
template<typename T >
void	delete_anull (T &p)
	Deletes an array previous allocated by 'new[]' when the pointer is non-null and also nulls the passed pointer.
template<typename T >
void	free_null (T &p)
	Template function freeing a pointer previous allocated by 'malloc' when the pointer is non-null and also nulls the passed pointer.
template<typename T >
void	swap_it (T &t1, T &t2)
	Swaps the passed two arguments of any type.
template<typename T >
T &	null_ref ()
template<typename T >
bool	not_ref_null (T &r)
_MISC_FUNC char *	decimal_separator_fix (char *buffer, size_t len)
	Replaces a decimal comma for a point. This instead of changing the global locale. Used by template functions.
_MISC_FUNC size_t	strncspn (const char *s, size_t n, const char *reject)
	The strncspn() function calculates the length of the initial segment of 's' which consists entirely of characters not in reject up to a maximum 'n'. When no reject chars were found n is returned.
_MISC_FUNC size_t	strnspn (const char *s, size_t n, const char *accept)
	The strncspn() function calculates the length of the initial segment of 's' which consists entirely of characters in accept up to a maximum 'n'.
_MISC_FUNC const char *	strnstr (const char *s, const char *find, size_t n)
	Find the first occurrence of find in s, where the search is limited to the first slen characters of s.
_MISC_FUNC std::string	demangle (const char *name)
	Returns the unmangled function name returned by type ID.
_MISC_FUNC char	hexCharValue (char ch)
	Returns numeric the value of the passed hexadecimal character.
_MISC_FUNC size_t	stringHex (const char *hexstr, void *buffer, size_t sz)
	Converts a hexadecimal string to a block of data.
_MISC_FUNC std::string	hexString (const void *buffer, size_t sz)
	Converts a block of data to a hexadecimal string.
_MISC_FUNC std::string	bitToString (unsigned long wrd, size_t count)
	Converts an integer value to bit string '0' and '1' characters where the first character is the first bit.
_MISC_FUNC std::string	escape (const std::string &str, char delimiter='\0')
	Escapes all control and non ascii characters.
_MISC_FUNC std::string	unescape (const std::string &str)
	Unescapes the passed string escaped by the escape() function.
_MISC_FUNC std::string	filter (std::string str, const std::string &filter)
	Filters all characters from the passed string and returns the resulting string.
_MISC_FUNC std::string	toLower (std::string s)
	Converts the passed string into a lower case one and returns it.
_MISC_FUNC std::string	toUpper (std::string s)
	Converts the passed string into an upper case one and returns it.
_MISC_FUNC std::string	trimLeft (std::string s, const std::string &t=" ")
	Trims a passed string left and returns it.
_MISC_FUNC std::string	trimRight (std::string s, const std::string &t=" ")
	Trims a passed string right and returns it.
_MISC_FUNC std::string	trim (std::string s, const std::string &t=" ")
	Trims a passed string at both sides and returns it.
_MISC_FUNC int	wildcmp (const char *wild, const char *str, bool case_s)
	Matches a string against a wildcard string such as "*.*" or "bl?h.*" etc.
int	wildcmp (const std::string &wild, const std::string &str, bool case_s)
	Matches a string against a wildcard string such as "*.*" or "bl?h.*" etc.
_MISC_FUNC std::string	error_string (int error_num)
	Thread safe version strerror_r() or strerror_s() when cross compiling for Windows.
_MISC_FUNC std::string	stringf (const char *fmt,...)
	Creates a formatted string and returns it in a string class instance.
_MISC_FUNC std::string	replaceAll (const std::string &s, const std::string &from, const std::string &to)
	Replaces all occurrences of 'from' substring and replaces them with 'to' string.
template<typename... Args>
std::string	string_format (const std::string &format, Args &&... args)
	Better implementation of 'stringf' ?
template<typename T >
char *	gcvt (T value, int ndigits, char *buf, size_t len)
	Converts a floating-point number to a string always using a decimal point. It produces 'digits' significant digits in either printf(3) F format or E (scientific) format. Always returns a decimal point without setting the global locale.
template<typename T >
std::string	gcvtString (T value, int ndigits=0)
	Converts a floating-point number to a string always using a decimal point.
template<typename T >
char *	itoa (T value, char *buffer, int base=10)
	Converts an integer type value to a buffer. The itoa function converts value to a null-terminated buffer and stores the result in buffer. With itoa, value is an integer. Note: The space allocated for buffer must be large enough to hold the returned buffer, including the terminating null character (\0). itoa can return up to (sizeof(T) * CHAR_BIT + 1) bytes.
template<typename T >
std::string	itostr (T value, int base=10)
	Converts an integer type value to a std::string.
template<typename T >
T	toFloat (const char *ptr, char **end_ptr=nullptr)
	A locale independent template version for std::strtof(), std::strtod() and std::strtold() functions which uses locale "C".
template<typename T , typename S = std::string>
T	toNumber (const S &s, size_t *idx=nullptr)
	Converts a std::string to a T value and whe not possible it returns the passed default.
template<typename T , typename S = std::string>
T	toNumberDefault (const S &s, T def)
	Converts a std::string to a T value and when not possible it returns the passed default.
template<typename T >
std::string	toString (T value, int digits=0)
	The function converts number to a minimal length. It produces 'digits' significant digits in either printf(3) F format or E (scientific) format. Always returns a decimal point without setting the global locale. In case of more than 3 trailing zeros with large numbers a scientific notation is formed instead.
template<typename T >
std::string	toStringPrecision (T value, int prec=std::numeric_limits< int >::max())
	Converts any floating point value in to a string with a given precision. The default precision shows a .
_MISC_FUNC std::string	numberString (double value, int digits, bool sign_on=true)
	String formats a floating point or integer value using scientific notation. where the exponent is always a multiple of 3.
_MISC_FUNC std::istream &	read_to_delimiter (std::istream &is, std::string &s, char delimiter)
	Read a stream until a given delimiter.
template<typename T >
int	fcvt_r (T value, int ndigit, int *decpt, int *sign, char *buf, size_t len)
	Function identical to ecvt(), except that 'ndigits' specifies the number of digits after the decimal point.
template<typename T >
int	ecvt_r (T value, int ndigit, int *decpt, int *sign, char *buf, size_t len)
	Converts number to a null-terminated string of 'ndigits' digits. where 'ndigits' is reduced to a system-specific limit determined by the precision of a double. The high-order digit is nonzero, unless number is zero. The low order digit is rounded. The string itself does not contain a decimal point; however, the position of the decimal point relative to the start of the string is stored in *decpt. A negative value for *decpt means that the decimal point is to the left of the start of the string. If the sign of number is negative, *sign is set to a nonzero value, otherwise it is set to 0. If number is zero, it is unspecified whether *decpt is 0 or 1.
template<typename T >
std::string	asString (const T &list, const std::string &separator={})
	Converts an iterable list into a string with the given separator.
template<typename T >
void	fromString (T &list, const std::string &str, const std::string &separator={})
	Converts a string into a typed list.
_MISC_FUNC int	getThreadCount ()
	Gets the thread count from the current process.
_MISC_FUNC timespec	getTimeRunning ()
	Gets the time this application is running.
_MISC_FUNC bool	loadDynamicLibrary (const std::string &path)
	Loads a dynamic library from the given path.
_MISC_FUNC void	systemBeep (int frequency, int duration)
	When possible makes the computer system beep.
_MISC_FUNC int	timespecCompare (const timespec &ts1, const timespec &ts2)
	Compares the 2 'timespec' time structures. Helper function.
_MISC_FUNC timespec	getTime (bool real_time=false)
	Gets the timespec as function return value as clock_gettime() for the current time.
template<typename T >
void	copy_data (T &dest, const T &src) noexcept(true)
	Does a binary copy from source to destination data.
std::string	getGCCVersion ()
	Gets the GNU compiler version.
std::string_view	getCppStandard ()
	Gets the C++ standard used.
_MISC_FUNC std::string	getOSVersion ()
	Gets the OS and version used.
_MISC_FUNC std::string_view	getCpuArchitecture ()
	Gets the CPU architecture returned from 'uname -m' command.
_MISC_FUNC std::string	getSystemName ()
	Gets the name of the system.
_MISC_FUNC std::string	getUserLogin ()
	Gets the name of the current user of the system.
_MISC_FUNC bool	kb_hit ()
_MISC_FUNC pid_t	gettid () noexcept
_MISC_FUNC bool	getFiles (strings &files, const std::string &directory, const std::string &wildcard)
_MISC_FUNC bool	file_write (const char *path, const void *buf, size_t sz, bool append=false)
	Writes a buffer to a filepath.
bool	file_write (const std::string &path, const void *buf, size_t sz, bool append=false)
	Writes a character buffer to file.
bool	file_write (const std::string &path, const std::string &s, bool append=false)
	Writes a std::string to file.
_MISC_FUNC std::filesystem::path	file_fd_path (int fd)
_MISC_FUNC bool	file_stat (const std::string &path, stat_t &_stat)
	Same as stat() but using a std::string.
_MISC_FUNC std::string	time_format (const struct tm *time_info, const char *format=nullptr)
	Formats the time to the given format.
_MISC_FUNC std::string	time_format (time_t time=-1, const char *format=nullptr, bool gm_time=false)
	Formats the time to the given format.
_MISC_FUNC time_t	time_str2time (const std::string &str, const char *format=nullptr, bool gm_time=false)
	Gets the unix time from the passed string in the format that was passed.
_MISC_FUNC time_t	time_mktime (struct tm *tm, bool gm_time=false)
	Same as mktime().
_MISC_FUNC bool	file_mkdir (const char *path, __mode_t mode=0755)
	Makes all directories recursively in the path.
bool	file_mkdir (const std::string &path, __mode_t mode=0755)
	Makes all directories recursively in the path.
bool	proc_getpwnam (std::string name, passwd_t &pwd)
bool	proc_getpwuid (uid_t uid, passwd_t &pwd)
void	proc_setuid (uid_t uid)
void	proc_seteuid (uid_t uid)
_MISC_FUNC bool	proc_getgrnam (const std::string &name, group_t &grp)
_MISC_FUNC bool	proc_getgrgid (gid_t gid, group_t &grp)
_MISC_FUNC void	proc_setgid (gid_t gid)
_MISC_FUNC void	proc_setegid (gid_t gid)
_MISC_FUNC void	proc_setfsuid (uid_t uid)
_MISC_FUNC void	proc_setfsgid (gid_t gid)
int _MISC_FUNC	siginterrupt (int sig, int flag)
	Replacement for deprecated 'siginterrupt' function. Returns EINVAL when the sig argument is not a valid signal number otherwise zero.
_MISC_FUNC QSettings *	setGlobalSettings (QSettings *settings)
	Sets global settings class for settings.
_MISC_FUNC QSettings *	getGlobalSettings ()
	Gets global settings class for settings.
_MISC_FUNC QWidget *	setGlobalParent (QWidget *parent)
	Sets global parent widget class for dialogs.
_MISC_FUNC QWidget *	getGlobalParent ()
	Gets global parent widget class for settings.
_MISC_FUNC QUiLoader *	setGlobalUiLoader (QUiLoader *uiLoader)
	Sets global UI loader class.
_MISC_FUNC QUiLoader *	getGlobalUiLoader ()
	Gets global UI loader instance.
_MISC_FUNC void	setPluginDir (QString pluginDir)
	Sets the global plugin directory used i.e. by sf::FormBuilderLoad() and sf::FormBuilderSave().
_MISC_FUNC QString	getPluginDir ()
	Gets the global plugin directory.
_MISC_FUNC QWidget *	FormBuilderLoad (QIODevice *io, QWidget *parent)
	Loads the form from the passed UI file. This function prevents mandatory linking of the Qt::Designer library.
_MISC_FUNC void	FormBuilderSave (QIODevice *io, QWidget *widget)
	Saves the widget to the passed file. This function prevents mandatory linking of the Qt::Designer library.
_MISC_FUNC std::string	toString (const QRect &rect)
	Converts the passed Qt rectangle into a std string.
_MISC_FUNC QRect	moveRectWithinRect (const QRect &outer, const QRect &inner)
	Moves the inner in to the outer rectangle.
template<typename T , typename F >
QMetaEnum	flagsMetaEnum ()
	Gets the QMetaEnum from a given in a QObject embedded Qt type.
_MISC_FUNC QMetaObject::Connection	connectByName (const QWidget *widget, const QString &sender_name, const char *signal_name, const QObject *receiver, const char *method_name, Qt::ConnectionType ct=Qt::AutoConnection)
	Connects signals by name of sender and name of signal.
_MISC_FUNC QStringList	getObjectNamePath (const QObject *object, bool use_rtti=false)
	Gets all the parent names from the object's parent in a string list.
_MISC_FUNC QLayout *	getWidgetLayout (const QWidget *widget)
	Gets the layout containing the passed widget.
_MISC_FUNC int	indexFromComboBox (const QComboBox *comboBox, const QVariant &value, int default_index=-1)
	Gets the index from the passed data value of the passed combo box widget.
_MISC_FUNC QPair< QLayout *, int >	getTopLayoutAndIndex (const QObject *object)
	Gets the top level QLayout and index of the passed object which can be a QLayout out or QWidget derived type.
_MISC_FUNC QPair< int, QFormLayout::ItemRole >	getLayoutPosition (const QFormLayout *layout, QObject *target)
	Gets the position (row, role) from the passed target object in te form-layout.
_MISC_FUNC int	getLayoutIndex (const QBoxLayout *layout, QObject *target)
	Gets the index from the passed target object in te box-layout.
void	resizeColumnsToContents (QTreeView *treeView)
	Resizes all columns to content of a tree view except the last column.
_MISC_FUNC void	dumpObjectProperties (const QObject *obj)
	Dumps all the object properties in qDebug().
template<typename T >
T *	getSourceModel (const QAbstractItemModel *am)
	Gets the model type pointer from the passed abstract model pointer.
_MISC_FUNC QModelIndex	getSourceModelIndex (const QModelIndex &index)
	Gets the source index in case a proxy model has been used.
_MISC_FUNC void	expandTreeView (QTreeView *tv, bool expand=true, const QModelIndex &index={})
	Expands or collapses a tree view's items.
_MISC_FUNC bool	isGuiApplication ()
	Checks if the running QCoreApplication is a GUI application.
_MISC_FUNC QString	trimRight (const QString &str, const QString &chars=" ")
	Trims all characters in t from the right end of s.
_MISC_FUNC QString	trimLeft (const QString &str, const QString &chars=" ")
	Trims all characters in t from the left end of s.
_MISC_FUNC QString	trim (const QString &str, const QString &chars=" ")
	Trims all characters in t from both ends of s.
_MISC_FUNC bool	isValidFilePath (const QString &path)
	Gets if the passed filepath is a valid name.
_MISC_FUNC bool	isValidDirectoryPath (const QString &path)
	Gets if the passed directory path is a valid name.
_MISC_FUNC void	storeWindowState (QSettings &settings, QAnyStringView name, QWidget *widget, bool read)
	Stores or restores the window position and size from the settings file onto the passed widget.
_MISC_FUNC void	storeTreeViewState (QSettings &settings, QAnyStringView name, const QTreeView *tv, bool read)
	Stores or restores column widths of a QTreeView.
_PAL_FUNC void	shiftHsv (const QColor &colorBegin, const QColor &colorEnd, ColorTable::iterator fromEntry, ColorTable::iterator toEntry, const ColorShiftCurve &curve={})
_PAL_FUNC void	shiftHsl (const QColor &colorBegin, const QColor &colorEnd, ColorTable::iterator fromEntry, ColorTable::iterator toEntry, const ColorShiftCurve &curve={})
_PAL_FUNC void	shiftSaturation (const QColor &color, ColorTable::iterator fromEntry, ColorTable::iterator toEntry, const ColorShiftCurve &curve={})
_PAL_FUNC void	shiftRgb (const QColor &colorBegin, const QColor &colorEnd, ColorTable::iterator fromEntry, ColorTable::iterator toEntry, const ColorShiftCurve &curve={})
_SCN_FUNC QString	toString (const QMatrix4x4 &mtx)
	Converts a QMatrix4x4 type to a QString. Allows using the QMatrix4x4 type to be serialized as a property.
_SCN_FUNC void	fromString (QMatrix4x4 &mtx, const QString &str)
	Converts a QString to a QMatrix4x4 type. Allows using the QMatrix4x4 type to be serialized as a property.

Variables
class _MISC_CLASS	PropertySheetDialog
_MISC_DATA bool	RangeCompareExact
template<typename T >
constexpr bool	is_iterable_v = is_iterable<T>::value
constexpr const char *	US_METHOD_PEAK = "Peak"
	Names used for method identification.
constexpr const char *	US_METHOD_COPY = "Copy"
	Method for generating sample copy results in array's of Amplitude values.

Typedef Documentation

ColorShiftCurve

typedef TClosure<qreal, qreal> sf::ColorShiftCurve

ColorTable

typedef QList<QRgb> sf::ColorTable

ConfigLocationClosure

typedef TClosure<std::string, const std::string&> sf::ConfigLocationClosure

Type of the callback function.

DynamicBuffer

typedef TDynamicBuffer<Allocator> sf::DynamicBuffer

Actual specialized dynamic buffer type using the default allocator.

group_type

typedef struct group sf::group_type

Intermediate type to be able to create group_t struct/class.

IniEnvelope

typedef TEnvelope<IniProfile> sf::IniEnvelope

KeyValues

typedef IniProfile::KeyValueMap sf::KeyValues

passwd_type

typedef struct passwd sf::passwd_type

Intermediate type to be able to create passwd_t struct/class.

ReportOptions

typedef QFlags<EReportOption> sf::ReportOptions

Reporting option flags.

stat_t

typedef struct stat sf::stat_t

Easier typename for 'struct stat'.

StringList

typedef TStringList<std::string> sf::StringList

strings

typedef TStrings<std::string> sf::strings

Vector of std::strings with additional functionality.

TAddProjectPropertyPage

typedef bool(* sf::TAddProjectPropertyPage) (PropertySheetDialog *sheet, const QString &ref_name)

Type for registering tool and element editor property pages.

Parameters

sheet	Owner of the property page.
ref_name	Name of the tool or element.

Returns

True on succes.

TGenerateReportEvent

typedef bool(* sf::TGenerateReportEvent) (ProjectData *data, QStringList *templates)

Type for registering the report generation event handler.

Parameters

data	Project data needed to be reporting.
templates	Names of the templates available.

Returns

TranslateOptions

typedef TSet<ETranslateOption> sf::TranslateOptions

Bitmap set of translation options.

UnitConversionServerClosure

typedef TClosure<bool, UnitConversionEvent&> sf::UnitConversionServerClosure

Type of the server callback function.

Returns

True on successful conversion.

wstrings

typedef TStrings<std::wstring> sf::wstrings

Vector of std::wstrings with additional functionality.

Enumeration Type Documentation

ECalibrationType

enum sf::ECalibrationType : int

Type to identify a scan area type.

Enumerator
ctCAL_NONE	Normal no calibration selected.
ctCAL_PRE	Pre calibration.
ctCAL_POST	Post calibration.
ctCAL_LASTENTRY	Used as size and as last value to iterate towards.

ECalibrationValueState

enum sf::ECalibrationValueState

State of the calibration value.

Enumerator
cvsEMPTY	Has no value assigned by initialization or calibration. Has been initialized but not calibrated.
cvsINITIALIZED	Has been calibrated.
cvsASSIGNED

EContourItemPoint

enum sf::EContourItemPoint

Enumerator
cipNONE
cipCENTER
cipSTART
cipSTOP
cipMID
cipLAST_ENTRY

EContourItemType

enum sf::EContourItemType

Enumerator
citNONE	Must be ignored.
citARC	Contains arc radius data.
citPOINT	Contains two point data for a line.

EDebugOutputType

enum sf::EDebugOutputType : int

Debug output type flags which can be combined to create a set of flags.

Enumerator
dotThrow	Throw an exception.
dotMessageBox	Notify through a message box.
dotStdLog	Notify through the std::clog output stream.
dotStdOut	Notify through the std::cout output stream.
dotStdErr	Notify through the std::cerr output stream.
dotDebugString	Notify through function OutputDebugString.
dotDebugBreak	Call debug break function.
dotDefault	Use default set notify output type.

EInspectionState

enum sf::EInspectionState : int

States for results of an inspection.

Enumerator
isUNKNOWN	Inspection has not been done yet.
isACCEPTED	Inspection result was accepted.
isREJECTED	Inspection result was rejected.
isLASTENTRY	t used. Entry for used to iterate.

EMaterialType

enum sf::EMaterialType : int

Enumerate type to identify a material.

Enumerator
mtMAT_ALL	For selecting all materials.
mtMAT_LIQUID	Material is liquid.
mtMAT_SOLID	Material is solid.
mtMAT_GAS	Material is gas.

EReportOption

enum sf::EReportOption : int

Final reporting options.

Enumerator
roFILE	Create a document file.
roVIEW	View document the file.
roPRINT	Print out the result.
roSHORTCUT	Creates a shortcut.
roSEND	Send the document by e-mail (includes rsFILE).

ESystemPosition

enum sf::ESystemPosition : int

Fixed system dependent axis positions.

Enumerator
spSYSPOS_NONE	To indicate no position.
spSYSPOS_PARK	Position to park at when an inspection completes.
spSYSPOS_LOAD	Position for loading parts in to the system also used when switching off the system (out of the water).
spSYSPOS_TOOL	Position to go to when a tool must be changed or modified.
spSYSPOS_LASTENTRY	Used to program an iteration.

ETranslateOption

enum sf::ETranslateOption : int

Translation options for the sf::TranslateToNipscanCoords() function/.

Enumerator
toSECSOLUTION
toTOGGLESECSOL
toNOSURFACECALC

OrbitMode

enum sf::OrbitMode

Modes for changing an OpenGL property of a scene. Use a full namespace type path when specifying a Q_PROPERTY(...)

Enumerator
omCamera	Camera or view rotation and position.
omModel	Model or rotation and position.
omLightDirection	Light direction only and position.
omLightPosition	Light or rotation and position.

SceneOption

enum sf::SceneOption : int

Scene options for rendering. Use a full namespace type path when specifying a Q_PROPERTY(...)

Enumerator
soWireModel	Draws wire models instead of solids.
soShowNormals
soPaint
soSwitch1
soSwitch2

Function Documentation

asString()

template<typename T >

std::string sf::asString	(	const T &	list,
		const std::string &	separator = {}
	)

Converts an iterable list into a string with the given separator.

Template Parameters

T	Type of the list.

Parameters

list	Iterable list.
separator	Separator.

Returns

Resulting string.

bitToString()

_MISC_FUNC std::string sf::bitToString	(	unsigned long	wrd,
		size_t	count
	)

Converts an integer value to bit string '0' and '1' characters where the first character is the first bit.

CalcTangent()

bool _KTM_FUNC sf::CalcTangent	(	int	select,
		const Vector2D &	c1,
		double	radius1,
		Vector2D &	tg1,
		const Vector2D &	c2,
		double	radius2,
		Vector2D &	tg2
	)

calculateOffset()

template<typename T , typename S >

S sf::calculateOffset	(	T	value,
		T	min,
		T	max,
		S	len,
		bool	clip
	)

Calculates the offset for a given range and set point.

calculator() [1/3]

_MISC_FUNC Value sf::calculator	(	const std::string &	script,
		const Value &	def
	)

Calculator function that converts a formula of the passed string to a #sf::Value.

Parameters

script	Script text to calculate.
def	Default value.

Returns

Result or default value depending on success or not.

calculator() [2/3]

_MISC_FUNC Value::flt_type sf::calculator	(	const std::string &	script,
		Value::flt_type	def
	)

Calculator function that converts a formula of the passed string to a floating point value.

Parameters

script	Script text to calculate.
def	Default value.

Returns

Result or default value depending on success or not.

calculator() [3/3]

_MISC_FUNC Value::flt_type sf::calculator	(	const std::string &	script,
		Value::flt_type	def,
		Value::flt_type	x,
		Value::flt_type	y = 0.0,
		Value::flt_type	z = 0.0
	)

Same as calculator() only the passed variable 'x', 'y', 'z' are available as a constant in the script.

Todo:

This function should be replaced by passing a vector of pairs instead.

Parameters

script	Script text to calculate.
def	Default value.
x	constant value.
y	constant value.
z	constant value.

Returns

Result or default value depending on success or not.

clip()

template<typename T >

T sf::clip	(	const T	value,
		const T	lower_limit,
		const T	upper_limit
	)

Template function clipping the given value between an upper_limit and lower_limit.

Template Parameters

T	Type of the value clipped.

Parameters

value	The value for being clipped.
lower_limit	Lower limit value.
upper_limit	Upper limit value.

Returns

The clipped value.

compatCommaSepString()

_IPJ_FUNC std::string sf::compatCommaSepString

(

const std::string &

str

)

Gets a '(' and ')' wrapped string when the given string is not.

connectByName()

_MISC_FUNC QMetaObject::Connection sf::connectByName	(	const QWidget *	widget,
		const QString &	sender_name,
		const char *	signal_name,
		const QObject *	receiver,
		const char *	method_name,
		Qt::ConnectionType	ct = Qt::AutoConnection
	)

Connects signals by name of sender and name of signal.

Parameters

widget	Widget having the child with the passed sender_name
sender_name	Name of sender widget.
signal_name	Name of signal.
receiver	Receiver object
method_name	Name of receiver method.
ct	Connection Type.

Returns

Connection object.

copy_data()

template<typename T >

void sf::copy_data ( T &  dest, const T &  src  )

noexcept

Does a binary copy from source to destination data.

Template Parameters

T	Structure or data type or array.

Parameters

dest	Reference to the destination data.
src	Reference to the source data.

DateTimeToInspectStr()

_IPJ_FUNC QString sf::DateTimeToInspectStr

(

const QDateTime &

dt

)

Converts a TDateTime to an inspection date time string.

debugBreak()

_MISC_FUNC void sf::debugBreak

(

)

Causes a break when debugging.

decimal_separator_fix()

_MISC_FUNC char * sf::decimal_separator_fix	(	char *	buffer,
		size_t	len
	)

Replaces a decimal comma for a point. This instead of changing the global locale. Used by template functions.

Parameters

buffer
len

Returns

The passed buffer pointer.

DEFAULT_SCANBINDERNAME()

constexpr std::string_view sf::DEFAULT_SCANBINDERNAME ( "<default>"  )

constexpr

delete_anull()

template<typename T >

void sf::delete_anull ( T &  p )

inline

Deletes an array previous allocated by 'new[]' when the pointer is non-null and also nulls the passed pointer.

delete_null()

template<typename T >

void sf::delete_null ( T &  p )

inline

Deletes object and clears pointer.

Defines and templates for deleting allocated memory and testing for zero and clearing the pointer at the same time.

demangle()

_MISC_FUNC std::string sf::demangle

(

const char *

name

)

Returns the unmangled function name returned by type ID.

demangleTypeName()

_MISC_FUNC std::string sf::demangleTypeName

(

const char *

name

)

Demangle the passed rtti mangled type name.

Parameters

name	Mangled name

Returns

Demangled name.

destroyProjectModule()

_IPJ_FUNC void sf::destroyProjectModule

(

)

Deletes the project module if it was created.

digits()

_MISC_FUNC int sf::digits

(

double

value

)

Returns the amount of digits which are significant for the value. When the value is 12300.00 the value returned is -2. When the value is 0.0123 the value returned is 4.

Parameters

value

Double value.

Returns

Amount of significant digits for the passed number.

dumpObjectProperties()

_MISC_FUNC void sf::dumpObjectProperties

(

const QObject *

obj

)

Dumps all the object properties in qDebug().

ecvt_r()

template<typename T >

int sf::ecvt_r	(	T	value,
		int	ndigit,
		int *	decpt,
		int *	sign,
		char *	buf,
		size_t	len
	)

Converts number to a null-terminated string of 'ndigits' digits. where 'ndigits' is reduced to a system-specific limit determined by the precision of a double. The high-order digit is nonzero, unless number is zero. The low order digit is rounded. The string itself does not contain a decimal point; however, the position of the decimal point relative to the start of the string is stored in *decpt. A negative value for *decpt means that the decimal point is to the left of the start of the string. If the sign of number is negative, *sign is set to a nonzero value, otherwise it is set to 0. If number is zero, it is unspecified whether *decpt is 0 or 1.

Template Parameters

T	Floating point type.

Parameters

value	Floating point value to convert.
ndigit	Amount of digits.
decpt	Decimal point.
sign	Non-zero when the value is negative.
buf	Receiving character buffer pointer.
len	Receiving buffer size.

Returns

0 on success, and -1 otherwise.

Note

Copied from glibc and modified for C++.

error_string()

_MISC_FUNC std::string sf::error_string

(

int

error_num

)

Thread safe version strerror_r() or strerror_s() when cross compiling for Windows.

escape()

_MISC_FUNC std::string sf::escape	(	const std::string &	str,
		char	delimiter = '\0'
	)

Escapes all control and non ascii characters.

See also

unescape()

Parameters

str	String to be escaped.
delimiter	Character delimiting the escaped string.

Returns

Escaped string

expandTreeView()

_MISC_FUNC void sf::expandTreeView	(	QTreeView *	tv,
		bool	expand = true,
		const QModelIndex &	index = {}
	)

Expands or collapses a tree view's items.

Parameters

tv	TreeView
expand	True to expand false to collapse.
index	Optional child index. Defaults to the root item.

EXT_AREASCAN()

constexpr std::string_view sf::EXT_AREASCAN ( ".ascn"  )

constexpr

EXT_AREASTATE()

constexpr std::string_view sf::EXT_AREASTATE ( ".ascns"  )

constexpr

EXT_CALIB()

constexpr std::string_view sf::EXT_CALIB ( ".calib"  )

constexpr

EXT_ELEMENT()

constexpr std::string_view sf::EXT_ELEMENT ( ".elem"  )

constexpr

EXT_FILTERS()

constexpr std::string_view sf::EXT_FILTERS ( ".fltr"  )

constexpr

EXT_INSPECTION()

constexpr std::string_view sf::EXT_INSPECTION ( ".insp"  )

constexpr

EXT_MATERIAL()

constexpr std::string_view sf::EXT_MATERIAL ( ".mater"  )

constexpr

EXT_PROJECT()

constexpr std::string_view sf::EXT_PROJECT ( ".iprj"  )

constexpr

EXT_SETTINGS()

constexpr std::string_view sf::EXT_SETTINGS ( ".gisf"  )

constexpr

EXT_TOOL()

constexpr std::string_view sf::EXT_TOOL ( ".tool"  )

constexpr

fcvt_r()

template<typename T >

int sf::fcvt_r	(	T	value,
		int	ndigit,
		int *	decpt,
		int *	sign,
		char *	buf,
		size_t	len
	)

Function identical to ecvt(), except that 'ndigits' specifies the number of digits after the decimal point.

Template Parameters

T	Floating point type.

Parameters

value	Floating point value to convert.
ndigit	Amount of digits.
decpt	Decimal point.
sign	Non-zero when the value is negative.
buf	Receiving character buffer pointer.
len	Receiving buffer size.

Returns

0 on success, and -1 otherwise.

Note

Copied from glibc and modified for C++.

file_fd_path()

_MISC_FUNC std::filesystem::path sf::file_fd_path

(

int

fd

)

Returns the filepath of the passed file descriptor.

Parameters

fd	Open file descriptor.

Returns

path

FILE_INSPECTION()

constexpr std::string_view sf::FILE_INSPECTION ( "Inspection"  )

constexpr

file_mkdir() [1/2]

_MISC_FUNC bool sf::file_mkdir	(	const char *	path,
		__mode_t	mode = 0755
	)

Makes all directories recursively in the path.

Parameters

path	Directory path to make.
mode	Mode of each created directory.

Returns

True on success.

file_mkdir() [2/2]

bool sf::file_mkdir ( const std::string &  path, __mode_t  mode = 0755  )

inline

Makes all directories recursively in the path.

Parameters

path	Directory path to make.
mode	Mode of each created directory.

Returns

True on success.

FILE_PARTSTATE()

constexpr std::string_view sf::FILE_PARTSTATE ( "PartState"  )

constexpr

FILE_PICTURE()

constexpr std::string_view sf::FILE_PICTURE ( "picture.jpg"  )

constexpr

file_stat()

_MISC_FUNC bool sf::file_stat	(	const std::string &	path,
		stat_t &	_stat
	)

Same as stat() but using a std::string.

file_write() [1/3]

_MISC_FUNC bool sf::file_write	(	const char *	path,
		const void *	buf,
		size_t	sz,
		bool	append = false
	)

Writes a buffer to a filepath.

Parameters

path	Filepath.
buf	Pointer to the character buffer.
sz	Size of the buffer.
append	When true it appends the buffer to the file.

Returns

file_write() [2/3]

bool sf::file_write ( const std::string &  path, const std::string &  s, bool  append = false  )

inline

Writes a std::string to file.

Parameters

path	File path.
s	String to be written to the file.
append	When true it appends the buffer to the file.

Returns

True on success.

file_write() [3/3]

bool sf::file_write ( const std::string &  path, const void *  buf, size_t  sz, bool  append = false  )

inline

Writes a character buffer to file.

Parameters

path	Filepath.
buf	Pointer to the character buffer.
sz	Size of the buffer.
append	When true it appends the buffer to the file.

Returns

True on success.

fileBaseName()

_MISC_FUNC std::string sf::fileBaseName

(

const std::string &

path

)

Same as basename() but using a std::string.

fileDirName()

_MISC_FUNC std::string sf::fileDirName

(

const std::string &

path

)

Same as dirname() but using a std::string.

fileExists() [1/2]

_MISC_FUNC bool sf::fileExists

(

const char *

path

)

Checks if the passed path exist (by doing an access() using F_OK).

fileExists() [2/2]

bool sf::fileExists ( const std::string &  path )

inline

Checks if the passed path exist (by doing an access() using F_OK).

fileRename()

_MISC_FUNC bool sf::fileRename	(	const std::string &	old_path,
		const std::string &	new_path
	)

Same as rename() but using a std::string.

fileUnlink()

_MISC_FUNC bool sf::fileUnlink

(

const std::string &

path

)

Same as unlink() but using a std::string.

filter()

_MISC_FUNC std::string sf::filter	(	std::string	str,
		const std::string &	filter
	)

Filters all characters from the passed string and returns the resulting string.

findFiles()

_MISC_FUNC bool sf::findFiles	(	strings &	files,
		const std::string &	wildcard
	)

Finds the files using the passed wildcard.

flagsMetaEnum()

template<typename T , typename F >

QMetaEnum sf::flagsMetaEnum

(

)

Gets the QMetaEnum from a given in a QObject embedded Qt type.

Template Parameters

T	QObject-derived type.
F	QFlags declared type.

Returns

Meta enumeration object.

// Get a enumerate value as variable.
auto sb = QDialogButtonBox::Save;
// Print the value as text in the output.
qDebug() << flagsMetaEnum<QDialogButtonBox, QDialogButtonBox::StandardButtons>().valueToKey(sb);

FormBuilderLoad()

_MISC_FUNC QWidget * sf::FormBuilderLoad	(	QIODevice *	io,
		QWidget *	parent
	)

Loads the form from the passed UI file. This function prevents mandatory linking of the Qt::Designer library.

FormBuilderSave()

_MISC_FUNC void sf::FormBuilderSave	(	QIODevice *	io,
		QWidget *	widget
	)

Saves the widget to the passed file. This function prevents mandatory linking of the Qt::Designer library.

free_null()

template<typename T >

void sf::free_null ( T &  p )

inline

Template function freeing a pointer previous allocated by 'malloc' when the pointer is non-null and also nulls the passed pointer.

freeConsole()

_MISC_FUNC void sf::freeConsole

(

bool

always = false

)

Closes the console window.

Parameters

always

When true the console is closed even when debugging argument '–debug' on command line.

fromString() [1/2]

_SCN_FUNC void sf::fromString	(	QMatrix4x4 &	mtx,
		const QString &	str
	)

Converts a QString to a QMatrix4x4 type. Allows using the QMatrix4x4 type to be serialized as a property.

fromString() [2/2]

template<typename T >

void sf::fromString	(	T &	list,
		const std::string &	str,
		const std::string &	separator = {}
	)

Converts a string into a typed list.

Template Parameters

T	Type of the iterable list.

Parameters

list	Iterable list.
str	String containing the separated values.
separator	Separator character.

gcvt()

template<typename T >

char * sf::gcvt	(	T	value,
		int	ndigits,
		char *	buf,
		size_t	len
	)

Converts a floating-point number to a string always using a decimal point. It produces 'digits' significant digits in either printf(3) F format or E (scientific) format. Always returns a decimal point without setting the global locale.

Template Parameters

T	Floating point type.

Parameters

value	Floating point value to convert.
ndigits	Amount of digits.
buf	Buffer pointer.
len	Length of the buffer.

Returns

Pointer to passed buffer.

gcvtString()

template<typename T >

std::string sf::gcvtString	(	T	value,
		int	ndigits = 0
	)

Converts a floating-point number to a string always using a decimal point.

See also

sf::gcvt()

Template Parameters

T	Floating point type.

Parameters

value	Floating point value to convert.
ndigits	Amount of digits default to 0 which is means the minimum amount to represent the value.

Returns

String containing converted value.

getBacktrace()

_MISC_FUNC std::string sf::getBacktrace

(

)

Prints the backtrace to a stream.

getBeamVector()

Vector3D _KTM_FUNC sf::getBeamVector	(	const ToolInformation &	tool,
		double	beam_len,
		double	a,
		double	b
	)

Not clear where it is used for.???

Parameters

tool	Descriptive structure of the tool vector and beam angle.
beam_len	Length of the beam when it leaves the tool.
a	A-axis angle.
b	B-axis angle.

Returns

3D vector.

GetCalibrationType()

_IPJ_FUNC ECalibrationType sf::GetCalibrationType

(

const QString &

cal_type

)

Returns the passed calibration type name as enumerate value.

GetCalibrationTypeName()

_IPJ_FUNC QString sf::GetCalibrationTypeName

(

ECalibrationType

)

Returns the passed calibration type as a name.

getConfigLocation()

_MISC_FUNC std::string sf::getConfigLocation	(	const std::string &	option = {},
		bool	separator = false
	)

Gets the configuration location/directory of the application.

When no handler is installed the working directory is returned.

Parameters

option	Optional option to pass to manipulate the result.
separator	Terminates the string with a directory separator.

Returns

Directory

getCppStandard()

std::string_view sf::getCppStandard

(

)

Gets the C++ standard used.

getCpuArchitecture()

_MISC_FUNC std::string_view sf::getCpuArchitecture

(

)

Gets the CPU architecture returned from 'uname -m' command.

GetDefaultDebugOutput()

_MISC_FUNC unsigned int sf::GetDefaultDebugOutput

(

)

Returns the combination of EDebugOutputType which is the default output.

getDirectorySeparator()

_MISC_FUNC std::string::value_type sf::getDirectorySeparator

(

)

Returns OS dependent directory separation character.

getDynamicLibraryExtension()

_MISC_FUNC std::string sf::getDynamicLibraryExtension

(

)

Returns OS dependent dynamic library extension.

getExecutableDirectory()

_MISC_FUNC std::string sf::getExecutableDirectory

(

)

Returns the executable directory.

getExecutableFilepath()

_MISC_FUNC std::string sf::getExecutableFilepath

(

)

Returns the executable filepath.

getExecutableName()

_MISC_FUNC std::string sf::getExecutableName

(

)

Returns the executable name.

getFiles()

_MISC_FUNC bool sf::getFiles	(	strings &	files,
		const std::string &	directory,
		const std::string &	wildcard
	)

Returns all the files from the passed directory using a wildcard.

GetFilteredString()

QString sf::GetFilteredString	(	const QString &	str,
		const QString &	filter
	)

Filters a string removing all characters from the given filter string.

Parameters

str	String to filter.
filter	String containing to filter out characters.

Returns

The filtered string.

getGCCVersion()

std::string sf::getGCCVersion

(

)

Gets the GNU compiler version.

getGlobalParent()

_MISC_FUNC QWidget * sf::getGlobalParent

(

)

Gets global parent widget class for settings.

Returns

Current global instance when set otherwise nullptr is returned.

getGlobalSettings()

_MISC_FUNC QSettings * sf::getGlobalSettings

(

)

Gets global settings class for settings.

Returns

Current global instance when set otherwise nullptr is returned.

getGlobalUiLoader()

_MISC_FUNC QUiLoader * sf::getGlobalUiLoader

(

)

Gets global UI loader instance.

Returns

Current global instance when set otherwise nullptr is returned.

GetInspectionState()

_IPJ_FUNC EInspectionState sf::GetInspectionState

(

const QString &

state_name

)

Gets the passed inspection state name as enumerate value.

GetInspectionStateName()

_IPJ_FUNC QString sf::GetInspectionStateName

(

EInspectionState

)

Gets the passed inspection state as a name.

GetIntersection() [1/2]

bool _KTM_FUNC sf::GetIntersection	(	const Vector2D &	center,
		double	radius,
		const Vector2D &	p,
		double	angle,
		Vector2D &	ip1,
		Vector2D &	ip2
	)

GetIntersection() [2/2]

bool _KTM_FUNC sf::GetIntersection	(	const Vector2D &	p11,
		const Vector2D &	p12,
		const Vector2D &	p2,
		double	angle2,
		Vector2D &	ip
	)

getLayoutIndex()

_MISC_FUNC int sf::getLayoutIndex	(	const QBoxLayout *	layout,
		QObject *	target
	)

Gets the index from the passed target object in te box-layout.

Parameters

layout	Box-layout.
target	QLayout(Item or QWidget type of object.

Returns

Index position.

getLayoutPosition()

_MISC_FUNC QPair< int, QFormLayout::ItemRole > sf::getLayoutPosition	(	const QFormLayout *	layout,
		QObject *	target
	)

Gets the position (row, role) from the passed target object in te form-layout.

Parameters

layout	Form layout.
target	QLayout or QWidget type of object.

Returns

Pair of values (row, role),. On failure row = -1.

getLibraryName()

std::string sf::getLibraryName ( )

inline

function to get the library filename this function is called from.

getLine()

_MISC_FUNC std::string sf::getLine

(

std::istream &

is

)

Return a line from the input stream.

GetLineValues() [1/2]

bool _KTM_FUNC sf::GetLineValues	(	const Vector2D &	p,
		double	angle,
		double &	slope,
		double &	yofs
	)

GetLineValues() [2/2]

bool _KTM_FUNC sf::GetLineValues	(	const Vector2D &	p1,
		const Vector2D &	p2,
		double &	slope,
		double &	yofs
	)

getMantissaExponent()

template<typename T >

std::pair< T, int > sf::getMantissaExponent

(

T

value

)

Gets the mantissa and exponent part of a floating point value.

Template Parameters

T

Parameters

value

Returns

GetMaterialType()

EMaterialType _IPJ_FUNC sf::GetMaterialType

(

const QString &

mat_type

)

Gets the passed calibration type name as enumerate value.

GetMaterialTypeName()

QString _IPJ_FUNC sf::GetMaterialTypeName

(

EMaterialType

)

Gets the passed material type as a name.

Returns

getObjectNamePath()

_MISC_FUNC QStringList sf::getObjectNamePath	(	const QObject *	object,
		bool	use_rtti = false
	)

Gets all the parent names from the object's parent in a string list.

Parameters

object	Top object.
use_rtti	Use RTTI classname when the object anem is empty prefixed with an '@'.

Returns

List of object names.

getOSVersion()

_MISC_FUNC std::string sf::getOSVersion

(

)

Gets the OS and version used.

getPluginDir()

_MISC_FUNC QString sf::getPluginDir

(

)

Gets the global plugin directory.

getProjectModule()

_IPJ_FUNC ProjectModule * sf::getProjectModule

(

)

Creates the project module when called for.

GetProjectNameFilter()

_IPJ_FUNC const char * sf::GetProjectNameFilter

(

)

Returns characters that are not allowed to appear in the names.

GetReportOptionDescription()

_IPJ_FUNC QString sf::GetReportOptionDescription

(

EReportOption

ro

)

Gets the option description of the passed style.

GetReportOptionDescriptions()

_IPJ_FUNC void sf::GetReportOptionDescriptions

(

QStringList &

strings

)

Gets the description in a string list of the passed options.

getSourceModel()

template<typename T >

T * sf::getSourceModel

(

const QAbstractItemModel *

am

)

Gets the model type pointer from the passed abstract model pointer.

Template Parameters

T	Model type derived from QAbstractItemModel

Parameters

am	Pointer to model.

Returns

Non-null when found.

getSourceModelIndex()

_MISC_FUNC QModelIndex sf::getSourceModelIndex

(

const QModelIndex &

index

)

Gets the source index in case a proxy model has been used.

GetSurfaceMatrix() [1/2]

bool _KTM_FUNC sf::GetSurfaceMatrix	(	const Vector2D &	surf_point,
		double	surf_angle,
		double	rot_angle,
		Matrix44 &	surface
	)

Gets the matrix of the surface of the contour info of a rotation symmetrical object.

Parameters

surf_point
surf_angle
rot_angle
surface

Returns

GetSurfaceMatrix() [2/2]

bool _KTM_FUNC sf::GetSurfaceMatrix	(	const Vector2D &	surf_point,
		double	surf_angle,
		double	rotangle,
		double	anglexz,
		double	angleyz,
		double	anglexy,
		Matrix44 &	surface
	)

Gets the matrix of the surface of the contour info of a rotation symmetrical object.

Parameters

surf_point
surf_angle
rotangle
anglexz
angleyz
anglexy
surface

Returns

getSustainTimer()

_MISC_FUNC int sf::getSustainTimer

(

)

Gets the current sustain timer interval in milliseconds.

Returns

Interval in milliseconds.

getSystemName()

_MISC_FUNC std::string sf::getSystemName

(

)

Gets the name of the system.

GetSystemPositionFromName()

_IPJ_FUNC ESystemPosition sf::GetSystemPositionFromName

(

const QString &

sp

)

Gets the system position from the name.

GetSystemPositionInfo()

_IPJ_FUNC QString sf::GetSystemPositionInfo

(

ESystemPosition

sp

)

Gets the current scan inspection state converted from the passed name.

GetSystemPositionName()

_IPJ_FUNC QString sf::GetSystemPositionName

(

ESystemPosition

sp

)

Gets the passed system position name.

getTemporaryDirectory()

_MISC_FUNC std::string sf::getTemporaryDirectory

(

)

Returns the temporary directory.

getThreadCount()

_MISC_FUNC int sf::getThreadCount

(

)

Gets the thread count from the current process.

Returns

On failure -1 else the actual thread count.

gettid()

_MISC_FUNC pid_t sf::gettid ( )

noexcept

Add missing gettid() system call.

getTime()

_MISC_FUNC timespec sf::getTime

(

bool

real_time = false

)

Gets the timespec as function return value as clock_gettime() for the current time.

Parameters

real_time

When true the real time is returned. When false the time is used for timers and un effected by system time changes.

getTimeRunning()

_MISC_FUNC timespec sf::getTimeRunning

(

)

Gets the time this application is running.

Is used in combination with getTime(false) to get the time since the start of the application.

getToolBeamVector()

Vector3D _KTM_FUNC sf::getToolBeamVector	(	const ToolInformation &	tool,
		double	beam_len,
		double	a,
		double	b
	)

Gets the vector which can be added to the xyz-axis position vector to get the focus position.

Parameters

tool	Descriptive structure of the tool vector and beam angle.
beam_len	Length of the beam when it leaves the tool.
a	A-axis angle.
b	B-axis angle.

Returns

3D vector.

getTopLayoutAndIndex()

_MISC_FUNC QPair< QLayout *, int > sf::getTopLayoutAndIndex

(

const QObject *

object

)

Gets the top level QLayout and index of the passed object which can be a QLayout out or QWidget derived type.

getTypeName()

template<typename T >

std::string sf::getTypeName

(

const T

ptr

)

Get the demangled type name of the passed pointer type.

Template Parameters

T	Type needed to be converted.

Parameters

ptr	Typed pointer to ge the type name from.

Returns

Demangled string.

getUnitConversion()

_GII_FUNC bool sf::getUnitConversion	(	const std::string &	option,
		const std::string &	from_unit,
		int	from_precision,
		double &	multiplier,
		double &	offset,
		std::string &	to_unit,
		int &	to_precision
	)

Returns true if a conversion could be made.
Calculation to convert are:
From -> To calculation:
new_value = (value * multiplier) + offset;
To -> From calculation:
new_value = (value - offset) / multiplier;

Parameters

option	Special conversion option code.
from_unit	current unit string.
from_precision	Decimals of current unit. (can be negative)
multiplier	Multiplication factor.
offset	offset value.
to_unit	New unit string.
to_precision	New precision after conversion.

Returns

True on success.

getUserLogin()

_MISC_FUNC std::string sf::getUserLogin

(

)

Gets the name of the current user of the system.

getWidgetLayout()

_MISC_FUNC QLayout * sf::getWidgetLayout

(

const QWidget *

widget

)

Gets the layout containing the passed widget.

Parameters

widget

.

Returns

On not found nullptr.

getWorkingDirectory()

_MISC_FUNC std::string sf::getWorkingDirectory

(

)

Returns the working directory.

hexCharValue()

_MISC_FUNC char sf::hexCharValue

(

char

ch

)

Returns numeric the value of the passed hexadecimal character.

hexString()

_MISC_FUNC std::string sf::hexString	(	const void *	buffer,
		size_t	sz
	)

Converts a block of data to a hexadecimal string.

HLPCTX_SETUPFAIL()

constexpr std::string_view sf::HLPCTX_SETUPFAIL ( "fail_setup_change"  )

constexpr

indexFromComboBox()

_MISC_FUNC int sf::indexFromComboBox	(	const QComboBox *	comboBox,
		const QVariant &	value,
		int	default_index = -1
	)

Gets the index from the passed data value of the passed combo box widget.

Parameters

comboBox	Combo box to query on for the given value..
value	Value to look the index up from.
default_index	DEfault index when the value was not found.

Returns

The found index or default given one.

INSPECT_DATETIME_DELIM()

constexpr std::string_view sf::INSPECT_DATETIME_DELIM ( )

constexpr

INSPECT_SERIAL_DELIM()

constexpr std::string_view sf::INSPECT_SERIAL_DELIM ( "  , "    )

constexpr

InspectStrToDateTime()

_IPJ_FUNC QDateTime sf::InspectStrToDateTime

(

const QString &

str

)

Converts an inspection date time string into a QDateTime value.

ipow()

template<typename T >

T sf::ipow	(	T	base,
		int	exponent
	)

Fast integer power-of function.

Template Parameters

T	Integer type.

Parameters

base
exponent

Returns

isDebug()

_MISC_FUNC bool sf::isDebug

(

)

Gets the debug status.

Returns

True if debugging is passed at the command line.

isDebuggerActive()

_MISC_FUNC bool sf::isDebuggerActive

(

)

Gets the debugger active status.

Returns

True if a debugger is attached at startup.

isEqual()

template<typename T >

bool sf::isEqual	(	T	a,
		T	b,
		T	epsilon = std::numeric_limits<T>::epsilon()
	)

Compares 2 floating point values of the same type with a given epsilon.

Template Parameters

T	Base floating point type.

Parameters

a	Floating point value 1.
b	Floating point value 2.
epsilon

Returns

True when near equal.

isGuiApplication()

_MISC_FUNC bool sf::isGuiApplication

(

)

Checks if the running QCoreApplication is a GUI application.

Returns

True when a GUI application.

isInRange()

template<typename V , typename T >

bool sf::isInRange	(	const V	value,
		const T	from,
		const T	to
	)

Checks if the passed value is in the given range.

Template Parameters

V	Arithmetic type only.
T	Arithmetic type only.

Parameters

value	Value to check.
from	Start of the range.
to	End of the range.

Returns

True when value is in between from and to.

isValidDirectoryPath()

_MISC_FUNC bool sf::isValidDirectoryPath

(

const QString &

path

)

Gets if the passed directory path is a valid name.

isValidFilePath()

_MISC_FUNC bool sf::isValidFilePath

(

const QString &

path

)

Gets if the passed filepath is a valid name.

isValidValue()

template<typename T >

bool sf::isValidValue

(

T

value

)

Check if the passed value is not NaN or infinity.

isZero()

template<typename T >

bool sf::isZero	(	T	value,
		T	epsilon = std::numeric_limits<T>::epsilon()
	)

Check if the passed value is zero or near zero according the given epsilon.

itoa()

template<typename T >

char * sf::itoa	(	T	value,
		char *	buffer,
		int	base = 10
	)

Converts an integer type value to a buffer. The itoa function converts value to a null-terminated buffer and stores the result in buffer. With itoa, value is an integer. Note: The space allocated for buffer must be large enough to hold the returned buffer, including the terminating null character (\0). itoa can return up to (sizeof(T) * CHAR_BIT + 1) bytes.

Template Parameters

T	Integer type.

Parameters

value	Integer value.
buffer	Receiving buffer pointer.
base	Base of number system or radix defaulting to 10.

Returns

Null terminated pointer buffer. (Not the same as the buffer pointer.)

itostr()

template<typename T >

std::string sf::itostr	(	T	value,
		int	base = 10
	)

Converts an integer type value to a std::string.

Template Parameters

T	Integer type.

Parameters

value	Integer value.
base	Base of number system or radix defaulting to 10.

Returns

Null terminated pointer buffer. (Not the same as the buffer pointer.)

kb_hit()

_MISC_FUNC bool sf::kb_hit

(

)

Checks if a keyboard key pas pressed.

KEY_CFG_DESIG_PREFIX()

constexpr std::string_view sf::KEY_CFG_DESIG_PREFIX ( "Designation_"  )

constexpr

KEY_CFG_FILTERLISTGLOBAL()

constexpr std::string_view sf::KEY_CFG_FILTERLISTGLOBAL ( "Filter List Global"  )

constexpr

KEY_CFG_SETTINGSGLOBAL()

constexpr std::string_view sf::KEY_CFG_SETTINGSGLOBAL ( "Settings Global"  )

constexpr

KEY_CREATED()

constexpr std::string_view sf::KEY_CREATED ( "Created At"  )

constexpr

KEY_CREATOR()

constexpr std::string_view sf::KEY_CREATOR ( "Created By"  )

constexpr

KEY_IGNOREOFFSET()

constexpr std::string_view sf::KEY_IGNOREOFFSET ( "Ignore Project Offset"  )

constexpr

KEY_INSP_APPUSER()

constexpr std::string_view sf::KEY_INSP_APPUSER ( "Application User"  )

constexpr

KEY_INSP_CALTYPE()

constexpr std::string_view sf::KEY_INSP_CALTYPE ( "CalType"  )

constexpr

KEY_INSP_COMMENT()

constexpr std::string_view sf::KEY_INSP_COMMENT ( "Comment"  )

constexpr

KEY_INSP_DATAFILE()

constexpr std::string_view sf::KEY_INSP_DATAFILE ( "DataFile"  )

constexpr

KEY_INSP_DATETIME()

constexpr std::string_view sf::KEY_INSP_DATETIME ( "Date Time"  )

constexpr

KEY_INSP_FINALIZED()

constexpr std::string_view sf::KEY_INSP_FINALIZED ( "Finalized"  )

constexpr

KEY_INSP_FINALIZEDATE()

constexpr std::string_view sf::KEY_INSP_FINALIZEDATE ( "Finalize Date"  )

constexpr

KEY_INSP_FINALIZEUSER()

constexpr std::string_view sf::KEY_INSP_FINALIZEUSER ( "Finalize User"  )

constexpr

KEY_INSP_PART()

constexpr std::string_view sf::KEY_INSP_PART ( "Part"  )

constexpr

KEY_INSP_PROJECT()

constexpr std::string_view sf::KEY_INSP_PROJECT ( "Project"  )

constexpr

KEY_INSP_SCANUSER()

constexpr std::string_view sf::KEY_INSP_SCANUSER ( "User Name"  )

constexpr

KEY_INSP_SERIAL()

constexpr std::string_view sf::KEY_INSP_SERIAL ( "Serial"  )

constexpr

KEY_INSP_STATE()

constexpr std::string_view sf::KEY_INSP_STATE ( "State"  )

constexpr

KEY_INSP_SYSNAME()

constexpr std::string_view sf::KEY_INSP_SYSNAME ( "System Name"  )

constexpr

KEY_INSP_SYSUSER()

constexpr std::string_view sf::KEY_INSP_SYSUSER ( "System User"  )

constexpr

KEY_MAT_FORM()

constexpr std::string_view sf::KEY_MAT_FORM ( "Form"  )

constexpr

KEY_MAT_LONGITUDINAL()

constexpr std::string_view sf::KEY_MAT_LONGITUDINAL ( "Longitudinal"  )

constexpr

KEY_MAT_SHEAR()

constexpr std::string_view sf::KEY_MAT_SHEAR ( "Shear"  )

constexpr

KEY_MODIFIED()

constexpr std::string_view sf::KEY_MODIFIED ( "Modify Date"  )

constexpr

KEY_MODIFIER()

constexpr std::string_view sf::KEY_MODIFIER ( "Modify By"  )

constexpr

KEY_OPTIONS()

constexpr std::string_view sf::KEY_OPTIONS ( "Options"  )

constexpr

KEY_SCANAREA()

constexpr std::string_view sf::KEY_SCANAREA ( "Scan Area"  )

constexpr

KEY_SCANBINDER()

constexpr std::string_view sf::KEY_SCANBINDER ( "Scan Binder"  )

constexpr

KEY_SCANCOUNT()

constexpr std::string_view sf::KEY_SCANCOUNT ( "Scan Count"  )

constexpr

KEY_SCANMETHOD()

constexpr std::string_view sf::KEY_SCANMETHOD ( "Scan Method"  )

constexpr

KEY_TEMPLATE()

constexpr std::string_view sf::KEY_TEMPLATE ( "Template"  )

constexpr

KEY_VERSION()

constexpr std::string_view sf::KEY_VERSION ( "Version"  )

constexpr

loadDynamicLibrary()

_MISC_FUNC bool sf::loadDynamicLibrary

(

const std::string &

path

)

Loads a dynamic library from the given path.

Parameters

path	Path to the library.

Returns

True when library loading was successful.

loadVariableValues()

bool _GII_FUNC sf::loadVariableValues	(	IniProfile &	profile,
		const std::function< bool(InformationTypes::id_type, Value &)> &	func = nullptr
	)

Loads variable settings from the passed profile instance.

Which variable values are loaded is determined by its flags.

magnitude()

template<typename T >

int sf::magnitude

(

T

value

)

Gets the order of magnitude of the passed floating point value. Examples: magnitude(0.001234) => -2 magnitude(0.123400) => 0 magnitude(12340.00) => 5.

magnitudeObsolete()

_MISC_FUNC int sf::magnitudeObsolete

(

double

value

)

Gets the order of magnitude of the passed double value. Examples: magnitude(0.001234) => -2 magnitude(0.123400) => 0 magnitude(12340.00) => 5.

maxArgumentIndex()

template<typename T , typename... Args>

size_t sf::maxArgumentIndex	(	T	first,
		Args...	args
	)

Finds the index of the largest element passed as an argument.

maxArrayIndex()

template<typename T , size_t N>

size_t sf::maxArrayIndex

(

const std::array< T, N > &

arr

)

Finds the largest element index of the passed array.

Template Parameters

T	Type of elements in the array.
N	Size of the elements in the array.

Parameters

arr	Array of type std::array<T, N>

Returns

Zero based index of largest array entry.

minArgumentIndex()

template<typename T , typename... Args>

size_t sf::minArgumentIndex	(	T	first,
		Args...	args
	)

Finds the index of the smallest element passed as an argument.

minArrayIndex()

template<typename T , size_t N>

size_t sf::minArrayIndex

(

const std::array< T, N > &

arr

)

Finds the largest element index of the passed array.

Template Parameters

T	Type of elements in the array.
N	Size of the elements in the array.

Parameters

arr	Array of type std::array<T, N>

Returns

Zero based index of largest array entry.

modulo()

template<typename T >

T sf::modulo	(	T	k,
		T	n
	)

Modulo template function.

Template Parameters

T	Arithmetic scalar type of the template.

Parameters

k	Is the dividend.
n	Is the divisor.

Returns

Remainder

moveRectWithinRect()

_MISC_FUNC QRect sf::moveRectWithinRect	(	const QRect &	outer,
		const QRect &	inner
	)

Moves the inner in to the outer rectangle.

Parameters

outer	Bounding rectangle.
inner	Rectangle to be moved.

Returns

Modified rectangle.

not_ref_null()

template<typename T >

bool sf::not_ref_null ( T &  r )

inline

null_ref()

template<typename T >

T & sf::null_ref ( )

inline

Creates typed reference to a null pointer.

Template Parameters

T

Returns

numberString()

_MISC_FUNC std::string sf::numberString	(	double	value,
		int	digits,
		bool	sign_on = true
	)

String formats a floating point or integer value using scientific notation. where the exponent is always a multiple of 3.

Parameters

value	Value to be converted to a string.
digits	Resolution in significant digits to represent the value.
sign_on	When true the '+' sign is added.

Returns

String

operator*() [1/7]

template<typename T >

TMatrix44< T > sf::operator*	(	const TMatrix44< T > &	lm,
		const TMatrix44< T > &	rm
	)

Multiplies to matrices into a single one.

Template Parameters

T	Base floating point type.

Parameters

lm	Left matrix of multiplication.
rm	Right matrix of multiplication.

Returns

New matrix.

operator*() [2/7]

template<typename T >

TQuaternion< T > sf::operator*	(	const TQuaternion< T > &	lhs,
		const TQuaternion< T > &	rhs
	)

Multiplies two quaternions.

Template Parameters

T	Base floating point type.

Parameters

lhs	Left value of the multiplication.
rhs	Right value of the multiplication.

Returns

New quaternion instance.

operator*() [3/7]

template<typename T >

TVector2D< T > sf::operator*	(	const TVector2D< T > &	v,
		T	c
	)

operator*() [4/7]

template<typename T >

TVector3D< T > sf::operator*	(	const TVector3D< T > &	v,
		T	c
	)

operator*() [5/7]

template<typename T >

TQuaternion< T > sf::operator*	(	T	c,
		const TQuaternion< T > &	quat
	)

Multiplies a scalar value with a quaternion.

Template Parameters

T	Base floating point type.

Parameters

c	Scalar left value of the multiplication.
quat	Quaternion right value of the multiplication.

Returns

New quaternion instance.

operator*() [6/7]

template<typename T >

TVector2D< T > sf::operator*	(	T	c,
		const TVector2D< T > &	v
	)

operator*() [7/7]

template<typename T >

TVector3D< T > sf::operator*	(	T	c,
		const TVector3D< T > &	v
	)

operator+()

template<typename T >

TQuaternion< T > sf::operator+	(	const TQuaternion< T > &	lhs,
		const TQuaternion< T > &	rhs
	)

Adds two quaternions.

Template Parameters

T	Base floating point type.

Parameters

lhs	Left value of the addition.
rhs	Right value of the addition.

Returns

New matrix.

operator-()

template<typename T >

TQuaternion< T > sf::operator-	(	const TQuaternion< T > &	lhs,
		const TQuaternion< T > &	rhs
	)

Subtracts two quaternions.

Template Parameters

T	Base floating point type.

Parameters

lhs	Left value of the subtraction.
rhs	Right value of the subtraction.

Returns

New matrix.

operator/()

template<typename T >

TQuaternion< T > sf::operator/	(	const TQuaternion< T > &	lhs,
		const TQuaternion< T > &	rhs
	)

Divides two quaternions.

Template Parameters

T	Base floating point type.

Parameters

lhs	Left value of the division.
rhs	Right value of the division.

Returns

New quaternion instance.

operator<<() [1/16]

_GMI_FUNC std::ostream & sf::operator<<	(	std::ostream &	os,
		const gmi::AxesCoord &	ac
	)

Operator for writing the sf::gmi::AxesCoord to an output-stream.

Parameters

os	Output stream.
ac	Axes coordinate to stream.

Returns

The passed output stream.

operator<<() [2/16]

std::ostream & sf::operator<< ( std::ostream &  os, const IniProfile &  profile  )

inline

operator<<() [3/16]

std::ostream & sf::operator<< ( std::ostream &  os, const Md5Hash &  hash  )

inline

Stream operator for showing hexadecimal hash value.

operator<<() [4/16]

_MISC_FUNC std::ostream & sf::operator<<	(	std::ostream &	os,
		const Range &	r
	)

Output stream operator for a range.

operator<<() [5/16]

_MISC_FUNC std::ostream & sf::operator<<	(	std::ostream &	os,
		const Range::Vector &	rl
	)

Output stream operator for a range vector.

operator<<() [6/16]

_GII_FUNC std::ostream & sf::operator<<	(	std::ostream &	os,
		const ResultData &
	)

Stream operator for the setup std::string.

operator<<() [7/16]

template<typename T >

std::ostream & sf::operator<<	(	std::ostream &	os,
		const TMatrix22< T > &	mtx
	)

Operator for writing the sf::TMatrix22 to an output-stream.

Template Parameters

T	Base floating point type.

Parameters

os	Output stream.
mtx	Matrix to stream out.

Returns

The passed output stream.

operator<<() [8/16]

template<typename T >

std::ostream & sf::operator<<	(	std::ostream &	os,
		const TMatrix44< T > &	mtx
	)

Operator for writing the matrix to an output-stream.

Template Parameters

T	Base floating point type.

Parameters

os	Output stream.
mtx	Matrix to stream out.

Returns

The passed output stream.

operator<<() [9/16]

template<typename T >

std::ostream & sf::operator<<	(	std::ostream &	os,
		const TQuaternion< T > &	quat
	)

Operator for writing the sf::TQuaternion to an output-stream. Calls TQuaternion::toString() for the operator.

Template Parameters

T	Base floating point type.

Parameters

os	Output stream.
quat	Matrix to stream out.

Returns

The passed output stream.

operator<<() [10/16]

template<typename T >

std::ostream & sf::operator<<	(	std::ostream &	os,
		const TRectangle2D< T > &
	)

Writes the rectangle into an output stream.

operator<<() [11/16]

template<typename T >

std::ostream & sf::operator<<	(	std::ostream &	os,
		const TVector2D< T > &	v
	)

Operator for writing a vector to a stream.

operator<<() [12/16]

template<typename T >

std::ostream & sf::operator<<	(	std::ostream &	os,
		const TVector3D< T > &	v
	)

Operator for writing a vector to a stream.

operator<<() [13/16]

_MISC_FUNC std::ostream & sf::operator<<	(	std::ostream &	os,
		const Value &	v
	)

Value class output stream operator.

operator<<() [14/16]

_GII_FUNC std::ostream & sf::operator<<	(	std::ostream &	os,
		const Variable &	v
	)

Class std::ostream operator

operator<<() [15/16]

_GII_FUNC std::ostream & sf::operator<<	(	std::ostream &	os,
		const Variable::State::Vector &	v
	)

Stream operator for setting up this instance with a setup std::string.

operator<<() [16/16]

template<typename T >

std::ostream & sf::operator<<	(	std::ostream &	os,
		TDeque< T > const &	v
	)

Output stream operator.

Template Parameters

T	Type of the vector.

Parameters

os	Output stream
v	Value of the entry.

Returns

Stream

operator==() [1/2]

bool sf::operator== ( const Md5Hash &  h1, const Md5Hash &  h2  )

inline

Compare operator for storing an MD5 hash.

operator==() [2/2]

_MISC_FUNC bool sf::operator==	(	const Md5Hash::hash_type &	h1,
		const Md5Hash::hash_type &	h2
	)

Compare operator for storing an MD5 hash.

operator>>() [1/13]

_GMI_FUNC std::istream & sf::operator>>	(	std::istream &	is,
		gmi::AxesCoord &	ac
	)

Operator for reading the sf::gmi::AxesCoord from an input stream.

Parameters

is	Input stream.
ac	Axes coordinate to stream.

Returns

The passed input stream.

operator>>() [2/13]

_MISC_FUNC std::istream & sf::operator>>	(	std::istream &	is,
		Md5Hash &	h
	)

Read hash from input stream.

operator>>() [3/13]

_MISC_FUNC std::istream & sf::operator>>	(	std::istream &	is,
		Range &	r
	)

Input stream operator for a range.

operator>>() [4/13]

_MISC_FUNC std::istream & sf::operator>>	(	std::istream &	is,
		Range::Vector &	rl
	)

Input stream operator for a range vector.

operator>>() [5/13]

_GII_FUNC std::istream & sf::operator>>	(	std::istream &	is,
		ResultData &
	)

Stream operator for setting up this instance with a setup std::string.

operator>>() [6/13]

template<typename T >

std::istream & sf::operator>>	(	std::istream &	is,
		TMatrix22< T > &	mtx
	)

Operator for reading the sf::TMatrix22 from an input stream.

Template Parameters

T	Base floating point type.

Parameters

is	Input stream.
mtx	Matrix to stream.

Returns

The passed input stream.

operator>>() [7/13]

template<typename T >

std::istream & sf::operator>>	(	std::istream &	is,
		TMatrix44< T > &	mtx
	)

Operator for reading the matrix from an input stream.

Template Parameters

T	Base floating point type.

Parameters

is	Input stream.
mtx	Matrix to stream.

Returns

The passed input stream.

operator>>() [8/13]

template<typename T >

std::istream & sf::operator>>	(	std::istream &	is,
		TQuaternion< T > &	quat
	)

Operator for reading the sf::TQuaternion from an input stream. Calls TQuaternion<T>::fromString() to perform this operator.

Template Parameters

T	Base floating point type.

Parameters

is	Input stream.
quat	Matrix to stream.

Returns

The passed input stream.

operator>>() [9/13]

template<typename T >

std::istream & sf::operator>>	(	std::istream &	is,
		TRectangle2D< T > &
	)

Extracts the rectangle from an input stream.

operator>>() [10/13]

template<typename T >

std::istream & sf::operator>>	(	std::istream &	is,
		TVector2D< T > &	v
	)

Operator for reading a vector from a stream.

operator>>() [11/13]

template<typename T >

std::istream & sf::operator>>	(	std::istream &	is,
		TVector3D< T > &	v
	)

Operator for reading a vector from a stream.

operator>>() [12/13]

_MISC_FUNC std::istream & sf::operator>>	(	std::istream &	is,
		Value &	v
	)

Value class input stream operator.

operator>>() [13/13]

_GII_FUNC std::istream & sf::operator>>	(	std::istream &	is,
		Variable &	v
	)

Stream operator for the setup std::string.

precision()

_MISC_FUNC int sf::precision

(

double

value

)

Returns the precision of the passed floating point value. This is the amount of characters after the point without the trailing zeros. When the value is 12300.00 the value returned is 3. When the value is 0.0123 the value returned is also 3.

Parameters

value

Floating point value

Returns

Amount of characters after the point without the trailing zeros.

printBacktrace()

_MISC_FUNC void sf::printBacktrace

(

std::ostream &

os

)

Prints the backtrace to a stream.

proc_getgrgid()

_MISC_FUNC bool sf::proc_getgrgid	(	gid_t	gid,
		group_t &	grp
	)

Wrapper for getpwuid_r() but simplified using group_t. Returns true when an entry was found. In case of an error it throws en exception.

proc_getgrnam()

_MISC_FUNC bool sf::proc_getgrnam	(	const std::string &	name,
		group_t &	grp
	)

Wrapper for getgrnam_r() but simplified using group_t. Returns true when an entry was found. In case of an error it throws en exception.

proc_getpwnam()

bool sf::proc_getpwnam	(	std::string	name,
		passwd_t &	pwd
	)

Wrapper for getpwnam_r() but simplified using passwd_t. Returns true when an entry was found. In case of an error it throws en exception.

proc_getpwuid()

bool sf::proc_getpwuid	(	uid_t	uid,
		passwd_t &	pwd
	)

Wrapper for getpwuid_r() but simplified using passwd_t. Returns true when an entry was found. In case of an error it throws en exception.

proc_setegid()

_MISC_FUNC void sf::proc_setegid

(

gid_t

gid

)

Wrapper for setegid(). In case of an error it throws en exception.

proc_seteuid()

void sf::proc_seteuid

(

uid_t

uid

)

Wrapper for seteuid(). In case of an error it throws en exception.

proc_setfsgid()

_MISC_FUNC void sf::proc_setfsgid

(

gid_t

gid

)

Wrapper for setfsgid(). In case of an error it throws en exception.

proc_setfsuid()

_MISC_FUNC void sf::proc_setfsuid

(

uid_t

uid

)

Wrapper for setfsuid(). In case of an error it throws en exception.

proc_setgid()

_MISC_FUNC void sf::proc_setgid

(

gid_t

gid

)

Wrapper for setgid(). In case of an error it throws en exception.

proc_setuid()

void sf::proc_setuid

(

uid_t

uid

)

Wrapper for setuid(). In case of an error it throws en exception.

PROJECT_FULL_DELIM()

constexpr std::string_view sf::PROJECT_FULL_DELIM ( "|"  )

constexpr

PROJECT_NAME_DELIM()

constexpr std::string_view sf::PROJECT_NAME_DELIM ( "@"  )

constexpr

random()

template<typename T >

T sf::random	(	T	start,
		T	stop
	)

Generates random numbers within a specified integer range.

read_to_delimiter()

_MISC_FUNC std::istream & sf::read_to_delimiter	(	std::istream &	is,
		std::string &	s,
		char	delimiter
	)

Read a stream until a given delimiter.

Parameters

is	Input stream.
s	String being filled.
delimiter	Delimiting character.

Returns

Passed input stream.

replaceAll()

_MISC_FUNC std::string sf::replaceAll	(	const std::string &	s,
		const std::string &	from,
		const std::string &	to
	)

Replaces all occurrences of 'from' substring and replaces them with 'to' string.

Parameters

s	Source string.
from	String to be replaced.
to	String to replace it with.

Returns

Resulting string.

requiredDigits()

_MISC_FUNC int sf::requiredDigits	(	double	round_val,
		double	min_val,
		double	max_val
	)

Gets the amount of required digits needed when drawing a scale.

This function is used in combination with numberString() to provide the 'digits' argument.

Parameters

round_val	Value used for rounding or stepping.
min_val	Minimum value on the scale.
max_val	Maximum value on the scale.

Returns

Amount of digits required.

resizeColumnsToContents()

void sf::resizeColumnsToContents ( QTreeView *  treeView )

inline

Resizes all columns to content of a tree view except the last column.

Parameters

treeView

round()

template<typename T >

T sf::round	(	T	value,
		T	rnd
	)

Rounds the passed value to a multiple of the rnd value.

saveVariableValues()

bool _GII_FUNC sf::saveVariableValues

(

IniProfile &

profile

)

Saves variable settings to the passed profile instance.

Which variable values are saved is determined by its flags.

SEC_BINDER_GENERAL()

constexpr std::string_view sf::SEC_BINDER_GENERAL ( "Scan Binder"  )

constexpr

SEC_CFG_GENERAL()

constexpr std::string_view sf::SEC_CFG_GENERAL ( "General"  )

constexpr

SEC_GENERAL()

constexpr std::string_view sf::SEC_GENERAL ( "General"  )

constexpr

SEC_INSP_ANALYSIS()

constexpr std::string_view sf::SEC_INSP_ANALYSIS ( "Analysis"  )

constexpr

SEC_INSP_AREA_PREFIX()

constexpr std::string_view sf::SEC_INSP_AREA_PREFIX ( "  ScanArea, "    )

constexpr

SEC_INSP_CALIB()

constexpr std::string_view sf::SEC_INSP_CALIB ( "  Calibration, "    )

constexpr

SEC_INSP_CUSTOM()

constexpr std::string_view sf::SEC_INSP_CUSTOM ( "Custom"  )

constexpr

SEC_INSP_GENERAL()

constexpr std::string_view sf::SEC_INSP_GENERAL ( "General"  )

constexpr

SEC_MAT_INFO()

constexpr std::string_view sf::SEC_MAT_INFO ( "Information"  )

constexpr

SEC_MAT_SOUNDVEL()

constexpr std::string_view sf::SEC_MAT_SOUNDVEL ( "Sound Velocity"  )

constexpr

SEC_MOD_SYSPOS()

constexpr std::string_view sf::SEC_MOD_SYSPOS ( "System Positions"  )

constexpr

SEC_REPORT()

constexpr std::string_view sf::SEC_REPORT ( "Report"  )

constexpr

SEC_SCANS()

constexpr std::string_view sf::SEC_SCANS ( "Scans"  )

constexpr

SEC_TE_INFO()

constexpr std::string_view sf::SEC_TE_INFO ( "Information"  )

constexpr

SEC_TE_SELECTED()

constexpr std::string_view sf::SEC_TE_SELECTED ( "Selected"  )

constexpr

SEC_TE_SERIALS()

constexpr std::string_view sf::SEC_TE_SERIALS ( "Serial Numbers"  )

constexpr

setConfigLocationHandler()

_MISC_FUNC void sf::setConfigLocationHandler

(

const ConfigLocationClosure &

handler = {}

)

Sets the callback function for the getConfigLocation() function.

Parameters

handler

Callback closure.

SetDefaultDebugOutput()

_MISC_FUNC void sf::SetDefaultDebugOutput

(

unsigned int

type

)

Set and get function for the type of output when DO_DEFAULT is passed.

Parameters

type	Single or combined (or '|') value of EDebugOutputType enumerate.

setGlobalParent()

_MISC_FUNC QWidget * sf::setGlobalParent

(

QWidget *

parent

)

Sets global parent widget class for dialogs.

Parameters

parent

New instance.

Returns

Previous instance.

setGlobalSettings()

_MISC_FUNC QSettings * sf::setGlobalSettings

(

QSettings *

settings

)

Sets global settings class for settings.

Parameters

settings

New instance.

Returns

Previous instance.

setGlobalUiLoader()

_MISC_FUNC QUiLoader * sf::setGlobalUiLoader

(

QUiLoader *

uiLoader

)

Sets global UI loader class.

Parameters

uiLoader

New instance.

Returns

Previous instance.

setPluginDir()

_MISC_FUNC void sf::setPluginDir

(

QString

pluginDir

)

Sets the global plugin directory used i.e. by sf::FormBuilderLoad() and sf::FormBuilderSave().

setSustainTimer()

_MISC_FUNC bool sf::setSustainTimer

(

int

msec

)

This function will enable a timer that call all Sustain functions in the _defaultVector member of the 'TSustain' template class. Passing the repetition rate in milliseconds. if the passed time is zero the timer stops. Returns true if it was successful.

Parameters

msec	Time in milliseconds.

setUnitConversionHandler()

_GII_FUNC void sf::setUnitConversionHandler

(

const UnitConversionServerClosure &

closure = {}

)

Sets the callback function for a security server.

Parameters

closure

Callback closure.

shiftHsl()

_PAL_FUNC void sf::shiftHsl	(	const QColor &	colorBegin,
		const QColor &	colorEnd,
		ColorTable::iterator	fromEntry,
		ColorTable::iterator	toEntry,
		const ColorShiftCurve &	curve = {}
	)

shiftHsv()

_PAL_FUNC void sf::shiftHsv	(	const QColor &	colorBegin,
		const QColor &	colorEnd,
		ColorTable::iterator	fromEntry,
		ColorTable::iterator	toEntry,
		const ColorShiftCurve &	curve = {}
	)

shiftRgb()

_PAL_FUNC void sf::shiftRgb	(	const QColor &	colorBegin,
		const QColor &	colorEnd,
		ColorTable::iterator	fromEntry,
		ColorTable::iterator	toEntry,
		const ColorShiftCurve &	curve = {}
	)

shiftSaturation()

_PAL_FUNC void sf::shiftSaturation	(	const QColor &	color,
		ColorTable::iterator	fromEntry,
		ColorTable::iterator	toEntry,
		const ColorShiftCurve &	curve = {}
	)

siginterrupt()

int _MISC_FUNC sf::siginterrupt	(	int	sig,
		int	flag
	)

Replacement for deprecated 'siginterrupt' function. Returns EINVAL when the sig argument is not a valid signal number otherwise zero.

Parameters

sig	A signal like defined in the SA_????? defines.
flag	Boolean value for installing and uninstalling the signal.

storeElementInfo()

void _KTM_CLASS sf::storeElementInfo	(	IniProfile &	ini,
		const std::string &	section,
		ElementInformation &	eid,
		bool	read
	)

storeTreeViewState()

_MISC_FUNC void sf::storeTreeViewState	(	QSettings &	settings,
		QAnyStringView	name,
		const QTreeView *	tv,
		bool	read
	)

Stores or restores column widths of a QTreeView.

Parameters

settings	Settings instance reference.
name	Name of the treeview.
tv	Pointer to the tree view.
read	When true it read from the storage location.

storeWindowState()

_MISC_FUNC void sf::storeWindowState	(	QSettings &	settings,
		QAnyStringView	name,
		QWidget *	widget,
		bool	read
	)

Stores or restores the window position and size from the settings file onto the passed widget.

Parameters

settings	Settings instance reference.
name	Name of the window.
widget	Window widget.
read	When true it read from the storage location.

STR_VERSION()

constexpr std::string_view sf::STR_VERSION ( "0.0"  )

constexpr

string_format()

template<typename... Args>

std::string sf::string_format	(	const std::string &	format,
		Args &&...	args
	)

Better implementation of 'stringf' ?

stringf()

_MISC_FUNC std::string sf::stringf	(	const char *	fmt,
			...
	)

Creates a formatted string and returns it in a string class instance.

stringHex()

_MISC_FUNC size_t sf::stringHex	(	const char *	hexstr,
		void *	buffer,
		size_t	sz
	)

Converts a hexadecimal string to a block of data.

strncspn()

_MISC_FUNC size_t sf::strncspn	(	const char *	s,
		size_t	n,
		const char *	reject
	)

The strncspn() function calculates the length of the initial segment of 's' which consists entirely of characters not in reject up to a maximum 'n'. When no reject chars were found n is returned.

strnspn()

_MISC_FUNC size_t sf::strnspn	(	const char *	s,
		size_t	n,
		const char *	accept
	)

The strncspn() function calculates the length of the initial segment of 's' which consists entirely of characters in accept up to a maximum 'n'.

strnstr()

_MISC_FUNC const char * sf::strnstr	(	const char *	s,
		const char *	find,
		size_t	n
	)

Find the first occurrence of find in s, where the search is limited to the first slen characters of s.

SUBDIR_ELEMENT()

constexpr std::string_view sf::SUBDIR_ELEMENT ( "Element"  )

constexpr

SUBDIR_MATERIAL()

constexpr std::string_view sf::SUBDIR_MATERIAL ( "Material"  )

constexpr

SUBDIR_PART()

constexpr std::string_view sf::SUBDIR_PART ( "Part"  )

constexpr

SUBDIR_SETTINGS()

constexpr std::string_view sf::SUBDIR_SETTINGS ( "Settings"  )

constexpr

SUBDIR_TEMPLATE()

constexpr std::string_view sf::SUBDIR_TEMPLATE ( "Template"  )

constexpr

SUBDIR_TOOL()

constexpr std::string_view sf::SUBDIR_TOOL ( "Tool"  )

constexpr

swap_it()

template<typename T >

void sf::swap_it ( T &  t1, T &  t2  )

inline

Swaps the passed two arguments of any type.

Deprecated:

Use std::swap()

Template Parameters

T	Type that is swapped

Parameters

t1	Parameter 1 of type
t2	Parameter 2 of type

systemBeep()

_MISC_FUNC void sf::systemBeep	(	int	frequency,
		int	duration
	)

When possible makes the computer system beep.

Parameters

frequency	Frequency of the beep in Hz.
duration	Duration of the beep in milliseconds.

time_format() [1/2]

_MISC_FUNC std::string sf::time_format	(	const struct tm *	time_info,
		const char *	format = nullptr
	)

Formats the time to the given format.

Parameters

time_info	When NULL the current local time is used.
format	When NULL the XML format is used.

Returns

Formatted time string.

time_format() [2/2]

_MISC_FUNC std::string sf::time_format	(	time_t	time = -1,
		const char *	format = nullptr,
		bool	gm_time = false
	)

Formats the time to the given format.

Parameters

time	When -1 the current time is used.
format	When NULL the XML format is used.
gm_time	When true GMT is the result value not the localtime.

Returns

Formatted time string.

time_mktime()

_MISC_FUNC time_t sf::time_mktime	(	struct tm *	tm,
		bool	gm_time = false
	)

Same as mktime().

Parameters

tm	Time
gm_time	When true GMT is the result value not the localtime.

Returns

Time as time_t.

time_str2time()

_MISC_FUNC time_t sf::time_str2time	(	const std::string &	str,
		const char *	format = nullptr,
		bool	gm_time = false
	)

Gets the unix time from the passed string in the format that was passed.

Parameters

str
format	When NULL the XML format is used.
gm_time	When is true GMT is used otherwise the local time.

Returns

Time structure.

timespecCompare()

_MISC_FUNC int sf::timespecCompare	(	const timespec &	ts1,
		const timespec &	ts2
	)

Compares the 2 'timespec' time structures. Helper function.

Returns

-1, 0, 1 respectively for smaller, equal en larger.

toAbs()

template<typename T >

T sf::toAbs

(

T

v

)

Gets the absolute value of a passed scalar value.

Template Parameters

T	Scalar type only.

Parameters

v	Scalar value.

Returns

Absolute value.

toDegrees()

template<typename T >

constexpr T sf::toDegrees ( T  radians )

constexpr

Converts radians to degrees.

toFloat()

template<typename T >

T sf::toFloat	(	const char *	ptr,
		char **	end_ptr = nullptr
	)

A locale independent template version for std::strtof(), std::strtod() and std::strtold() functions which uses locale "C".

Template Parameters

T	Floating point type.

Parameters

ptr	String buffer pointer to start.
end_ptr	Optional pointer to pointer where conversion stopped reading.

Returns

The floating point value.

toLower()

_MISC_FUNC std::string sf::toLower

(

std::string

s

)

Converts the passed string into a lower case one and returns it.

toNumber()

template<typename T , typename S = std::string>

T sf::toNumber	(	const S &	s,
		size_t *	idx = nullptr
	)

Converts a std::string to a T value and whe not possible it returns the passed default.

Template Parameters

T	Any floating point or integer value.

Parameters

s	String representation of the value.
idx	Position where the conversion stopped in string 's'.

Returns

Converted value.

toNumberDefault()

template<typename T , typename S = std::string>

T sf::toNumberDefault	(	const S &	s,
		T	def
	)

Converts a std::string to a T value and when not possible it returns the passed default.

Template Parameters

T	Any floating point or integer value.

Parameters

s	String representation of the value.
def	Default value when conversion is not possible.

Returns

Converted or default value.

toRadians()

template<typename T >

constexpr T sf::toRadians ( T  degrees )

constexpr

Converts degrees to radians.

toString() [1/3]

_SCN_FUNC QString sf::toString

(

const QMatrix4x4 &

mtx

)

Converts a QMatrix4x4 type to a QString. Allows using the QMatrix4x4 type to be serialized as a property.

toString() [2/3]

_MISC_FUNC std::string sf::toString

(

const QRect &

rect

)

Converts the passed Qt rectangle into a std string.

Parameters

rect	Qt Rectangle.

Returns

String like '(left, bottom, right, top)'.

toString() [3/3]

template<typename T >

std::string sf::toString	(	T	value,
		int	digits = 0
	)

The function converts number to a minimal length. It produces 'digits' significant digits in either printf(3) F format or E (scientific) format. Always returns a decimal point without setting the global locale. In case of more than 3 trailing zeros with large numbers a scientific notation is formed instead.

Parameters

value	Value to be converted to a string.
digits	Amount of digits of resolution in case of a floating point.

toStringPrecision()

template<typename T >

std::string sf::toStringPrecision	(	T	value,
		int	prec = std::numeric_limits< int >::max()
	)

Converts any floating point value in to a string with a given precision. The default precision shows a .

Parameters

value	Floating point value.
prec	Amount of float decimals when not in scientific notation.

Returns

sprintf string formated.

toUpper()

_MISC_FUNC std::string sf::toUpper

(

std::string

s

)

Converts the passed string into an upper case one and returns it.

TranslateToNipscanCoords()

bool _KTM_FUNC sf::TranslateToNipscanCoords	(	const Matrix44 &	surface,
		const ToolInformation &	tool,
		double	beamlen,
		double &	x,
		double &	y,
		double &	z,
		double &	a,
		double &	b,
		TranslateOptions	options = {}
	)

Gets the translating a matrix value to manipulator coordinates. This function should be part of a scan mode but will be needed else where too.

Parameters

surface	Matrix describing the surface.
tool	Description of the tool vector and beam angle.
beamlen	Length of the beam when it leaves the tool.
x	Linear x-axis return value.
y	Linear y-axis return value.
z	Linear z-axis return value.
a	Linear a-axis return value.
b	Linear b-axis return value.
options	// Options for translation.

Returns

True on success.

trim() [1/2]

_MISC_FUNC QString sf::trim	(	const QString &	str,
		const QString &	chars = " "
	)

Trims all characters in t from both ends of s.

Parameters

str	The string to trim (by value).
chars	A set of characters to remove.

Returns

QString The fully-trimmed result.

trim() [2/2]

_MISC_FUNC std::string sf::trim	(	std::string	s,
		const std::string &	t = " "
	)

Trims a passed string at both sides and returns it.

trimLeft() [1/2]

_MISC_FUNC QString sf::trimLeft	(	const QString &	str,
		const QString &	chars = " "
	)

Trims all characters in t from the left end of s.

Parameters

str	The string to trim (by value).
chars	A set of characters to remove.

Returns

QString The left-trimmed result.

trimLeft() [2/2]

_MISC_FUNC std::string sf::trimLeft	(	std::string	s,
		const std::string &	t = " "
	)

Trims a passed string left and returns it.

trimRight() [1/2]

_MISC_FUNC QString sf::trimRight	(	const QString &	str,
		const QString &	chars = " "
	)

Trims all characters in t from the right end of s.

Parameters

str	The string to trim (by value, so it can be modified in-place).
chars	A set of characters to remove.

Returns

QString The right-trimmed result.

trimRight() [2/2]

_MISC_FUNC std::string sf::trimRight	(	std::string	s,
		const std::string &	t = " "
	)

Trims a passed string right and returns it.

unescape()

_MISC_FUNC std::string sf::unescape

(

const std::string &

str

)

Unescapes the passed string escaped by the escape() function.

See also

escape()

Parameters

str	Input string

Returns

Unescaped string

UserOutputDebugString()

_MISC_FUNC void sf::UserOutputDebugString ( unsigned int  type, const char *  str  )

noexcept

Allows the passed string to be presented in various ways.

Parameters

type	Single or combined (or '|') value of EDebugOutputType enumerate.
str	Notification string.

wildcmp() [1/2]

_MISC_FUNC int sf::wildcmp	(	const char *	wild,
		const char *	str,
		bool	case_s
	)

Matches a string against a wildcard string such as "*.*" or "bl?h.*" etc.

wildcmp() [2/2]

int sf::wildcmp ( const std::string &  wild, const std::string &  str, bool  case_s  )

inline

Matches a string against a wildcard string such as "*.*" or "bl?h.*" etc.

Variable Documentation

is_iterable_v

template<typename T >

constexpr bool sf::is_iterable_v = is_iterable<T>::value

constexpr

PropertySheetDialog

class _MISC_CLASS sf::PropertySheetDialog

RangeCompareExact

_MISC_DATA bool sf::RangeCompareExact

extern

Set the equal and unequal operators to include the id's. Used in unit tests.

US_METHOD_COPY

constexpr const char* sf::US_METHOD_COPY = "Copy"

constexpr

Method for generating sample copy results in array's of Amplitude values.

US_METHOD_PEAK

constexpr const char* sf::US_METHOD_PEAK = "Peak"

constexpr

Names used for method identification.