Class List

Here are the classes, structs, unions and interfaces with brief descriptions:

[detail level 12]

▼NarduinoMocking	Provides mock implementations of Arduino framework functions and classes for native builds
CMockSerial	Simulates Arduino's Serial class for testing purposes
CMockTime	Simulates Arduino's time functions for testing purposes
CSoftwareSerial	Mock class to simulate the SoftwareSerial library for native builds
CCharArray	Class for storing char-array (byte-array) together with size. The Array is stored on Heap-memory and is extended by adding bytes with "+=" or by write-access to an index larger than the current size
CCommInterface	Template for generic communication-interface specifies a standardized interface to use for integrating any hardware-interface (e.g. SoftwareSerial, OneWire...) into a Service-Interface The template ensures the correct handling of send- and receive-buffers of the interface:
CCommInterface_modbusRTU	The Modbus-RTU CommInterface-class specifies a communication interface with SoftwareSerial as interface-type and Monitors modbus-specific timeouts. Ensures correct data-transfer between standardized Frame-Objects in the Interface-Stack and SoftwareSerial
CCommInterfaceBase	Communcation-Interface-Base-Class of the CommInterface template specifies a standardized interface to use for integrating any hardware-interface (e.g. SoftwareSerial, OneWire...) into a Service-Interface The template ensures the correct handling of send- and receive-buffers of the interface:
CContent	The cascading of processing information and the rules applied to it lead to the concept of content- and representation. In every iteration, an information is processed and the rules of the next level, closer to the physical layer are applied to it, the information closer to the format the service is able to process is called Content. Conversely, the format, the information has after applying the rules of the next level closer to "Layer-0" is called representation
CContent_stack	Content-Stack-Template the content-stack stores the added items (call-by-value / copy) on internal array the item added last is stacked on top (highest index), the one added first is stored on index "0"
CError	Represents an error with it's error-content (error-code and an error-message), and provides methods for converting between sendable PDU and error-content
CErrorContent_t	Structure to hold an error code and its associated message
CErrorService	Service class for handling Errors
CErrorState	A class to manage and track error states using error codes
CFrame	Frame-Class as derived class from Content The derived classes define: -the conversion from a given payload plus protocol-specific parameters (e.g. Modbus-function-code, addresses...) to the frame-representation (override of content_to_rep from Content-Class)
CFrame_modbusRTU	Class for defining the structure of the Modbus-RTU-Frame. Can be constructed by a given modbus-frame and extracts payload, device-id and function-code (additionally checking CRC) or by providing payload, device-id and function-code (additionally calculating CRC)
CMessage	Represents a message with information for sender and receiver, and provides methods for converting between PDU and message content
CMessage_content_t	Represents the content of a message with sender and receiver information
CMessageService	Service class for handling messages and acknowledgments
CService	Service-Template to derive a Service class by defining the Content (derived Class of "Content") to handle and the size of the stacks (send and receive). A Service has to be instantiated with a unique service-ID and an instance-ID, the service-instance should use for it's communication. E.g.: Messenger-service with service-id "m" (specified in derived class, same on every host) is instantiated with a host-specific ID to identify the instances. The derived classes have to define the stack-processing to handle the payload at the rec-stack and add payload to the send-stack. Each derived class has a unique serviceID to identify the Service-type and each instance in the communication-network has a unique instanceID
CServiceBase	Service-base-class to add class-functions to vtable
CServiceCluster	The ServiceCluster provides functions to manage multiple services. The ServiceCluster is added to the ServiceInterface and contains references to all services, associated with the interface
CServiceClusterBase	ServiceCluster-base-class to add class-functions to vtable
CServiceInterface	Template for generic Service-Interface Defines the handling of incoming frames from CommInterface to services stored in the associated ServiceCluster and the conversion from PDU provided by Services in the ServiceCluster to frames, getting sent by the communication-interface. The ServiceInterface dedicates memory to the CommInterface by iterating through it's stacks
CServiceInterface_modbusRTU	Service-Interface-class for Modbus-RTU: Impart incoming frames from the CommInterface to the designated service of the service-cluster. Build outgoing modbus-RTU-frames from the payload provided by the services and impart them to the Communication-Interface. The service-IDs of the associated services are mapped to the modbus-rtu-function-code. If a Frame is sent by a modbus-slave device, the frame's slave-id is the same as the sender-id (and the local device-id). If a Frame is sent by a modbus-device in mastermode, the frame's slave-id is the receiver-id provided by the service, that provided the payload for the frame