Skip to content

Commit

Permalink
AutoBuildDocumentation
Browse files Browse the repository at this point in the history
  • Loading branch information
wellfiredbuildmachine committed Jan 16, 2018
1 parent 6d3cfa0 commit f1e5a1b
Show file tree
Hide file tree
Showing 4 changed files with 42 additions and 11 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -10,29 +10,35 @@ Description



Public Static Methods
----------------------
Public Methods
---------------

+-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|string |:ref:`ConvertToJson<classwellfired_profile_profileprocessor_node_nodeconverter_1ae25c530df27e58b504083226bad50087>` **(** :ref:`INode<interfacewellfired_profile_profileprocessor_node_inode>` node, bool singleLine = false **)** |
| |:ref:`NodeConverter<classwellfired_profile_profileprocessor_node_nodeconverter_1a3752a6bdf8fd58922e55981621ab8853>` **(** **)** |
+-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|string |:ref:`ConvertRecordsTo<classwellfired_profile_profileprocessor_node_nodeconverter_1a96d1cfb1c086a816853e14c28bbc0305>` **(** IEnumerable< :ref:`TimeValueTable<classwellfired_profile_data_continousdata_timevaluetable>` > timeValueTables **)** |
|string |:ref:`ConvertToJson<classwellfired_profile_profileprocessor_node_nodeconverter_1a95d71d011e85e7e7828a185753d36cb8>` **(** :ref:`INode<interfacewellfired_profile_profileprocessor_node_inode>` node, bool singleLine = false **)** |
+-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|:ref:`INode<interfacewellfired_profile_profileprocessor_node_inode>` |:ref:`ConvertToArrayNode<classwellfired_profile_profileprocessor_node_nodeconverter_1ad68a19dae3029290adce86ff051604bb>` **(** :ref:`TimeValueTable<classwellfired_profile_data_continousdata_timevaluetable>` timeValueTable **)** |
|string |:ref:`ConvertRecordsTo<classwellfired_profile_profileprocessor_node_nodeconverter_1a753b4bc48d79c2b6ce8b9a9bd28e99b3>` **(** IEnumerable< :ref:`TimeValueTable<classwellfired_profile_data_continousdata_timevaluetable>` > timeValueTables **)** |
+-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|:ref:`INode<interfacewellfired_profile_profileprocessor_node_inode>` |:ref:`ConvertToArrayNode<classwellfired_profile_profileprocessor_node_nodeconverter_1a60fb210d8878e871fb47aae86e9f542f>` **(** :ref:`TimeValueTable<classwellfired_profile_data_continousdata_timevaluetable>` timeValueTable **)** |
+-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Breakdown
----------

.. _classwellfired_profile_profileprocessor_node_nodeconverter_1ae25c530df27e58b504083226bad50087:
.. _classwellfired_profile_profileprocessor_node_nodeconverter_1a3752a6bdf8fd58922e55981621ab8853:

- **NodeConverter** **(** **)**

.. _classwellfired_profile_profileprocessor_node_nodeconverter_1a95d71d011e85e7e7828a185753d36cb8:

- string **ConvertToJson** **(** :ref:`INode<interfacewellfired_profile_profileprocessor_node_inode>` node, bool singleLine = false **)**

.. _classwellfired_profile_profileprocessor_node_nodeconverter_1a96d1cfb1c086a816853e14c28bbc0305:
.. _classwellfired_profile_profileprocessor_node_nodeconverter_1a753b4bc48d79c2b6ce8b9a9bd28e99b3:

- string **ConvertRecordsTo** **(** IEnumerable< :ref:`TimeValueTable<classwellfired_profile_data_continousdata_timevaluetable>` > timeValueTables **)**

.. _classwellfired_profile_profileprocessor_node_nodeconverter_1ad68a19dae3029290adce86ff051604bb:
.. _classwellfired_profile_profileprocessor_node_nodeconverter_1a60fb210d8878e871fb47aae86e9f542f:

- :ref:`INode<interfacewellfired_profile_profileprocessor_node_inode>` **ConvertToArrayNode** **(** :ref:`TimeValueTable<classwellfired_profile_data_continousdata_timevaluetable>` timeValueTable **)**

Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Public Methods
+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|void |:ref:`DrawVerticalLine<classwellfired_profile_profileprocessor_visual_graph_graphcanvasdrawer_1a839fb77ac892cece5a3ccbf3bf73b4a2>` **(** float scaleXInSec, float intervalInSec **)** |
+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|void |:ref:`DrawHorizontalLine<classwellfired_profile_profileprocessor_visual_graph_graphcanvasdrawer_1a9e6d87827fdd60eae612f06e368c3780>` **(** float scaleY, float interval **)** |
|void |:ref:`DrawHorizontalLine<classwellfired_profile_profileprocessor_visual_graph_graphcanvasdrawer_1a2ba0afc0010a09097ba64314f7b34e99>` **(** float scaleY, float originY, float interval **)** |
+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Breakdown
Expand All @@ -32,7 +32,7 @@ Breakdown

- void **DrawVerticalLine** **(** float scaleXInSec, float intervalInSec **)**

.. _classwellfired_profile_profileprocessor_visual_graph_graphcanvasdrawer_1a9e6d87827fdd60eae612f06e368c3780:
.. _classwellfired_profile_profileprocessor_visual_graph_graphcanvasdrawer_1a2ba0afc0010a09097ba64314f7b34e99:

- void **DrawHorizontalLine** **(** float scaleY, float interval **)**
- void **DrawHorizontalLine** **(** float scaleY, float originY, float interval **)**

Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ Public Properties
+-------------+-------------------------------------------------------------------------------------------------------------------------------+
|float |:ref:`ScaleY<classwellfired_profile_profileprocessor_visual_graph_graphconfig_1a7271a9c8aaf2709cd41f70a4460a9e43>` |
+-------------+-------------------------------------------------------------------------------------------------------------------------------+
|float |:ref:`OriginY<classwellfired_profile_profileprocessor_visual_graph_graphconfig_1adeae7da2f07ee32b1e33358228807d69>` |
+-------------+-------------------------------------------------------------------------------------------------------------------------------+
|float |:ref:`MarkerXInterval<classwellfired_profile_profileprocessor_visual_graph_graphconfig_1ad81c418d26b0e5a0cf98e2b510520e95>` |
+-------------+-------------------------------------------------------------------------------------------------------------------------------+
|float |:ref:`MarkerYInterval<classwellfired_profile_profileprocessor_visual_graph_graphconfig_1a42fa5821950790a788ed3cfa924a339a>` |
Expand Down Expand Up @@ -46,6 +48,14 @@ Breakdown

Number of unity that should be displayed on the Y axis. Starting from 0.

.. _classwellfired_profile_profileprocessor_visual_graph_graphconfig_1adeae7da2f07ee32b1e33358228807d69:

- float **OriginY**

**Description**

The value on Y axes at the graph origin. To visualize values between 450 and 400 you would set :ref:`ScaleY<classwellfired_profile_profileprocessor_visual_graph_graphconfig_1a7271a9c8aaf2709cd41f70a4460a9e43>` to 50, and :ref:`OriginY<classwellfired_profile_profileprocessor_visual_graph_graphconfig_1adeae7da2f07ee32b1e33358228807d69>` to 450.

.. _classwellfired_profile_profileprocessor_visual_graph_graphconfig_1ad81c418d26b0e5a0cf98e2b510520e95:

- float **MarkerXInterval**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,13 @@ Description

A custom processor that has a visual representation

Properties
-----------

+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|:ref:`GraphConfig<classwellfired_profile_profileprocessor_visual_graph_graphconfig>` |:ref:`GraphConfig<classwellfired_profile_profileprocessor_visualprocessor_1ac2bcb42858c86bd08d27b1cd6f4092f1>` **{** get; set; **}** |
+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+

Public Methods
---------------

Expand All @@ -37,6 +44,14 @@ Public Methods
Breakdown
----------

.. _classwellfired_profile_profileprocessor_visualprocessor_1ac2bcb42858c86bd08d27b1cd6f4092f1:

- :ref:`GraphConfig<classwellfired_profile_profileprocessor_visual_graph_graphconfig>` **GraphConfig** **{** get; set; **}**

**Description**

This gives you access to the different parameters to configure your graph. Note that once your .:ref:`Profile<namespacewellfired_profile>` session started, any modification to the graph config won't have any impact.

.. _classwellfired_profile_profileprocessor_visualprocessor_1ab458270b1bf70ea3e92a4bde57b3bcbc:

- **VisualProcessor** **(** Func< bool > toggleUIFunc, IEnumerable< Type > additionalProbeTypesToProbeToGraph **)**
Expand Down

0 comments on commit f1e5a1b

Please sign in to comment.