Start » Filter Reference » System
System
Assertions |
||||
Icon | Name | Description / Applications | Modules | |
---|---|---|---|---|
AssertImageEqualTo | Asserts that two images are equal or differ by a small given margin. |
FoundationLite | ||
AssertBoolEqualTo | Asserts that a boolean value is equal to the expected one. |
FoundationLite | ||
AssertDoubleEqualTo | Asserts that a double value is equal to the expected one. |
FoundationLite | ||
AssertDoubleInRange | Asserts that a double value fits the specified range. |
FoundationLite | ||
AssertFalse | Asserts that a predicate is false. |
FoundationLite | ||
AssertIntegerEqualTo | Asserts that an integer value is equal to the expected one. |
FoundationLite | ||
AssertIntegerInRange | Asserts that an integer value fits the specified range. |
FoundationLite | ||
AssertLongEqualTo | Asserts that an long value is equal to the expected one. |
FoundationLite | ||
AssertLongInRange | Asserts that an long value fits the specified range. |
FoundationLite | ||
AssertMatrixEqualTo | Asserts that an matrix is equal to the expected one. |
FoundationLite | ||
AssertMatrixNotEqualTo | Asserts that an matrix is not equal to the expected one. |
FoundationLite | ||
AssertRealEqualTo | Asserts that a real value is equal to the expected one. |
FoundationLite | ||
AssertRealInRange | Asserts that a real value fits the specified range. |
FoundationLite | ||
AssertStringEqualTo | Asserts that a string is equal to the expected one. |
FoundationLite | ||
AssertTrue | Asserts that a predicate is true. |
FoundationLite | ||
AssertArraySizeEqualTo | Asserts that an array has expected size. |
FoundationLite | ||
AssertArraySizeNotEqualTo | Asserts that an array size is unequal to reference size. |
FoundationLite | ||
AssertObjectEqualTo | Asserts that an object is equal to the expected one. |
FoundationLite | ||
AssertObjectNil | Asserts that an object is Nil. |
FoundationLite | ||
AssertObjectNotEqualTo | Asserts that an object is not equal to the expected one. |
FoundationLite | ||
AssertObjectNotNil | Asserts that an object is not Nil. |
FoundationLite | ||
ThrowError | Throws specific error. |
FoundationLite | ||
Benchmarks |
||||
Icon | Name | Description / Applications | Modules | |
BenchmarkCPU | Tests CPU performance for simple arithmetic operations. Can be used if some functions of your application may be available only on high-performance computers. |
FoundationLite | ||
Binary Data |
||||
Icon | Name | Description / Applications | Modules | |
LoadBuffer | Reads bytes from a file and returns them as a bytes buffer. |
FoundationLite | ||
ReadBoolFromBuffer | Reads boolean value in specified binary format from byte buffer. |
FoundationLite | ||
ReadBufferArrayFromBuffer | Splits chunk of data from byte buffer into array of buffers of equal sizes. |
FoundationLite | ||
ReadDoubleFromBuffer | Reads double value in specified binary format from a byte buffer. |
FoundationLite | ||
ReadIntegerArrayFromBuffer | Reads an array of integer values in specified binary format from a byte buffer. |
FoundationLite | ||
ReadIntegerFromBuffer | Reads integer value in specified binary format from a byte buffer. |
FoundationLite | ||
ReadLongFromBuffer | Reads integer value in specified binary format from a byte buffer. |
FoundationLite | ||
ReadRealFromBuffer | Reads real value in specified binary format from a byte buffer. |
FoundationLite | ||
ReadStringFromBuffer | Reads string value in specified binary format from a byte buffer. |
FoundationLite | ||
SaveBuffer | Writes bytes from a byte buffer to a file. |
FoundationLite | ||
TestByteBufferEqualTo | Tests whether two buffers equal. |
FoundationLite | ||
WriteBoolToBuffer | Converts boolean value into specified integer binary representation and writes it to a byte buffer. |
FoundationLite | ||
WriteBufferArrayToBuffer | Writes connected content of all source buffer array items into other byte buffer. |
FoundationLite | ||
WriteBufferToBuffer | Writes content of a source byte buffer into other byte buffer. |
FoundationLite | ||
WriteDoubleToBuffer | Converts double value into specified binary representation and writes it to a byte buffer. |
FoundationLite | ||
WriteIntegerArrayToBuffer | Converts an array of integer values into specified binary representation and writes it to a byte buffer. |
FoundationLite | ||
WriteIntegerToBuffer | Converts integer value into specified binary representation and writes it to a byte buffer. |
FoundationLite | ||
WriteLongToBuffer | Converts integer value into specified binary representation and writes it to a byte buffer. |
FoundationLite | ||
WriteRealToBuffer | Converts real value into specified binary representation and writes it to a byte buffer. |
FoundationLite | ||
WriteStringToBuffer | Converts string value into specified binary representation and writes it to a byte buffer. |
FoundationLite | ||
Configuration |
||||
Icon | Name | Description / Applications | Modules | |
ChargeImageMemoryPools | Preallocates memory buffers for images. This may improve performance when many images are created and destroyed in an application. |
FoundationLite | ||
ControlAVX2 | Enables or disables AVX2 cpu extension usage by other filters. |
FoundationLite | ||
ControlImageMemoryPools | Enables or disables deterministic image memory allocator. This may improve performance when many images are created and destroyed in an application. |
FoundationLite | ||
ControlParallelComputing | Enables or disables filters multithreading parallelization. |
FoundationLite | ||
ControlSIMD | Enables or disables SIMD cpu extension (e.g. SSE, AVX2, NEON) usage by other filters. This filter does not affect third party components e.g. camera software, OpenCV. |
FoundationLite | ||
ControlSSE | Enables or disables SSE cpu extension usage by other filters. |
FoundationLite | ||
DischargeImageMemoryPools | Releases preallocated image memory buffers. |
FoundationLite | ||
GetComputerID | Gets current Computer ID. Can be used for creating custom license protection for integrator's applications. |
FoundationLite | ||
GetDongleSerialNumber | Gets the current usb dongle's serial number. |
FoundationBasic | ||
GetLibraryVersion | Gets current library version. |
FoundationLite | ||
InspectImageMemoryPools | Returns information about allocated image memory buffers. This information can be used for preallocation. |
FoundationLite | ||
VerifyProjectID | Verifies a project ID. This tools is useful for system integrators who need verification if a system is used with a license coming from a legitimate source. |
FoundationBasic | ||
WriteLog | Write log message with selected log level. |
FoundationLite | ||
EXIF |
||||
Icon | Name | Description / Applications | Modules | |
EXIF_LoadFromJpgFile | Reads an EXIF informations from the JPG image. |
FoundationLite | ||
File System |
||||
Icon | Name | Description / Applications | Modules | |
EnumerateObjects | Enumerates the avdata files present in a disk directory and sorts them according to the specified order and loads an object from a file. |
FoundationLite | ||
EnumerateFiles | Enumerates the files present in a disk directory. |
FoundationLite | ||
EnumerateFiles_Random | Enumerates the files present in a disk directory sorted randomly. |
FoundationLite | ||
EnumerateObjects | Enumerates the avdata files present in a disk directory and sorts them according to the specified order and loads an object from a file. |
FoundationLite | ||
LoadObject | Loads an object from a file. |
FoundationLite | ||
ReadFromString | Reads element from string stream of specified format. |
FoundationLite | ||
SaveObject | Saves an object to a file. |
FoundationLite | ||
WriteToString | Writes element to string stream with specified format. |
FoundationLite | ||
CheckDiskSpace | Determines the information about the filesystem on which the pathname inPath is located. |
FoundationLite | ||
ConvertPathToAbsolute | Makes the path absolute, inStartPath + inPath |
FoundationLite | ||
ConvertPathToRelative | Makes the path relative to inBasePath |
FoundationLite | ||
CopyFiles | Copies files that match a pattern from a directory to other directory. |
FoundationLite | ||
CreateDirectories | Creates a directory tree if it does not exist. |
FoundationLite | ||
FileAttributes | Provides information about file, e.g. size, modification time |
FoundationLite | ||
FileChecksum | Returns CRC checksum of the input file. |
FoundationLite | ||
FindDirectories | Returns subdirectories of the input directory. |
FoundationLite | ||
FindFiles | Returns files of the input directory. |
FoundationLite | ||
GenerateFileName | Generates consecutive file names, e.g. for saving series of images |
FoundationLite | ||
JoinPathParts | Joins path parts |
FoundationLite | ||
RemoveDirectory | Removes a directory, with all files and subdirectories. |
FoundationLite | ||
RemoveFile_Multiple | Removes files that match a pattern from a directory. |
FoundationLite | ||
RemoveFile_Single | Removes single file. |
FoundationLite | ||
SplitFileNameToParts | Splits the filename to base and extension, the extension is considered |
FoundationLite | ||
SplitPathToNameParent | Splits a file path into a file name and a parent directory |
FoundationLite | ||
SplitPathToParts | Determines the information about the filesystem on which the pathname inPath is located. |
FoundationLite | ||
TestDirectoryEmpty | Checks if a given directory is empty. |
FoundationLite | ||
TestDirectoryExists | Checks if a given directory is present. |
FoundationLite | ||
TestFileEmpty | Checks if the size of the file is equal to zero. |
FoundationLite | ||
TestFileExists | Checks if a given file is present. |
FoundationLite | ||
FTP |
||||
Icon | Name | Description / Applications | Modules | |
Ftp_ReceiveFile | Downloads a file from a remote server using FTP (File Transfer Protocol). |
FoundationBasic | ||
Ftp_ReceiveImage | Downloads an image from a remote server using FTP (File Transfer Protocol). |
FoundationBasic | ||
Ftp_ReceiveString | Downloads a text string from a remote server using FTP (File Transfer Protocol). |
FoundationBasic | ||
Ftp_SendFile | Sends a file to a remote server using FTP (File Transfer Protocol). |
FoundationBasic | ||
Ftp_SendImage | Sends an image to a remote server using FTP (File Transfer Protocol). |
FoundationBasic | ||
Ftp_SendString | Sends a string to a remote serve using FTP (File Transfer Protocol). |
FoundationBasic | ||
HTTP |
||||
Icon | Name | Description / Applications | Modules | |
Http_DecodeURL | Converts text from URL friendly text to a string. |
FoundationBasic | ||
Http_EncodeURL | Converts string to URL friendly text. |
FoundationBasic | ||
Http_SendRequest_GET | Sends a GET request to server and receives a text answer. |
FoundationBasic | ||
Http_SendRequest_GET_ByteBuffer | Sends a GET request to server and receives a binary answer. |
FoundationBasic | ||
Http_SendRequest_POST | Sends a POST request to the server and receives a text answer. |
FoundationBasic | ||
Http_SendRequest_POST_ByteBuffer | Sends a POST request to the server and receives a text answer. |
FoundationBasic | ||
Http_SendRequest_POST_JSON | Sends a POST request in JSON format to the server and receives a text answer. |
FoundationBasic | ||
INI |
||||
Icon | Name | Description / Applications | Modules | |
INI_AddValue | Adds value to INI. |
FoundationLite | ||
INI_GetValue | Gets value from INI. |
FoundationLite | ||
INI_AddBoolValue | Adds or updates an INI value in the specified section & key. |
FoundationLite | ||
INI_AddIntegerValue | Adds or updates an INI value in the specified section & key. |
FoundationLite | ||
INI_AddRealValue | Adds or updates an INI value in the specified section & key.s |
FoundationLite | ||
INI_AddSection | Adds a new section. |
FoundationLite | ||
INI_AddStringValue | Adds or updates an INI value in the specified section & key. |
FoundationLite | ||
INI_GetAllSectionKeys | Gets all key names within a section. |
FoundationLite | ||
INI_GetAllSections | Gets all section names in the INI. |
FoundationLite | ||
INI_GetAllValues | Gets all values within a section & key. |
FoundationLite | ||
INI_GetBoolValue | Gets value from section & key. |
FoundationLite | ||
INI_GetIntegerValue | Gets value from section & key. |
FoundationLite | ||
INI_GetRealValue | Gets value from section & key. |
FoundationLite | ||
INI_GetStringValue | Gets value from section & key. |
FoundationLite | ||
INI_LoadFile | Loads an INI file. |
FoundationLite | ||
INI_SaveFile | Saves an INI file. |
FoundationLite | ||
Interoperability |
||||
Icon | Name | Description / Applications | Modules | |
LoadEntities_FromDxf | Loads entities from a DXF file as an array of point arrays. |
FoundationPro | ||
LoadImage_FromDxf | Loads data from a DXF file as an image. |
FoundationPro | ||
LoadImage_FromWebsite | Loads a JPG image from a website. |
FoundationBasic | ||
LoadPoint3DGrid | Loads entities from a file of one of available types as an array of points in 3D. |
FoundationBasic | ||
LoadPoint3DGridWithImage | Loads entities from a file of one of available types as an array of points in 3D and an image. Assumes an ordered rectangular grid with no holes. |
FoundationBasic | ||
LoadSurfaceWithImage | Loads entities from a file of one of available types as an array of points in 3D and an image. Assumes an unordered grid with possible holes. |
FoundationBasic | ||
SavePoint3DGrid | Saves Point3DGrid in to file in one of the supported formats. |
FoundationBasic | ||
Modbus TCP |
||||
Icon | Name | Description / Applications | Modules | |
ModbusTCP_Close | Closes a connected Modbus socket gracefully. |
FoundationLite | ||
ModbusTCP_Connect | Connects as a client to a remote Modbus server socket. |
FoundationLite | ||
ModbusTCP_ForceMultipleCoils | Function Code 15. Forces each coil in a sequence of coils to either ON or OFF in a remote device |
FoundationLite | ||
ModbusTCP_ReadCoils | Function Code 01. Reads contiguous status of coils in a remote device |
FoundationLite | ||
ModbusTCP_ReadDiscreteInputs | Function Code 02. Reads contiguous status of discrete inputs in a remote device |
FoundationLite | ||
ModbusTCP_ReadExceptionStatus | Function Code 07. Attempts to read Exception Status |
FoundationLite | ||
ModbusTCP_ReadInputIntegerRegisters | Function Code 04. Reads contiguous input registers in a remote device |
FoundationLite | ||
ModbusTCP_ReadInputRealRegisters | Function Code 04. Reads contiguous input registers in a remote device |
FoundationLite | ||
ModbusTCP_ReadInputRegisters_AsByteBuffer | Function Code 03. Reads contiguous input registers in a remote device |
FoundationLite | ||
ModbusTCP_ReadMultipleIntegerRegisters | Function Code 03. Reads the contents of a contiguous block of holding registers in a remote device |
FoundationLite | ||
ModbusTCP_ReadMultipleRealRegisters | Function Code 03. Reads the contents of a contiguous block of holding registers in a remote device |
FoundationLite | ||
ModbusTCP_ReadMultipleRegisters_AsByteBuffer | Function Code 03. Reads the contents of a contiguous block of holding registers in a remote device |
FoundationLite | ||
ModbusTCP_SendBuffer | Sends data using Modbus TCP frame format. |
FoundationLite | ||
ModbusTCP_WriteCoil | Function Code 05. Writes a single output to either ON or OFF in a remote device |
FoundationLite | ||
ModbusTCP_WriteMultipleIntegerRegisters | Function Code 16. Writes a block of contiguous registers (1 to 123 registers) in a remote device |
FoundationLite | ||
ModbusTCP_WriteMultipleRealRegisters | Function Code 16. Writes a block of contiguous registers (1 to 123 registers) in a remote device |
FoundationLite | ||
ModbusTCP_WriteMultipleRegisters_AsByteBuffer | Function Code 16. Writes a block of contiguous registers (1 to 123 registers) in a remote device |
FoundationLite | ||
ModbusTCP_WriteSingleRegister | Function Code 06. Writes a single holding register in a remote device |
FoundationLite | ||
Process |
||||
Icon | Name | Description / Applications | Modules | |
ReadEnvironmentVariable | Reads environment variable by given name. |
FoundationLite | ||
ReadEnvironmentVariable_OrNil | Reads environment variable by given name. |
FoundationLite | ||
Serial Port |
||||
Icon | Name | Description / Applications | Modules | |
SerialPort_Config | Configures the serial port. |
FoundationLite | ||
SerialPort_ReadBuffer | Reads raw binary data from serial port. |
FoundationLite | ||
SerialPort_ReadByte | Reads one character in binary mode from serial port. |
FoundationLite | ||
SerialPort_ReadChar | Reads single character from serial port. |
FoundationLite | ||
SerialPort_ReadString | Reads string characters from serial port. |
FoundationLite | ||
SerialPort_ReadStringUntil | Reads the string from the serial port to encounter a string delimiter. |
FoundationLite | ||
SerialPort_WriteBuffer | Writes raw binary data from a byte buffer to serial port. |
FoundationLite | ||
SerialPort_WriteByte | Writes one character in binary mode to serial port. |
FoundationLite | ||
SerialPort_WriteChar | Writes single ASCII character to device. |
FoundationLite | ||
SerialPort_WriteString | Writes string characters to serial port. |
FoundationLite | ||
Sound |
||||
Icon | Name | Description / Applications | Modules | |
PlaySoundFile | Plays specified audio file in WAV format. |
FoundationLite | ||
TCP IP |
||||
Icon | Name | Description / Applications | Modules | |
TcpIp_ReadObject | Receives an object through a connected TCP socket. |
FoundationLite | ||
TcpIp_WriteObject | Sends an object through a connected TCP socket. |
FoundationLite | ||
TcpIp_Accept | Accepts a connection from a remote client. |
FoundationLite | ||
TcpIp_Close | Closes a connected TCP socket gracefully. |
FoundationLite | ||
TcpIp_Connect | Connects as a client to a remote TCP server socket. |
FoundationLite | ||
TcpIp_ReadAllBuffer | Receives data from a connected socket until the other side closes connection. |
FoundationLite | ||
TcpIp_ReadAllText | Receives text from a connected socket until the other side closes connection. |
FoundationLite | ||
TcpIp_ReadBuffer | Receives a fixed number of bytes from a connected TCP socket. |
FoundationLite | ||
TcpIp_ReadLine | Reads from a connected TCP socket until receiving a specific sequence. |
FoundationLite | ||
TcpIp_WriteBuffer | Outputs a block of raw data through a connected TCP socket. |
FoundationLite | ||
TcpIp_WriteText | Outputs a string through a connected TCP socket. |
FoundationLite | ||
Time |
||||
Icon | Name | Description / Applications | Modules | |
CurrentDateTime | Returns a string containing the date time information in selected format and all of the date time data separately. |
FoundationLite | ||
Delay | Suspends the program workflow for inTime milliseconds. |
FoundationLite | ||
DelayByPeriod | Suspends the program workflow for inTime milliseconds relative to the end of the filter's last invoke time. |
FoundationLite | ||
MeasurePeriod | Returns elapsed time in milliseconds from last filter call. |
FoundationLite | ||
StartClock | Starts clock to measure performance. |
FoundationLite | ||
User Input |
||||
Icon | Name | Description / Applications | Modules | |
GetKeyboardKeys | Returns virtual key codes of the pressed keys or NULL if no key was pressed. |
FoundationLite | ||
GetKeyboardKeyState | Checks if the specified keyboard key is down and if it is toggled. |
FoundationLite | ||
Xml |
||||
Icon | Name | Description / Applications | Modules | |
ReadFromXmlNode | Reads an element from an XML node. |
FoundationLite | ||
WriteToXmlNode | Saves an object to an XML node. |
FoundationLite | ||
AccessXmlNode | Gets information from the XmlNode object. |
FoundationLite | ||
StringToXmlNode | Parses text as an XML tree. |
FoundationLite | ||
XmlNodeToString | Converts an XML tree to the string. |
FoundationLite | ||
Xml_AddChildNodes | Appends new children nodes to the XML node. |
FoundationLite | ||
Xml_AddChildNodes_OfArray | Appends new children nodes to the XML node. |
FoundationLite | ||
Xml_AppendAttributes | Appends new attributes to the node. |
FoundationLite | ||
Xml_CreateNode | Creates a new XmlNode. |
FoundationLite | ||
Xml_GetBoolAttribute | Gets a node attribute value as Bool. |
FoundationLite | ||
Xml_GetChildNode | Gets a node child. |
FoundationLite | ||
Xml_GetChildNode_OrNil | Gets a node child. |
FoundationLite | ||
Xml_GetIntegerAttribute | Gets a node attribute value as Integer. |
FoundationLite | ||
Xml_GetNodeText | Gets the text from the selected node. |
FoundationLite | ||
Xml_GetRealAttribute | Gets a node attribute value as Real. |
FoundationLite | ||
Xml_GetStringAttribute | Gets a node attribute value as String. |
FoundationLite | ||
Xml_LoadFile | Loads an XML tree from the file. |
FoundationLite | ||
Xml_RemoveNodes | Removes nodes selected by an XPath request. |
FoundationLite | ||
Xml_SaveFile | Saves an XML DOM tree to the file. |
FoundationLite | ||
Xml_SelectMultipleAttributes_AsBools | Selects attributes from the XML tree using XPath request. |
FoundationLite | ||
Xml_SelectMultipleAttributes_AsIntegers | Selects attributes from the XML tree using XPath request. |
FoundationLite | ||
Xml_SelectMultipleAttributes_AsReals | Selects attributes from the XML tree using XPath request. |
FoundationLite | ||
Xml_SelectMultipleAttributes_AsStrings | Selects attributes from the XML tree using XPath request. |
FoundationLite | ||
Xml_SelectMultipleNodes | Selects nodes from the XML tree using XPath request. |
FoundationLite | ||
Xml_SelectMultipleNodeValues_AsBools | Selects nodes from the XML tree using XPath request. |
FoundationLite | ||
Xml_SelectMultipleNodeValues_AsIntegers | Selects nodes from the XML tree using XPath request. |
FoundationLite | ||
Xml_SelectMultipleNodeValues_AsReals | Selects nodes from the XML tree using XPath request. |
FoundationLite | ||
Xml_SelectMultipleNodeValues_AsStrings | Selects nodes from the XML tree using XPath request. |
FoundationLite | ||
Xml_SelectSingleAttribute_AsBool | Selects attribute from the XML tree using XPath request. |
FoundationLite | ||
Xml_SelectSingleAttribute_AsInteger | Selects attribute from the XML tree using XPath request. |
FoundationLite | ||
Xml_SelectSingleAttribute_AsReal | Selects attribute from the XML tree using XPath request. |
FoundationLite | ||
Xml_SelectSingleAttribute_AsString | Selects attribute from the XML tree using XPath request. |
FoundationLite | ||
Xml_SelectSingleNode | Selects a node from the XML tree using an XPath request. |
FoundationLite | ||
Xml_SelectSingleNodeValue_AsBool | Selects node from the XML tree using XPath request. |
FoundationLite | ||
Xml_SelectSingleNodeValue_AsInteger | Selects node from the XML tree using XPath request. |
FoundationLite | ||
Xml_SelectSingleNodeValue_AsReal | Selects node from the XML tree using XPath request. |
FoundationLite | ||
Xml_SelectSingleNodeValue_AsString | Selects node from the XML tree using XPath request. |
FoundationLite | ||
Xml_SetAttributes | Sets values of attributes which were selected using XPath request. |
FoundationLite | ||
Xml_SetNodeValues | Sets values of nodes which were selected using XPath request. |
FoundationLite |