Index: sources/model/MAbstract.h =================================================================== diff -u -r00d9bb06ec2bad14f6dc2db678b750c244f694ef -r6aea3fd1baa6992d6eba9938599374f615649fab --- sources/model/MAbstract.h (.../MAbstract.h) (revision 00d9bb06ec2bad14f6dc2db678b750c244f694ef) +++ sources/model/MAbstract.h (.../MAbstract.h) (revision 6aea3fd1baa6992d6eba9938599374f615649fab) @@ -53,15 +53,41 @@ }; public: - // the model needs to implement these since each model have different meaning of the bytes from different source(unit). + + /*! + * \brief fromByteArray + * \details converts the values from Byte Arrays to the Model data. + * \param vByteArray - the byte array input + * \param vIndex - current index of each data section in byte array + * \return true on successful conversion + */ virtual bool fromByteArray(const QByteArray &vByteArray , int *vIndex = nullptr) = 0; + /*! + * \brief typeText + * \details type of the model which can be Data or Event which is mostly used in logging. + * \return Enum of Types + */ virtual Type_Enum typeText ( ) const = 0; + /*! + * \brief unitText + * \details the unit which UI communicates with by using this model and is used in Logging mostly + * \return Enum of Units + */ virtual Unit_Enum unitText ( ) const = 0; + /*! + * \brief infoText + * \details the text description of the model which will be used in the logging. + * \return QString + */ virtual QString infoText ( ) const = 0; + /*! + * \brief parameters + * \return current data values of the models. + */ virtual QVariantList parameters ( ) const = 0; - // Non-virtuals which working with parameters virtual method. + // Non-virtual methods which working with parameters virtual method. void toVariantList(QVariantList &vData) const; QString toString ( ) const; QString description ( ) const;