Back to Aurora Vision Library Lite website

You are here: Start » System

System

Assertions

Icon Name Description / Applications
AssertImageEqualTo

Asserts that two images are equal or differ by a small given margin.

Binary Data

Icon Name Description / Applications
LoadBuffer

Reads bytes from a file and returns them as a bytes buffer.

SaveBuffer

Writes bytes from a byte buffer to a file.

Configuration

Icon Name Description / Applications
ChargeImageMemoryPools

Preallocates memory buffers for images.


This may improve performance when many images are created and destroyed in an application.

CheckLicense

Check license for a specified module.

ControlAVX2

Enables or disables AVX2 cpu extension usage by other filters.

ControlImageMemoryPools

Enables or disables deterministic image memory allocator.


This may improve performance when many images are created and destroyed in an application.

ControlParallelComputing

Enables or disables filters multithreading parallelization.

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.

ControlSSE

Enables or disables SSE cpu extension usage by other filters.

DischargeImageMemoryPools

Releases preallocated image memory buffers.

GetAvailableLicenses

Reads available licenses in the system.

GetComputerID

Gets current Computer ID.


Can be used for creating custom license protection for integrator's applications.

GetLibraryVersion

Gets current library version.

GetThreadLimitInfo

Returns how many threads are possible and a list of threads currently being used.


Makes it easier to diagnose licensing problems related to exceeding the limit of threads.

InitLibrary

Initializes library internals. Should be called before any other function from AVL.


If you do not call this first, initialization will be done in the first iteration, possibly affecting system's performance.

InspectImageMemoryPools

Returns information about allocated image memory buffers. This information can be used for preallocation.

WriteLog

Write log message with selected log level.

File System

Icon Name Description / Applications
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.

EnumerateFiles

Enumerates the files present in a disk directory.

EnumerateFiles_Random

Enumerates the files present in a disk directory sorted randomly.

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.

CheckDiskSpace

Determines the information about the filesystem on which the pathname inPath is located.

ConvertPathToAbsolute

Makes the path absolute, inStartPath + inPath

ConvertPathToRelative

Makes the path relative to inBasePath

CopyFiles

Copies files that match a pattern from a directory to other directory.

CreateDirectories

Creates a directory tree if it does not exist.

FileAttributes

Provides information about file, e.g. size, modification time

FileChecksum

Returns CRC checksum of the input file.

FindDirectories

Returns subdirectories of the input directory.

FindFiles

Returns files of the input directory.

JoinPathParts

Joins path parts

RemoveDirectory

Removes a directory, with all files and subdirectories.

RemoveFile_Multiple

Removes files that match a pattern from a directory.

RemoveFile_Single

Removes single file.

SplitFileNameToParts

Splits the filename to base and extension, the extension is considered

SplitPathToNameParent

Splits a file path into a file name and a parent directory

SplitPathToParts

Determines the information about the filesystem on which the pathname inPath is located.

TestDirectoryEmpty

Checks if a given directory is empty.

TestDirectoryExists

Checks if a given directory is present.

TestFileEmpty

Checks if the size of the file is equal to zero.

TestFileExists

Checks if a given file is present.

INI

Icon Name Description / Applications
INI_AddBoolValue

Adds or updates an INI value in the specified section & key.

INI_AddIntegerValue

Adds or updates an INI value in the specified section & key.

INI_AddRealValue

Adds or updates an INI value in the specified section & key.s

INI_AddSection

Adds a new section.

INI_AddStringValue

Adds or updates an INI value in the specified section & key.

INI_GetAllSectionKeys

Gets all key names within a section.

INI_GetAllSections

Gets all section names in the INI.

INI_GetAllValues

Gets all values within a section & key.

INI_GetBoolValue

Gets value from section & key.

INI_GetIntegerValue

Gets value from section & key.

INI_GetRealValue

Gets value from section & key.

INI_GetStringValue

Gets value from section & key.

INI_LoadFile

Loads an INI file.

INI_SaveFile

Saves an INI file.

Modbus TCP

Icon Name Description / Applications
ModbusTCP_Close

Closes a connected Modbus socket gracefully.

ModbusTCP_Connect

Connects as a client to a remote Modbus server socket.

ModbusTCP_ForceMultipleCoils

Function Code 15. Forces each coil in a sequence of coils to either ON or OFF in a remote device

ModbusTCP_ReadCoils

Function Code 01. Reads contiguous status of coils in a remote device

ModbusTCP_ReadDiscreteInputs

Function Code 02. Reads contiguous status of discrete inputs in a remote device

ModbusTCP_ReadExceptionStatus

Function Code 07. Attempts to read Exception Status

ModbusTCP_ReadInputIntegerRegisters

Function Code 04. Reads contiguous input registers in a remote device

ModbusTCP_ReadInputRealRegisters

Function Code 04. Reads contiguous input registers in a remote device

ModbusTCP_ReadInputRegisters_AsByteBuffer

Function Code 03. Reads contiguous input registers in a remote device

ModbusTCP_ReadMultipleIntegerRegisters

Function Code 03. Reads the contents of a contiguous block of holding registers in a remote device

ModbusTCP_ReadMultipleRealRegisters

Function Code 03. Reads the contents of a contiguous block of holding registers in a remote device

ModbusTCP_ReadMultipleRegisters_AsByteBuffer

Function Code 03. Reads the contents of a contiguous block of holding registers in a remote device

ModbusTCP_SendBuffer

Sends data using Modbus TCP frame format.

ModbusTCP_WriteCoil

Function Code 05. Writes a single output to either ON or OFF in a remote device

ModbusTCP_WriteMultipleIntegerRegisters

Function Code 16. Writes a block of contiguous registers (1 to 123 registers) in a remote device

ModbusTCP_WriteMultipleRealRegisters

Function Code 16. Writes a block of contiguous registers (1 to 123 registers) in a remote device

ModbusTCP_WriteMultipleRegisters_AsByteBuffer

Function Code 16. Writes a block of contiguous registers (1 to 123 registers) in a remote device

ModbusTCP_WriteSingleRegister

Function Code 06. Writes a single holding register in a remote device

Process

Icon Name Description / Applications
ReadEnvironmentVariable

Reads environment variable by given name.

ReadEnvironmentVariable_OrNil

Reads environment variable by given name.

Serial Port

Icon Name Description / Applications
SerialPort_Config

Configures the serial port.

SerialPort_ReadBuffer

Reads raw binary data from serial port.

SerialPort_ReadByte

Reads one character in binary mode from serial port.

SerialPort_ReadChar

Reads single character from serial port.

SerialPort_ReadString

Reads string characters from serial port.

SerialPort_ReadStringUntil

Reads the string from the serial port to encounter a string delimiter.

SerialPort_WriteBuffer

Writes raw binary data from a byte buffer to serial port.

SerialPort_WriteByte

Writes one character in binary mode to serial port.

SerialPort_WriteChar

Writes single ASCII character to device.

SerialPort_WriteString

Writes string characters to serial port.

TCP IP

Icon Name Description / Applications
TcpIp_Accept

Accepts a connection from a remote client.

TcpIp_Close

Closes a connected TCP socket gracefully.

TcpIp_Connect

Connects as a client to a remote TCP server socket.

TcpIp_ReadAllBuffer

Receives data from a connected socket until the other side closes connection.

TcpIp_ReadAllText

Receives text from a connected socket until the other side closes connection.

TcpIp_ReadBuffer

Receives a fixed number of bytes from a connected TCP socket.

TcpIp_ReadLine

Reads from a connected TCP socket until receiving a specific sequence.

TcpIp_WriteBuffer

Outputs a block of raw data through a connected TCP socket.

TcpIp_WriteText

Outputs a string through a connected TCP socket.

Time

Icon Name Description / Applications
CurrentDateTime

Returns a string containing the date time information in selected format and all of the date time data separately.

Delay

Suspends the program workflow for inTime milliseconds.

DelayByPeriod

Suspends the program workflow for inTime milliseconds relative to the end of the filter's last invoke time.

GetClockTime

Stops clock to measure performance.

MeasurePeriod

Returns elapsed time in milliseconds from last filter call.

StartClock

Starts clock to measure performance.

User Input

Icon Name Description / Applications
GetKeyboardKeys

Returns virtual key codes of the pressed keys or NULL if no key was pressed.

GetKeyboardKeyState

Checks if the specified keyboard key is down and if it is toggled.