Skip to content

Commit

Permalink
docs: Update Doxygen documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@actions-user
actions-user committed Dec 13, 2024
1 parent 5e4c5cb commit b41722e
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 32 deletions.
30 changes: 14 additions & 16 deletions html/_hardware_generation_8cs_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -190,29 +190,27 @@
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span> var plcNwItf = module.ParentDeviceAsHardwareInfo.ControllerProfinetInterfaces.First();</div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span> plcNwItf.ConnectedSubnetInfo = subnet;</div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span> </div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span> <span class="keywordflow">if</span> (device.GetType() == typeof(S120PNDriveInfo))</div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span> {</div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span> (device as S120PNDriveInfo).ProfinetInterface.ConnectedSubnetInfo = subnet;</div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span> var ioSystem = plcNwItf.ConnectedSubnetInfo.GetOrCreateIoSystem(plcNwItf, <span class="stringliteral">&quot;NewIoSystem&quot;</span>);</div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span> ioSystem.ConnectIoDevice((device as S120PNDriveInfo).ProfinetInterface.IoConnectors.First().Value);</div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span> </div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span> var ioSystem = plcNwItf.ConnectedSubnetInfo.GetOrCreateIoSystem(plcNwItf, <span class="stringliteral">&quot;PROFINET IO-System&quot;</span>);</div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span> </div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span> <span class="keywordflow">if</span> (device.GetType() == typeof(S120PNDriveInfo))</div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span> {</div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span> (device as S120PNDriveInfo).ProfinetInterface.ConnectedSubnetInfo = subnet;</div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span> ioSystem.ConnectIoDevice((device as S120PNDriveInfo).ProfinetInterface.IoConnectors.First().Value);</div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span> plcNwItf.Ports.First().Connect((device as S120PNDriveInfo).ProfinetInterface.Ports.First());</div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span> }</div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span> <span class="keywordflow">if</span> (device.GetType() == typeof(S210DriveInfo))</div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"> 131</span> {</div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span> (device as S210DriveInfo).ProfinetInterface.ConnectedSubnetInfo = subnet;</div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span> var ioSystem = plcNwItf.ConnectedSubnetInfo.GetOrCreateIoSystem(plcNwItf, <span class="stringliteral">&quot;NewIoSystem&quot;</span>);</div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span> ioSystem.ConnectIoDevice((device as S210DriveInfo).ProfinetInterface.IoConnectors.First().Value);</div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span> </div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"> 136</span> plcNwItf.Ports.First().Connect((device as S210DriveInfo).ProfinetInterface.Ports.First());</div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span> }</div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span> </div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span> </div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno"> 140</span> }</div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span> ioSystem.ConnectIoDevice((device as S210DriveInfo).ProfinetInterface.IoConnectors.First().Value);</div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span> plcNwItf.Ports.First().Connect((device as S210DriveInfo).ProfinetInterface.Ports.First());</div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span> }</div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"> 136</span> </div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span> </div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span> }</div>
</div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno"> 141</span> }</div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span> }</div>
</div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno"> 142</span>}</div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno"> 140</span>}</div>
<div class="ttc" id="aclass_m_a_c__use__cases_1_1_model_1_1_m_a_c__use__cases_e_m_html"><div class="ttname"><a href="class_m_a_c__use__cases_1_1_model_1_1_m_a_c__use__cases_e_m.html">MAC_use_cases.Model.MAC_use_casesEM</a></div><div class="ttdoc">This is the main class in which the workflow starts. Here are all sections for creating or generating...</div><div class="ttdef"><b>Definition</b> <a href="_m_a_c__use__cases_e_m_8cs_source.html#l00021">MAC_use_casesEM.cs:22</a></div></div>
<div class="ttc" id="aclass_m_a_c__use__cases_1_1_model_1_1_use_cases_1_1_hardware_generation_html"><div class="ttname"><a href="class_m_a_c__use__cases_1_1_model_1_1_use_cases_1_1_hardware_generation.html">MAC_use_cases.Model.UseCases.HardwareGeneration</a></div><div class="ttdoc">All the functions to configure and generate Hardware are defined here.</div><div class="ttdef"><b>Definition</b> <a href="#l00015">HardwareGeneration.cs:16</a></div></div>
<div class="ttc" id="aclass_m_a_c__use__cases_1_1_model_1_1_use_cases_1_1_hardware_generation_html_a782897c3d537e943b5d7a1dfb57c812d"><div class="ttname"><a href="class_m_a_c__use__cases_1_1_model_1_1_use_cases_1_1_hardware_generation.html#a782897c3d537e943b5d7a1dfb57c812d">MAC_use_cases.Model.UseCases.HardwareGeneration.GenerateS210</a></div><div class="ttdeci">static S210DriveInfo GenerateS210(MAC_use_casesEM module, string name, string deviceName, string path=null, string comment=null)</div><div class="ttdoc">This function generates an S210 Drive based on a MasterCopy.</div><div class="ttdef"><b>Definition</b> <a href="#l00060">HardwareGeneration.cs:60</a></div></div>
Expand Down
2 changes: 1 addition & 1 deletion html/_m_a_c__use__cases_e_m_8cs_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,7 @@
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span> var s120 = <a class="code hl_class" href="class_m_a_c__use__cases_1_1_model_1_1_use_cases_1_1_hardware_generation.html">HardwareGeneration</a>.<a class="code hl_function" href="class_m_a_c__use__cases_1_1_model_1_1_use_cases_1_1_hardware_generation.html#a7d5006c4913789ae5058a3e5509d0203">GenerateS120</a>(<span class="keyword">this</span>, <span class="stringliteral">&quot;S120MACTest&quot;</span>, <span class="stringliteral">&quot;S120DeviceTest&quot;</span>, <span class="stringliteral">&quot;this drive is generated with MAC&quot;</span>);</div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span> </div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span> var s210 = <a class="code hl_class" href="class_m_a_c__use__cases_1_1_model_1_1_use_cases_1_1_hardware_generation.html">HardwareGeneration</a>.<a class="code hl_function" href="class_m_a_c__use__cases_1_1_model_1_1_use_cases_1_1_hardware_generation.html#a782897c3d537e943b5d7a1dfb57c812d">GenerateS210</a>(<span class="keyword">this</span>, <span class="stringliteral">&quot;S210MACTest&quot;</span>, <span class="stringliteral">&quot;S210DeviceTest&quot;</span>, <span class="stringliteral">&quot;this drive is generated with MAC&quot;</span>);</div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span> var subnet1 = <a class="code hl_class" href="class_m_a_c__use__cases_1_1_model_1_1_use_cases_1_1_hardware_generation.html">HardwareGeneration</a>.<a class="code hl_function" href="class_m_a_c__use__cases_1_1_model_1_1_use_cases_1_1_hardware_generation.html#af53a3919d93de83d94c0b58213a9339d">GetOrCreateSubnet</a>(SubnetsManager, <span class="stringliteral">&quot;NewSubnet1&quot;</span>);</div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span> var subnet1 = <a class="code hl_class" href="class_m_a_c__use__cases_1_1_model_1_1_use_cases_1_1_hardware_generation.html">HardwareGeneration</a>.<a class="code hl_function" href="class_m_a_c__use__cases_1_1_model_1_1_use_cases_1_1_hardware_generation.html#af53a3919d93de83d94c0b58213a9339d">GetOrCreateSubnet</a>(SubnetsManager, <span class="stringliteral">&quot;PN/IE_1&quot;</span>);</div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span> </div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span> <a class="code hl_class" href="class_m_a_c__use__cases_1_1_model_1_1_use_cases_1_1_hardware_generation.html">HardwareGeneration</a>.<a class="code hl_function" href="class_m_a_c__use__cases_1_1_model_1_1_use_cases_1_1_hardware_generation.html#abe88e524c8380dba5f0829ec093461e2">ConnectDriveToSubnet</a>(s120, subnet1, <span class="keyword">this</span>);</div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span> <a class="code hl_class" href="class_m_a_c__use__cases_1_1_model_1_1_use_cases_1_1_hardware_generation.html">HardwareGeneration</a>.<a class="code hl_function" href="class_m_a_c__use__cases_1_1_model_1_1_use_cases_1_1_hardware_generation.html#abe88e524c8380dba5f0829ec093461e2">ConnectDriveToSubnet</a>(s210, subnet1, <span class="keyword">this</span>);</div>
Expand Down
2 changes: 1 addition & 1 deletion html/class_m_a_c__use__cases_1_1_model_1_1_m_a_c__use__cases_e_m.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -321,7 +321,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a634a94b6139346c4b87da9ed
<div class="line"><span class="lineno"> 117</span> var s120 = <a class="code hl_class" href="class_m_a_c__use__cases_1_1_model_1_1_use_cases_1_1_hardware_generation.html">HardwareGeneration</a>.<a class="code hl_function" href="class_m_a_c__use__cases_1_1_model_1_1_use_cases_1_1_hardware_generation.html#a7d5006c4913789ae5058a3e5509d0203">GenerateS120</a>(<span class="keyword">this</span>, <span class="stringliteral">&quot;S120MACTest&quot;</span>, <span class="stringliteral">&quot;S120DeviceTest&quot;</span>, <span class="stringliteral">&quot;this drive is generated with MAC&quot;</span>);</div>
<div class="line"><span class="lineno"> 118</span> </div>
<div class="line"><span class="lineno"> 119</span> var s210 = <a class="code hl_class" href="class_m_a_c__use__cases_1_1_model_1_1_use_cases_1_1_hardware_generation.html">HardwareGeneration</a>.<a class="code hl_function" href="class_m_a_c__use__cases_1_1_model_1_1_use_cases_1_1_hardware_generation.html#a782897c3d537e943b5d7a1dfb57c812d">GenerateS210</a>(<span class="keyword">this</span>, <span class="stringliteral">&quot;S210MACTest&quot;</span>, <span class="stringliteral">&quot;S210DeviceTest&quot;</span>, <span class="stringliteral">&quot;this drive is generated with MAC&quot;</span>);</div>
<div class="line"><span class="lineno"> 120</span> var subnet1 = <a class="code hl_class" href="class_m_a_c__use__cases_1_1_model_1_1_use_cases_1_1_hardware_generation.html">HardwareGeneration</a>.<a class="code hl_function" href="class_m_a_c__use__cases_1_1_model_1_1_use_cases_1_1_hardware_generation.html#af53a3919d93de83d94c0b58213a9339d">GetOrCreateSubnet</a>(SubnetsManager, <span class="stringliteral">&quot;NewSubnet1&quot;</span>);</div>
<div class="line"><span class="lineno"> 120</span> var subnet1 = <a class="code hl_class" href="class_m_a_c__use__cases_1_1_model_1_1_use_cases_1_1_hardware_generation.html">HardwareGeneration</a>.<a class="code hl_function" href="class_m_a_c__use__cases_1_1_model_1_1_use_cases_1_1_hardware_generation.html#af53a3919d93de83d94c0b58213a9339d">GetOrCreateSubnet</a>(SubnetsManager, <span class="stringliteral">&quot;PN/IE_1&quot;</span>);</div>
<div class="line"><span class="lineno"> 121</span> </div>
<div class="line"><span class="lineno"> 122</span> <a class="code hl_class" href="class_m_a_c__use__cases_1_1_model_1_1_use_cases_1_1_hardware_generation.html">HardwareGeneration</a>.<a class="code hl_function" href="class_m_a_c__use__cases_1_1_model_1_1_use_cases_1_1_hardware_generation.html#abe88e524c8380dba5f0829ec093461e2">ConnectDriveToSubnet</a>(s120, subnet1, <span class="keyword">this</span>);</div>
<div class="line"><span class="lineno"> 123</span> <a class="code hl_class" href="class_m_a_c__use__cases_1_1_model_1_1_use_cases_1_1_hardware_generation.html">HardwareGeneration</a>.<a class="code hl_function" href="class_m_a_c__use__cases_1_1_model_1_1_use_cases_1_1_hardware_generation.html#abe88e524c8380dba5f0829ec093461e2">ConnectDriveToSubnet</a>(s210, subnet1, <span class="keyword">this</span>);</div>
Expand Down
26 changes: 12 additions & 14 deletions html/class_m_a_c__use__cases_1_1_model_1_1_use_cases_1_1_hardware_generation.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -440,25 +440,23 @@ <h2 class="memtitle"><span class="permalink"><a href="#abe88e524c8380dba5f0829ec
<div class="line"><span class="lineno"> 119</span> var plcNwItf = module.ParentDeviceAsHardwareInfo.ControllerProfinetInterfaces.First();</div>
<div class="line"><span class="lineno"> 120</span> plcNwItf.ConnectedSubnetInfo = subnet;</div>
<div class="line"><span class="lineno"> 121</span> </div>
<div class="line"><span class="lineno"> 122</span> <span class="keywordflow">if</span> (device.GetType() == typeof(S120PNDriveInfo))</div>
<div class="line"><span class="lineno"> 123</span> {</div>
<div class="line"><span class="lineno"> 124</span> (device as S120PNDriveInfo).ProfinetInterface.ConnectedSubnetInfo = subnet;</div>
<div class="line"><span class="lineno"> 125</span> var ioSystem = plcNwItf.ConnectedSubnetInfo.GetOrCreateIoSystem(plcNwItf, <span class="stringliteral">&quot;NewIoSystem&quot;</span>);</div>
<div class="line"><span class="lineno"> 126</span> ioSystem.ConnectIoDevice((device as S120PNDriveInfo).ProfinetInterface.IoConnectors.First().Value);</div>
<div class="line"><span class="lineno"> 127</span> </div>
<div class="line"><span class="lineno"> 122</span> var ioSystem = plcNwItf.ConnectedSubnetInfo.GetOrCreateIoSystem(plcNwItf, <span class="stringliteral">&quot;PROFINET IO-System&quot;</span>);</div>
<div class="line"><span class="lineno"> 123</span> </div>
<div class="line"><span class="lineno"> 124</span> <span class="keywordflow">if</span> (device.GetType() == typeof(S120PNDriveInfo))</div>
<div class="line"><span class="lineno"> 125</span> {</div>
<div class="line"><span class="lineno"> 126</span> (device as S120PNDriveInfo).ProfinetInterface.ConnectedSubnetInfo = subnet;</div>
<div class="line"><span class="lineno"> 127</span> ioSystem.ConnectIoDevice((device as S120PNDriveInfo).ProfinetInterface.IoConnectors.First().Value);</div>
<div class="line"><span class="lineno"> 128</span> plcNwItf.Ports.First().Connect((device as S120PNDriveInfo).ProfinetInterface.Ports.First());</div>
<div class="line"><span class="lineno"> 129</span> }</div>
<div class="line"><span class="lineno"> 130</span> <span class="keywordflow">if</span> (device.GetType() == typeof(S210DriveInfo))</div>
<div class="line"><span class="lineno"> 131</span> {</div>
<div class="line"><span class="lineno"> 132</span> (device as S210DriveInfo).ProfinetInterface.ConnectedSubnetInfo = subnet;</div>
<div class="line"><span class="lineno"> 133</span> var ioSystem = plcNwItf.ConnectedSubnetInfo.GetOrCreateIoSystem(plcNwItf, <span class="stringliteral">&quot;NewIoSystem&quot;</span>);</div>
<div class="line"><span class="lineno"> 134</span> ioSystem.ConnectIoDevice((device as S210DriveInfo).ProfinetInterface.IoConnectors.First().Value);</div>
<div class="line"><span class="lineno"> 135</span> </div>
<div class="line"><span class="lineno"> 136</span> plcNwItf.Ports.First().Connect((device as S210DriveInfo).ProfinetInterface.Ports.First());</div>
<div class="line"><span class="lineno"> 137</span> }</div>
<div class="line"><span class="lineno"> 138</span> </div>
<div class="line"><span class="lineno"> 139</span> </div>
<div class="line"><span class="lineno"> 140</span> }</div>
<div class="line"><span class="lineno"> 133</span> ioSystem.ConnectIoDevice((device as S210DriveInfo).ProfinetInterface.IoConnectors.First().Value);</div>
<div class="line"><span class="lineno"> 134</span> plcNwItf.Ports.First().Connect((device as S210DriveInfo).ProfinetInterface.Ports.First());</div>
<div class="line"><span class="lineno"> 135</span> }</div>
<div class="line"><span class="lineno"> 136</span> </div>
<div class="line"><span class="lineno"> 137</span> </div>
<div class="line"><span class="lineno"> 138</span> }</div>
</div><!-- fragment -->
</div>
</div>
Expand Down

0 comments on commit b41722e

Please sign in to comment.