A class of I/O batch that a driver supports.
More...
#include <io/IoBatchClass.hpp>
A class of I/O batch that a driver supports.
- See also
- xentara::io::IoBatch
-
I/O Batch Classes
◆ ~IoBatchClass()
xentara::io::IoBatchClass::~IoBatchClass |
( |
| ) |
|
|
pure virtualdefault |
◆ config()
Gets the array object used for the configuration attributes.
This function returns the object that the framework will be using to allocate the memory block that contains the configuration attributes. You can call this function in the constructor to add confioguration attributes of your own.
You do not need to add the entire configuration of the I/O batchs to this array, only the configuration parameters you intend to publish as Xentara attributes.
- See also
- Publishing Config Parameters as Xentara Attributes
◆ name()
Gets the name of the I/O batch class.
To keep naming conventions as consistent as possible between drivers, Xentara provides a set of predefined type names. All things being equal, you should prefer using one of the predefines names. If the documentation, the specification, or common usage for your I/O method use different nomenclature, however, you should prefer that over the standard names.
- Returns
- The name of the class, in UTF-8 encoding.
◆ nameHandle()
Gets an array handle to the name of an I/O batch.
- Note
- Since the name of the I/O batch is part of its configuration, the returned handle should only be used once the I/O batch’s configuration has been fully loaded.
- Returns
- A handle to the I/O batch’s name in UTF-8 encoding.
◆ primaryKeyHandle()
Gets an array handle to the primary key of an I/O batch.
- Note
- Since the primary key is only fully known once the configuration has been completely loaded, the returned handle should not be used to get the I/O batch’s key during loading. Specifically, the returned handle should not be used from within loadConfig().
- Returns
- A handle to the I/O batch’s primary key in UTF-8 encoding.
◆ uuid()
Gets the UUID of the I/O batch class.
◆ uuidHandle()
Gets an array handle to the UUID of an I/O batch.
- Note
- Since the UUID of the I/O batch is part of its configuration, this function should only be called once the I/O batch’s configuration has been fully loaded.
◆ kAcquisition
The standard name for an acquisition.
◆ kBatch
The standard name for a generic batch.
◆ kBatchCommand
The standard name for a batch command.
◆ kCommand
The standard name for a command.
◆ kGroup
The standard name for a generic group.
◆ kPoll
The standard name for a poll.
◆ kQuery
The standard name for a query.
◆ kTransaction
The standard name for a transaction.