Readme files updates

This commit is contained in:
Emmanuel HC
2025-09-21 17:58:42 -05:00
parent 6dffd66af2
commit a60b0cb3ed
24 changed files with 454 additions and 597 deletions

View File

@@ -24,7 +24,7 @@ class Modbus_Coil : public Modbus_Point<T>{
public:
/**
* @brief Constructor for the Modbus_Coil class.
* @param server Pointer to the ModbusIP server instance.
* @param server Pointer to the Modbus server instance (e.g., ModbusIP, ModbusRTU).
* @param address The Modbus address of the coil.
* @param value The initial value of the coil.
* @param description A description of the coil.
@@ -48,7 +48,13 @@ public:
*/
int getValue() const override;
};
/**
* @brief Constructor implementation for the Modbus_Coil class.
* @param server Pointer to the Modbus server instance (e.g., ModbusIP, ModbusRTU).
* @param address The Modbus address of the coil.
* @param value The initial value of the coil.
* @param description A description of the coil.
*/
template<typename T>
Modbus_Coil<T>::Modbus_Coil(T* server, int address, int value, const char* description)
: Modbus_Point<T>(server, address, value, description) {}

View File

@@ -25,7 +25,7 @@ class Modbus_Hreg : public Modbus_Point<T>{
public:
/**
* @brief Constructor for the Modbus_Hreg class.
* @param server Pointer to the ModbusIP server instance.
* @param server Pointer to the Modbus server instance (e.g., ModbusIP, ModbusRTU).
* @param address The Modbus address of the holding register.
* @param value The initial value of the holding register.
* @param description A description of the holding register.
@@ -53,7 +53,13 @@ public:
};
/**
* @brief Constructor implementation for the Modbus_Hreg class.
* @param server Pointer to the Modbus server instance (e.g., ModbusIP, ModbusRTU).
* @param address The Modbus address of the holding register.
* @param value The initial value of the holding register.
* @param description A description of the holding register.
*/
template<typename T>
Modbus_Hreg<T>::Modbus_Hreg(T* server, int address, int value, const char* description)
: Modbus_Point<T>(server, address, value, description) {}

View File

@@ -25,7 +25,7 @@ class Modbus_Ireg : public Modbus_Point<T>{
public:
/**
* @brief Constructor for the Modbus_Ireg class.
* @param server Pointer to the ModbusIP server instance.
* @param server Pointer to the Modbus server instance (e.g., ModbusIP, ModbusRTU).
* @param address The Modbus address of the input register.
* @param value The initial value of the input register.
* @param description A description of the input register.
@@ -48,7 +48,13 @@ public:
*/
int getValue() const override;
};
/**
* @brief Constructor for the Modbus_Ireg class.
* @param server Pointer to the Modbus server instance (e.g., ModbusIP, ModbusRTU).
* @param address The Modbus address of the holding register.
* @param value The initial value of the holding register.
* @param description A description of the holding register.
*/
template<typename T>
Modbus_Ireg<T>::Modbus_Ireg(T* server, int address, int value, const char* description)
: Modbus_Point<T>(server, address, value, description){}

View File

@@ -25,7 +25,7 @@ class Modbus_Ists : public Modbus_Point<T>{
public:
/**
* @brief Constructor for the Modbus_Ists class.
* @param server Pointer to the ModbusIP server instance.
* @param server Pointer to the Modbus server instance (e.g., ModbusIP, ModbusRTU).
* @param address The Modbus address of the discrete input.
* @param value The initial value of the discrete input.
* @param description A description of the discrete input.
@@ -49,7 +49,13 @@ public:
int getValue() const override;
};
/**
* @brief Constructor for the Modbus_Ists class.
* @param server Pointer to the Modbus server instance (e.g., ModbusIP, ModbusRTU).
* @param address The Modbus address of the holding register.
* @param value The initial value of the holding register.
* @param description A description of the holding register.
*/
template<typename T>
Modbus_Ists<T>::Modbus_Ists(T* server, int address, int value, const char* description)
: Modbus_Point<T>(server, address, value, description) {}