xentara-plugin v2.0.3
The Xentara Plugin Framework
|
Meta-Information about an element class. More...
#include <xentara/skill/Element.hpp>
Public Member Functions | |
virtual | ~Class ()=0 |
Virtual destructor. | |
virtual auto | name () const -> std::string_view=0 |
Gets the name of the element class. | |
virtual auto | uuid () const -> utils::core::Uuid=0 |
Gets the UUID of the element class. | |
virtual auto | displayName () const -> std::string_view=0 |
Gets the user facing name of the class. | |
Static Public Attributes | |
Standard Names for I/Os | |
static const std::string_view | kIo |
The standard name for a generic I/O. | |
static const std::string_view | kInput |
The standard name for a generic input. | |
static const std::string_view | kOutput |
The standard name for a generic output. | |
static const std::string_view | kDigitalIo |
The standard name for a digital I/O. | |
static const std::string_view | kDigitalInput |
The standard name for a digital input. | |
static const std::string_view | kDigitalOutput |
The standard name for a digital output. | |
static const std::string_view | kAnalogIo |
The standard name for an analog I/O. | |
static const std::string_view | kAnalogInput |
The standard name for an analog input. | |
static const std::string_view | kAnalogOutput |
The standard name for an analog output. | |
static const std::string_view | kVariable |
The standard name for a variable. | |
static const std::string_view | kRegister |
The standard name for a register. | |
static const std::string_view | kChannel |
The standard name for a channel. | |
static const std::string_view | kPin |
The standard name for a pin. | |
static const std::string_view | kBit |
The standard name for a bit. | |
Standard Names for Hardware Components | |
static const std::string_view | kDevice |
The standard name for generic devices. | |
static const std::string_view | kSubDevice |
The standard name for generic sub devices. | |
static const std::string_view | kBus |
The standard name for a bus. | |
static const std::string_view | kPort |
The standard name for a port. | |
static const std::string_view | kPlc |
The standard name for a PLC. | |
static const std::string_view | kCpu |
The standard name for a single CPU within a redundant PLC. | |
static const std::string_view | kController |
The standard name for a bus controller. | |
static const std::string_view | kCoupler |
The standard name for a bus coupler. | |
static const std::string_view | kBoard |
The standard name for an I/O board. | |
static const std::string_view | kModule |
The standard name for a module for a board, PLC, controller, coupler etc. | |
static const std::string_view | kIoGroup |
The standard name for a group of generic I/O on a board. | |
static const std::string_view | kInputGroup |
The standard name for a group of generic inputs on a board. | |
static const std::string_view | kOutputGroup |
The standard name for a group of generic outputs on a board. | |
static const std::string_view | kChannelGroup |
The standard name for a group of channels on a board. | |
static const std::string_view | kInterface |
The standard name for a generic interface. | |
static const std::string_view | kTerminal |
The standard name for a terminal with multiple I/Os. | |
static const std::string_view | kConnector |
The standard name for a connector with multiple I/Os. | |
static const std::string_view | kRack |
The standard name for a rack of I/Os. | |
static const std::string_view | kSlot |
The standard name for a slot in a module, terminal, rack, board etc. | |
static const std::string_view | kServer |
The standard name for the server in a client/server architecture. | |
static const std::string_view | kClient |
The standard name for the client in a client/server architecture. | |
static const std::string_view | kMaster |
The standard name for the master in a master/slave architecture. | |
static const std::string_view | kSlave |
The standard name for the slave in a master/slave architecture. | |
static const std::string_view | kNode |
The standard name for a generic node. | |
Standard Names for Batch I/O Objects | |
static const std::string_view | kBatch |
The standard name for a generic batch. | |
static const std::string_view | kGroup |
The standard name for a generic group. | |
static const std::string_view | kQuery |
The standard name for a query. | |
static const std::string_view | kPoll |
The standard name for a poll. | |
static const std::string_view | kCommand |
The standard name for a command. | |
static const std::string_view | kBatchCommand |
The standard name for a batch command. | |
static const std::string_view | kTransaction |
The standard name for a transaction. | |
static const std::string_view | kAcquisition |
The standard name for an acquisition. | |
Meta-Information about an element class.
|
pure virtualdefault |
Virtual destructor.
|
pure virtual |
Gets the user facing name of the class.
The display name is a short description of the class used to identify it to end users. The name returned by the “type” attribute of the elements of this class. The display name should be a short, English text like “Modbus TCP device” or “reflective memory segment”.
Implemented in xentara::io::ComponentClass, xentara::io::IoBatchClass, xentara::io::IoClass, xentara::process::MicroserviceClass, and xentara::skill::Element::ConcreteClass< kName, kUuid, kDisplayName >.
|
pure virtual |
Gets the name of the element class.
To keep naming conventions as consistent as possible between drivers, Xentara provides a set of predefined class 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.
Implemented in xentara::skill::Element::ConcreteClass< kName, kUuid, kDisplayName >.
|
pure virtual |
Gets the UUID of the element class.
Implemented in xentara::skill::Element::ConcreteClass< kName, kUuid, kDisplayName >.
|
static |
The standard name for an acquisition.
|
static |
The standard name for an analog input.
|
static |
The standard name for an analog I/O.
|
static |
The standard name for an analog output.
|
static |
The standard name for a generic batch.
|
static |
The standard name for a batch command.
|
static |
The standard name for a bit.
|
static |
The standard name for an I/O board.
|
static |
The standard name for a bus.
|
static |
The standard name for a channel.
|
static |
The standard name for a group of channels on a board.
|
static |
The standard name for the client in a client/server architecture.
|
static |
The standard name for a command.
|
static |
The standard name for a connector with multiple I/Os.
|
static |
The standard name for a bus controller.
|
static |
The standard name for a bus coupler.
|
static |
The standard name for a single CPU within a redundant PLC.
|
static |
The standard name for generic devices.
|
static |
The standard name for a digital input.
|
static |
The standard name for a digital I/O.
|
static |
The standard name for a digital output.
|
static |
The standard name for a generic group.
|
static |
The standard name for a generic input.
|
static |
The standard name for a group of generic inputs on a board.
|
static |
The standard name for a generic interface.
|
static |
The standard name for a generic I/O.
|
static |
The standard name for a group of generic I/O on a board.
|
static |
The standard name for the master in a master/slave architecture.
|
static |
The standard name for a module for a board, PLC, controller, coupler etc.
|
static |
The standard name for a generic node.
|
static |
The standard name for a generic output.
|
static |
The standard name for a group of generic outputs on a board.
|
static |
The standard name for a pin.
|
static |
The standard name for a PLC.
|
static |
The standard name for a poll.
|
static |
The standard name for a port.
|
static |
The standard name for a query.
|
static |
The standard name for a rack of I/Os.
|
static |
The standard name for a register.
|
static |
The standard name for the server in a client/server architecture.
|
static |
The standard name for the slave in a master/slave architecture.
|
static |
The standard name for a slot in a module, terminal, rack, board etc.
|
static |
The standard name for generic sub devices.
|
static |
The standard name for a terminal with multiple I/Os.
|
static |
The standard name for a transaction.
|
static |
The standard name for a variable.