Skip to content

Commit

Permalink
deploy: 63fd2f3
Browse files Browse the repository at this point in the history
  • Loading branch information
@glopesdev
glopesdev committed Mar 4, 2024
0 parents commit 1222874
Show file tree
Hide file tree
Showing 207 changed files with 20,942 additions and 0 deletions.
Empty file added .nojekyll
Empty file.
258 changes: 258 additions & 0 deletions api/Bonsai.PulsePal.BiphasicConfiguration.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,258 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class BiphasicConfiguration | Bonsai.PulsePal </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class BiphasicConfiguration | Bonsai.PulsePal ">

<meta name="description" content="Represents configuration parameters specifying whether the channel will produce either monophasic or biphasic square pulses.">
<link rel="icon" href="../favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
<meta name="docfx:navrel" content="../toc.html">
<meta name="docfx:tocrel" content="toc.html">

<meta name="docfx:rel" content="../">


<meta name="docfx:docurl" content="https://github.com/bonsai-rx/pulsepal/new/main/docs/apidoc/new?filename=Bonsai_PulsePal_BiphasicConfiguration.md&amp;value=---%0Auid%3A%20Bonsai.PulsePal.BiphasicConfiguration%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">
<meta name="loc:inThisArticle" content="In this article">
<meta name="loc:searchResultsCount" content="{count} results for &quot;{query}&quot;">
<meta name="loc:searchNoResults" content="No results for &quot;{query}&quot;">
<meta name="loc:tocFilter" content="Filter by title">
<meta name="loc:nextArticle" content="Next">
<meta name="loc:prevArticle" content="Previous">
<meta name="loc:themeLight" content="Light">
<meta name="loc:themeDark" content="Dark">
<meta name="loc:themeAuto" content="Auto">
<meta name="loc:changeTheme" content="Change theme">
<meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF">
</head>

<script type="module" src="./../public/docfx.min.js"></script>

<script>
const theme = localStorage.getItem('theme') || 'auto'
document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
</script>


<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
<header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../logo.svg" alt="Bonsai - PulsePal">
Bonsai - PulsePal
</a>
<button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
<i class="bi bi-three-dots"></i>
</button>
<div class="collapse navbar-collapse" id="navpanel">
<div id="navbar">
<form class="search" role="search" id="search">
<i class="bi bi-search"></i>
<input class="form-control" id="search-query" type="search" disabled="" placeholder="Search" autocomplete="off" aria-label="Search">
</form>
</div>
</div>
</div>
</nav>
</header>

<main class="container-xxl">
<div class="toc-offcanvas">
<div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
<div class="offcanvas-header">
<h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
</div>
<div class="offcanvas-body">
<nav class="toc" id="toc"></nav>
</div>
</div>
</div>

<div class="content">
<div class="actionbar">
<button class="btn btn-lg border-0 d-md-none" style="margin-top: -.65em; margin-left: -.8em" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
<i class="bi bi-list"></i>
</button>

<nav id="breadcrumb"></nav>
</div>

<article data-uid="Bonsai.PulsePal.BiphasicConfiguration">



<h1 id="Bonsai_PulsePal_BiphasicConfiguration" data-uid="Bonsai.PulsePal.BiphasicConfiguration" class="text-break">
Class BiphasicConfiguration <a class="header-action link-secondary" title="View source" href="https://github.com/bonsai-rx/pulsepal/blob/main/src/Bonsai.PulsePal/Configuration/BiphasicConfiguration.cs/#L9"><i class="bi bi-code-slash"></i></a>
</h1>

<div class="facts text-secondary">
<dl><dt>Namespace</dt><dd><a class="xref" href="Bonsai.html">Bonsai</a>.<a class="xref" href="Bonsai.PulsePal.html">PulsePal</a></dd></dl>
<dl><dt>Assembly</dt><dd>Bonsai.PulsePal.dll</dd></dl>
</div>

<div class="markdown summary"><p>Represents configuration parameters specifying whether the channel
will produce either monophasic or biphasic square pulses.</p>
</div>
<div class="markdown conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class BiphasicConfiguration : OutputChannelParameterConfiguration</code></pre>
</div>




<dl class="typelist inheritance">
<dt>Inheritance</dt>
<dd>
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
<div><a class="xref" href="Bonsai.PulsePal.ChannelParameterConfiguration.html">ChannelParameterConfiguration</a></div>
<div><a class="xref" href="Bonsai.PulsePal.OutputChannelParameterConfiguration.html">OutputChannelParameterConfiguration</a></div>
<div><span class="xref">BiphasicConfiguration</span></div>
</dd>
</dl>



<dl class="typelist inheritedMembers">
<dt>Inherited Members</dt>
<dd>
<div>
<a class="xref" href="Bonsai.PulsePal.OutputChannelParameterConfiguration.html#Bonsai_PulsePal_OutputChannelParameterConfiguration_Channel">OutputChannelParameterConfiguration.Channel</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
</div>
</dd></dl>






<h2 class="section" id="properties">Properties
</h2>


<a id="Bonsai_PulsePal_BiphasicConfiguration_Biphasic_" data-uid="Bonsai.PulsePal.BiphasicConfiguration.Biphasic*"></a>

<h3 id="Bonsai_PulsePal_BiphasicConfiguration_Biphasic" data-uid="Bonsai.PulsePal.BiphasicConfiguration.Biphasic">
Biphasic
<a class="header-action link-secondary" title="View source" href="https://github.com/bonsai-rx/pulsepal/blob/main/src/Bonsai.PulsePal/Configuration/BiphasicConfiguration.cs/#L17"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Gets or sets a value specifying whether to use biphasic or
monophasic pulses.</p>
</div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool Biphasic { get; set; }</code></pre>
</div>





<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
</dl>








<h2 class="section" id="methods">Methods
</h2>


<a id="Bonsai_PulsePal_BiphasicConfiguration_Configure_" data-uid="Bonsai.PulsePal.BiphasicConfiguration.Configure*"></a>

<h3 id="Bonsai_PulsePal_BiphasicConfiguration_Configure_Bonsai_PulsePal_PulsePal_" data-uid="Bonsai.PulsePal.BiphasicConfiguration.Configure(Bonsai.PulsePal.PulsePal)">
Configure(PulsePal)
<a class="header-action link-secondary" title="View source" href="https://github.com/bonsai-rx/pulsepal/blob/main/src/Bonsai.PulsePal/Configuration/BiphasicConfiguration.cs/#L21"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Applies the channel parameter configuration to the specified
Pulse Pal device.</p>
</div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override void Configure(PulsePal device)</code></pre>
</div>

<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>device</code> <a class="xref" href="Bonsai.PulsePal.PulsePal.html">PulsePal</a></dt>
<dd><p>The Pulse Pal device to configure.</p>
</dd>
</dl>













</article>

<div class="contribution d-print-none">
<a href="https://github.com/bonsai-rx/pulsepal/blob/main/src/Bonsai.PulsePal/Configuration/BiphasicConfiguration.cs/#L9" class="edit-link">Edit this page</a>
</div>


</div>

<div class="affix">
<nav id="affix"></nav>
</div>
</main>

<div class="container-xxl search-results" id="search-results"></div>

<footer class="border-top text-secondary">
<div class="container-xxl">
<div class="flex-fill">
&copy; 2024 Bonsai Foundation CIC and Contributors. Made with <a href="https://dotnet.github.io/docfx">docfx</a>
</div>
</div>
</footer>
</body>
</html>
Loading

0 comments on commit 1222874

Please sign in to comment.