Api documentation by wsobel · Pull Request #249 · mtconnect/cppagent_dev

wsobel · 2023-02-09T20:22:21Z

Added API documentation to most of the classes in the agent lib.
Still need to document MQTT and Ruby classes
Primarily to support plugins that provide sinks, sources, and transforms.

rajwork9

Hello Will,

found very minor spell checks... you can skip these changes as well.

Thank you,

rajwork9 · 2023-02-10T17:47:11Z

src/mtconnect/asset/asset_storage.hpp

      virtual AssetPtr getAsset(const std::string &id) const = 0;
+      /// @brief get a list of assets with optional filters
+      /// @param[out] list returned list of assets
+      /// @param[in] max maximum number of assets to dind


it's find? may be typo issue...at line 104

rajwork9 · 2023-02-10T23:04:57Z

src/mtconnect/buffer/circular_buffer.hpp

    }

-    auto getIndexAt(uint64_t at) { return at - m_firstSequence; }
+    /// @brief get index into underlying curcular buffer at a sequence number


spell check: circular buffer

rajwork9 · 2023-02-10T23:06:34Z

src/mtconnect/buffer/circular_buffer.hpp

-
+    ///@}
+
+    /// @brief Get a list of observations from the curcular buffer


spell check: Circular

rajwork9 · 2023-02-10T23:09:02Z

src/mtconnect/configuration/agent_config.hpp

+      /// @brief get a pointer to the async io manager
      auto &getAsyncContext() { return *m_context.get(); }

+      /// @brief sets the path for the working directory to the crrent path


spell check: current

rajwork9 · 2023-02-10T23:09:58Z

src/mtconnect/configuration/agent_config.hpp

+      /// @return log archive pattern
      const auto &getLogArchivePattern() const { return m_logArchivePattern; }
+      /// @brief Get the maximum size of all the log files
+      /// @return the maxumum size of all log files


spell check: maximum

rajwork9 · 2023-02-10T23:27:32Z

src/mtconnect/device_model/component.hpp

        m_uuid = uuid;
        setProperty("uuid", uuid);
      }
+      /// @brief set the compoent name property, not the compoent type


spell check: component

rajwork9 · 2023-02-10T23:36:01Z

src/mtconnect/device_model/device.hpp


+  /// @brief Namespace for all Device Model Related entities
  namespace device_model {
+    /// @brief Compenent entity representing a `Device`


spell check: component

rajwork9 · 2023-02-11T00:00:29Z

src/mtconnect/observation/change_observer.hpp

+namespace mtconnect::observation {
+  class ChangeSignaler;
+
+  /// @brief A class to observe a data item and singal when data changes


spell check: signal

rajwork9 · 2023-02-11T00:12:20Z

src/mtconnect/pipeline/period_filter.hpp

+      else
+      {
+        // If this observation is after the period has expired and there
+        // is an existing obsrvation, then we send the last observation.


spell check: Observation

wsobel · 2023-02-11T00:16:51Z

Please correct in a branch. Tracking down a few problems around the mqtt isolation test failing on windows.

…

On Feb 10, 2023, at 16:15, rajwork9 ***@***.***> wrote: @rajwork9 commented on this pull request. Hello Will, found very minor spell checks... you can skip these changes as well. Thank you, In src/mtconnect/asset/asset_storage.hpp <#249 (comment)>: > virtual AssetPtr getAsset(const std::string &id) const = 0; + /// @brief get a list of assets with optional filters + /// @param[out] list returned list of assets + /// @param[in] max maximum number of assets to dind it's find? may be typo issue...at line 104 In src/mtconnect/buffer/circular_buffer.hpp <#249 (comment)>: > @@ -55,14 +62,24 @@ namespace mtconnect::buffer { return observation::ObservationPtr(); } - auto getIndexAt(uint64_t at) { return at - m_firstSequence; } + /// @brief get index into underlying curcular buffer at a sequence number spell check: circular buffer In src/mtconnect/buffer/circular_buffer.hpp <#249 (comment)>: > @@ -184,11 +223,21 @@ namespace mtconnect::buffer { return check; } - + ///@} + + /// @brief Get a list of observations from the curcular buffer spell check: Circular In src/mtconnect/configuration/agent_config.hpp <#249 (comment)>: > auto &getAsyncContext() { return *m_context.get(); } + /// @brief sets the path for the working directory to the crrent path spell check: current In src/mtconnect/configuration/agent_config.hpp <#249 (comment)>: > const auto &getLogArchivePattern() const { return m_logArchivePattern; } + /// @brief Get the maximum size of all the log files + /// @return the maxumum size of all log files spell check: maximum In src/mtconnect/device_model/component.hpp <#249 (comment)>: > void setUuid(const std::string &uuid) { m_uuid = uuid; setProperty("uuid", uuid); } + /// @brief set the compoent name property, not the compoent type spell check: component In src/mtconnect/device_model/device.hpp <#249 (comment)>: > namespace device_model { + /// @brief Compenent entity representing a `Device` spell check: component In src/mtconnect/observation/change_observer.hpp <#249 (comment)>: > @@ -27,85 +27,107 @@ #include "mtconnect/config.hpp" #include "mtconnect/utilities.hpp" -namespace mtconnect { - namespace observation { - class ChangeSignaler; - class AGENT_LIB_API ChangeObserver +namespace mtconnect::observation { + class ChangeSignaler; + + /// @brief A class to observe a data item and singal when data changes spell check: signal In src/mtconnect/pipeline/period_filter.hpp <#249 (comment)>: > - // The observations will be swapped, so send the last onward. - return false; - } - else + // The observations will be swapped, so send the last onward. + return false; + } + else + { + // If this observation is after the period has expired and there + // is an existing obsrvation, then we send the last observation. spell check: Observation — Reply to this email directly, view it on GitHub <#249 (review)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAJ6BCIOVXRRZFDKBHYRY4DWW3KZ3ANCNFSM6AAAAAAUW73DBM>. You are receiving this because you modified the open/close state.

wsobel · 2023-02-11T01:19:28Z

Will fix it in the current branch I'm working on for the config and mqtt test issues

wsobel · 2023-02-11T01:25:53Z

fixed in branch fix_debug_build_in_windows.

Thanks a lot for finding the errors!

wsobel added 19 commits January 30, 2023 23:53

Added docs to agent.hpp

c87a6ce

initial documentation and config

f79063c

Documented some utility functions and began on pipelines

f11242b

Run doxygen via cmake

f929aec

Added documentation and cmake updated doxygen config

ac482f6

documented configuration

fd5db36

documented requirements

0356fd9

documented factory

62f3bb2

Added doxygen to conan as a tool requirement

1c47907

maked doxygen as a tool req only if not alrady installed

2765cee

Changed color style to auto dark

9ff7146

finished buffer and entity

baa55ad

Added asset storage

2795124

Checkpoint documentation

1345bd0

Finished documenting device model, observations, and pipelines

599f18e

Added printers

f77cf0b

Documented the REST sink

197a797

Completed first set of API documentatoin

85866d1

Made doxygen doc generation optional

13ede18

wsobel requested review from rajwork9 and simonyg February 9, 2023 20:22

simonyg approved these changes Feb 10, 2023

View reviewed changes

wsobel merged commit 47fabfd into master Feb 10, 2023

wsobel deleted the api_documentation branch February 10, 2023 04:03

rajwork9 reviewed Feb 11, 2023

View reviewed changes


		///@}

		/// @brief Get a list of observations from the curcular buffer

Conversation

wsobel commented Feb 9, 2023

Uh oh!

rajwork9 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wsobel commented Feb 11, 2023 via email

Uh oh!

wsobel commented Feb 11, 2023

Uh oh!

wsobel commented Feb 11, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants