xentara::skill::Element::Class Class Reference

Meta-Information about an element class. More...

#include <xentara/skill/Element.hpp>

Inheritance diagram for xentara::skill::Element::Class:

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.

Detailed Description

Meta-Information about an element class.

Constructor & Destructor Documentation

~Class()

xentara::skill::Element::Class::~Class ( )

pure virtualdefault

Virtual destructor.

Member Function Documentation

displayName()

virtual auto xentara::skill::Element::Class::displayName ( ) const -> std::string_view

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”.

Returns

The display name of the class, in UTF-8 encoding.

Implemented in xentara::io::ComponentClass, xentara::io::IoBatchClass, xentara::io::IoClass, xentara::process::MicroserviceClass, and xentara::skill::Element::ConcreteClass< kName, kUuid, kDisplayName >.

name()

virtual auto xentara::skill::Element::Class::name ( ) const -> std::string_view

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.

Returns

The name of the class, in UTF-8 encoding.

Implemented in xentara::skill::Element::ConcreteClass< kName, kUuid, kDisplayName >.

uuid()

virtual auto xentara::skill::Element::Class::uuid ( ) const -> utils::core::Uuid

pure virtual

Gets the UUID of the element class.

Implemented in xentara::skill::Element::ConcreteClass< kName, kUuid, kDisplayName >.

Member Data Documentation

kAcquisition

const std::string_view xentara::skill::Element::Class::kAcquisition

static

The standard name for an acquisition.

kAnalogInput

const std::string_view xentara::skill::Element::Class::kAnalogInput

static

The standard name for an analog input.

kAnalogIo

const std::string_view xentara::skill::Element::Class::kAnalogIo

static

The standard name for an analog I/O.

kAnalogOutput

const std::string_view xentara::skill::Element::Class::kAnalogOutput

static

The standard name for an analog output.

kBatch

const std::string_view xentara::skill::Element::Class::kBatch

static

The standard name for a generic batch.

kBatchCommand

const std::string_view xentara::skill::Element::Class::kBatchCommand

static

The standard name for a batch command.

kBit

const std::string_view xentara::skill::Element::Class::kBit

static

The standard name for a bit.

kBoard

const std::string_view xentara::skill::Element::Class::kBoard

static

The standard name for an I/O board.

kBus

const std::string_view xentara::skill::Element::Class::kBus

static

The standard name for a bus.

kChannel

const std::string_view xentara::skill::Element::Class::kChannel

static

The standard name for a channel.

kChannelGroup

const std::string_view xentara::skill::Element::Class::kChannelGroup

static

The standard name for a group of channels on a board.

kClient

const std::string_view xentara::skill::Element::Class::kClient

static

The standard name for the client in a client/server architecture.

kCommand

const std::string_view xentara::skill::Element::Class::kCommand

static

The standard name for a command.

kConnector

const std::string_view xentara::skill::Element::Class::kConnector

static

The standard name for a connector with multiple I/Os.

kController

const std::string_view xentara::skill::Element::Class::kController

static

The standard name for a bus controller.

kCoupler

const std::string_view xentara::skill::Element::Class::kCoupler

static

The standard name for a bus coupler.

kCpu

const std::string_view xentara::skill::Element::Class::kCpu

static

The standard name for a single CPU within a redundant PLC.

kDevice

const std::string_view xentara::skill::Element::Class::kDevice

static

The standard name for generic devices.

kDigitalInput

const std::string_view xentara::skill::Element::Class::kDigitalInput

static

The standard name for a digital input.

kDigitalIo

const std::string_view xentara::skill::Element::Class::kDigitalIo

static

The standard name for a digital I/O.

kDigitalOutput

const std::string_view xentara::skill::Element::Class::kDigitalOutput

static

The standard name for a digital output.

kGroup

const std::string_view xentara::skill::Element::Class::kGroup

static

The standard name for a generic group.

kInput

const std::string_view xentara::skill::Element::Class::kInput

static

The standard name for a generic input.

kInputGroup

const std::string_view xentara::skill::Element::Class::kInputGroup

static

The standard name for a group of generic inputs on a board.

kInterface

const std::string_view xentara::skill::Element::Class::kInterface

static

The standard name for a generic interface.

kIo

const std::string_view xentara::skill::Element::Class::kIo

static

The standard name for a generic I/O.

kIoGroup

const std::string_view xentara::skill::Element::Class::kIoGroup

static

The standard name for a group of generic I/O on a board.

kMaster

const std::string_view xentara::skill::Element::Class::kMaster

static

The standard name for the master in a master/slave architecture.

kModule

const std::string_view xentara::skill::Element::Class::kModule

static

The standard name for a module for a board, PLC, controller, coupler etc.

kNode

const std::string_view xentara::skill::Element::Class::kNode

static

The standard name for a generic node.

kOutput

const std::string_view xentara::skill::Element::Class::kOutput

static

The standard name for a generic output.

kOutputGroup

const std::string_view xentara::skill::Element::Class::kOutputGroup

static

The standard name for a group of generic outputs on a board.

kPin

const std::string_view xentara::skill::Element::Class::kPin

static

The standard name for a pin.

kPlc

const std::string_view xentara::skill::Element::Class::kPlc

static

The standard name for a PLC.

kPoll

const std::string_view xentara::skill::Element::Class::kPoll

static

The standard name for a poll.

kPort

const std::string_view xentara::skill::Element::Class::kPort

static

The standard name for a port.

kQuery

const std::string_view xentara::skill::Element::Class::kQuery

static

The standard name for a query.

kRack

const std::string_view xentara::skill::Element::Class::kRack

static

The standard name for a rack of I/Os.

kRegister

const std::string_view xentara::skill::Element::Class::kRegister

static

The standard name for a register.

kServer

const std::string_view xentara::skill::Element::Class::kServer

static

The standard name for the server in a client/server architecture.

kSlave

const std::string_view xentara::skill::Element::Class::kSlave

static

The standard name for the slave in a master/slave architecture.

kSlot

const std::string_view xentara::skill::Element::Class::kSlot

static

The standard name for a slot in a module, terminal, rack, board etc.

kSubDevice

const std::string_view xentara::skill::Element::Class::kSubDevice

static

The standard name for generic sub devices.

kTerminal

const std::string_view xentara::skill::Element::Class::kTerminal

static

The standard name for a terminal with multiple I/Os.

kTransaction

const std::string_view xentara::skill::Element::Class::kTransaction

static

The standard name for a transaction.

kVariable

const std::string_view xentara::skill::Element::Class::kVariable

static

The standard name for a variable.