Skip to content

Commit

Permalink
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
deploy: 5df2dbf
Browse files Browse the repository at this point in the history
bruno-f-cruz committed Nov 8, 2024

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
0 parents commit ce0b3a7
Showing 532 changed files with 140,679 additions and 0 deletions.
Empty file added .nojekyll
Empty file.
166 changes: 166 additions & 0 deletions api/AllenNeuralDynamics.AindBehaviorServices.DataTypes.DataType.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,166 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Enum DataType </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Enum DataType ">


<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/AllenNeuralDynamics/Bonsai.AllenNeuralDynamics/new/main/docs/apidoc/new?filename=AllenNeuralDynamics_AindBehaviorServices_DataTypes_DataType.md&amp;value=---%0Auid%3A%20AllenNeuralDynamics.AindBehaviorServices.DataTypes.DataType%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="">

</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="AllenNeuralDynamics.AindBehaviorServices.DataTypes.DataType">




<h1 id="AllenNeuralDynamics_AindBehaviorServices_DataTypes_DataType" data-uid="AllenNeuralDynamics.AindBehaviorServices.DataTypes.DataType" class="text-break">
Enum DataType <a class="header-action link-secondary" title="View source" href="https://github.com/AllenNeuralDynamics/Bonsai.AllenNeuralDynamics/blob/main/src/AllenNeuralDynamics.AindBehaviorServices/AindBehaviorServicesDataTypes.cs/#L12"><i class="bi bi-code-slash"></i></a>
</h1>

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

<div class="markdown summary"></div>
<div class="markdown conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsonConverter(typeof(StringEnumConverter))]
public enum DataType</code></pre>
</div>









<h2 id="fields">Fields
</h2>
<dl class="parameters">
<dt id="AllenNeuralDynamics_AindBehaviorServices_DataTypes_DataType_Array"><code>[EnumMember(Value = &quot;array&quot;)]
Array = 4</code></dt>
<dd></dd>
<dt id="AllenNeuralDynamics_AindBehaviorServices_DataTypes_DataType_Boolean"><code>[EnumMember(Value = &quot;boolean&quot;)]
Boolean = 2</code></dt>
<dd></dd>
<dt id="AllenNeuralDynamics_AindBehaviorServices_DataTypes_DataType_Null"><code>[EnumMember(Value = &quot;null&quot;)]
Null = 5</code></dt>
<dd></dd>
<dt id="AllenNeuralDynamics_AindBehaviorServices_DataTypes_DataType_Number"><code>[EnumMember(Value = &quot;number&quot;)]
Number = 1</code></dt>
<dd></dd>
<dt id="AllenNeuralDynamics_AindBehaviorServices_DataTypes_DataType_Object"><code>[EnumMember(Value = &quot;object&quot;)]
Object = 3</code></dt>
<dd></dd>
<dt id="AllenNeuralDynamics_AindBehaviorServices_DataTypes_DataType_String"><code>[EnumMember(Value = &quot;string&quot;)]
String = 0</code></dt>
<dd></dd>
</dl>



</article>

<div class="contribution d-print-none">
<a href="https://github.com/AllenNeuralDynamics/Bonsai.AllenNeuralDynamics/blob/main/src/AllenNeuralDynamics.AindBehaviorServices/AindBehaviorServicesDataTypes.cs/#L12" 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">
<span>Made with <a href="https://dotnet.github.io/docfx">docfx</a></span>
</div>
</div>
</footer>
</body>
</html>
439 changes: 439 additions & 0 deletions api/AllenNeuralDynamics.AindBehaviorServices.DataTypes.DataTypes.html

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,320 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class DeserializeFromJson </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class DeserializeFromJson ">

<meta name="description" content="Deserializes a sequence of JSON strings into data model objects.">
<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/AllenNeuralDynamics/Bonsai.AllenNeuralDynamics/new/main/docs/apidoc/new?filename=AllenNeuralDynamics_AindBehaviorServices_DataTypes_DeserializeFromJson.md&amp;value=---%0Auid%3A%20AllenNeuralDynamics.AindBehaviorServices.DataTypes.DeserializeFromJson%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="">

</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="AllenNeuralDynamics.AindBehaviorServices.DataTypes.DeserializeFromJson">



<h1 id="AllenNeuralDynamics_AindBehaviorServices_DataTypes_DeserializeFromJson" data-uid="AllenNeuralDynamics.AindBehaviorServices.DataTypes.DeserializeFromJson" class="text-break">
Class DeserializeFromJson <a class="header-action link-secondary" title="View source" href="https://github.com/AllenNeuralDynamics/Bonsai.AllenNeuralDynamics/blob/main/src/AllenNeuralDynamics.AindBehaviorServices/AindBehaviorServicesDataTypes.cs/#L523"><i class="bi bi-code-slash"></i></a>
</h1>

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

<div class="markdown summary"><p>Deserializes a sequence of JSON strings into data model objects.</p>
</div>
<div class="markdown conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">[WorkflowElementCategory(ElementCategory.Transform)]
public class DeserializeFromJson : SingleArgumentExpressionBuilder, IExpressionBuilder</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="https://bonsai-rx.org/docs/api/Bonsai.Expressions.ExpressionBuilder.html">ExpressionBuilder</a></div>
<div><a class="xref" href="https://bonsai-rx.org/docs/api/Bonsai.Expressions.SingleArgumentExpressionBuilder.html">SingleArgumentExpressionBuilder</a></div>
<div><span class="xref">DeserializeFromJson</span></div>
</dd>
</dl>

<dl class="typelist implements">
<dt>Implements</dt>
<dd>
<div><a class="xref" href="https://bonsai-rx.org/docs/api/Bonsai.Expressions.IExpressionBuilder.html">IExpressionBuilder</a></div>
</dd>
</dl>


<dl class="typelist inheritedMembers">
<dt>Inherited Members</dt>
<dd>
<div>
<a class="xref" href="https://bonsai-rx.org/docs/api/Bonsai.Expressions.SingleArgumentExpressionBuilder.html#Bonsai_Expressions_SingleArgumentExpressionBuilder_ArgumentRange">SingleArgumentExpressionBuilder.ArgumentRange</a>
</div>
<div>
<a class="xref" href="https://bonsai-rx.org/docs/api/Bonsai.Expressions.ExpressionBuilder.html#Bonsai_Expressions_ExpressionBuilder_ToString">ExpressionBuilder.ToString()</a>
</div>
<div>
<a class="xref" href="https://bonsai-rx.org/docs/api/Bonsai.Expressions.ExpressionBuilder.html#Bonsai_Expressions_ExpressionBuilder_Unwrap_Bonsai_Expressions_ExpressionBuilder_">ExpressionBuilder.Unwrap(ExpressionBuilder)</a>
</div>
<div>
<a class="xref" href="https://bonsai-rx.org/docs/api/Bonsai.Expressions.ExpressionBuilder.html#Bonsai_Expressions_ExpressionBuilder_GetWorkflowElement_Bonsai_Expressions_ExpressionBuilder_">ExpressionBuilder.GetWorkflowElement(ExpressionBuilder)</a>
</div>
<div>
<a class="xref" href="https://bonsai-rx.org/docs/api/Bonsai.Expressions.ExpressionBuilder.html#Bonsai_Expressions_ExpressionBuilder_GetVisualizerElement_Bonsai_Expressions_ExpressionBuilder_">ExpressionBuilder.GetVisualizerElement(ExpressionBuilder)</a>
</div>
<div>
<a class="xref" href="https://bonsai-rx.org/docs/api/Bonsai.Expressions.ExpressionBuilder.html#Bonsai_Expressions_ExpressionBuilder_GetVisualizerMappings_Bonsai_Expressions_ExpressionBuilder_">ExpressionBuilder.GetVisualizerMappings(ExpressionBuilder)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">ExpressionBuilder.FromWorkflowElement(object, ElementCategory)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.type">ExpressionBuilder.GetElementDisplayName(Type)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">ExpressionBuilder.GetElementDisplayName(object)</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="constructors">Constructors
</h2>


<a id="AllenNeuralDynamics_AindBehaviorServices_DataTypes_DeserializeFromJson__ctor_" data-uid="AllenNeuralDynamics.AindBehaviorServices.DataTypes.DeserializeFromJson.#ctor*"></a>

<h3 id="AllenNeuralDynamics_AindBehaviorServices_DataTypes_DeserializeFromJson__ctor" data-uid="AllenNeuralDynamics.AindBehaviorServices.DataTypes.DeserializeFromJson.#ctor">
DeserializeFromJson()
<a class="header-action link-secondary" title="View source" href="https://github.com/AllenNeuralDynamics/Bonsai.AllenNeuralDynamics/blob/main/src/AllenNeuralDynamics.AindBehaviorServices/AindBehaviorServicesDataTypes.cs/#L533"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public DeserializeFromJson()</code></pre>
</div>













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


<a id="AllenNeuralDynamics_AindBehaviorServices_DataTypes_DeserializeFromJson_Type_" data-uid="AllenNeuralDynamics.AindBehaviorServices.DataTypes.DeserializeFromJson.Type*"></a>

<h3 id="AllenNeuralDynamics_AindBehaviorServices_DataTypes_DeserializeFromJson_Type" data-uid="AllenNeuralDynamics.AindBehaviorServices.DataTypes.DeserializeFromJson.Type">
Type
<a class="header-action link-secondary" title="View source" href="https://github.com/AllenNeuralDynamics/Bonsai.AllenNeuralDynamics/blob/main/src/AllenNeuralDynamics.AindBehaviorServices/AindBehaviorServicesDataTypes.cs/#L538"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>

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





<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://bonsai-rx.org/docs/api/Bonsai.Expressions.TypeMapping.html">TypeMapping</a></dt>
<dd></dd>
</dl>








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


<a id="AllenNeuralDynamics_AindBehaviorServices_DataTypes_DeserializeFromJson_Build_" data-uid="AllenNeuralDynamics.AindBehaviorServices.DataTypes.DeserializeFromJson.Build*"></a>

<h3 id="AllenNeuralDynamics_AindBehaviorServices_DataTypes_DeserializeFromJson_Build_System_Collections_Generic_IEnumerable_System_Linq_Expressions_Expression__" data-uid="AllenNeuralDynamics.AindBehaviorServices.DataTypes.DeserializeFromJson.Build(System.Collections.Generic.IEnumerable{System.Linq.Expressions.Expression})">
Build(IEnumerable&lt;Expression&gt;)
<a class="header-action link-secondary" title="View source" href="https://github.com/AllenNeuralDynamics/Bonsai.AllenNeuralDynamics/blob/main/src/AllenNeuralDynamics.AindBehaviorServices/AindBehaviorServicesDataTypes.cs/#L540"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Constructs an <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.linq.expressions.expression">Expression</a> node from a collection of input
arguments. The result can be chained with other builders in a workflow.</p>
</div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override Expression Build(IEnumerable&lt;Expression&gt; arguments)</code></pre>
</div>

<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>arguments</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.linq.expressions.expression">Expression</a>&gt;</dt>
<dd><p>A collection of <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.linq.expressions.expression">Expression</a> nodes representing the input
arguments.</p>
</dd>
</dl>

<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.linq.expressions.expression">Expression</a></dt>
<dd><p>The constructed <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.linq.expressions.expression">Expression</a> node.</p>
</dd>
</dl>












</article>

<div class="contribution d-print-none">
<a href="https://github.com/AllenNeuralDynamics/Bonsai.AllenNeuralDynamics/blob/main/src/AllenNeuralDynamics.AindBehaviorServices/AindBehaviorServicesDataTypes.cs/#L523" 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">
<span>Made with <a href="https://dotnet.github.io/docfx">docfx</a></span>
</div>
</div>
</footer>
</body>
</html>

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,291 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class SerializeToJson </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class SerializeToJson ">

<meta name="description" content="Serializes a sequence of data model objects into JSON strings.">
<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/AllenNeuralDynamics/Bonsai.AllenNeuralDynamics/new/main/docs/apidoc/new?filename=AllenNeuralDynamics_AindBehaviorServices_DataTypes_SerializeToJson.md&amp;value=---%0Auid%3A%20AllenNeuralDynamics.AindBehaviorServices.DataTypes.SerializeToJson%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="">

</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="AllenNeuralDynamics.AindBehaviorServices.DataTypes.SerializeToJson">



<h1 id="AllenNeuralDynamics_AindBehaviorServices_DataTypes_SerializeToJson" data-uid="AllenNeuralDynamics.AindBehaviorServices.DataTypes.SerializeToJson" class="text-break">
Class SerializeToJson <a class="header-action link-secondary" title="View source" href="https://github.com/AllenNeuralDynamics/Bonsai.AllenNeuralDynamics/blob/main/src/AllenNeuralDynamics.AindBehaviorServices/AindBehaviorServicesDataTypes.cs/#L491"><i class="bi bi-code-slash"></i></a>
</h1>

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

<div class="markdown summary"><p>Serializes a sequence of data model objects into JSON strings.</p>
</div>
<div class="markdown conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">[Combinator]
[WorkflowElementCategory(ElementCategory.Transform)]
public class SerializeToJson</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><span class="xref">SerializeToJson</span></div>
</dd>
</dl>



<dl class="typelist inheritedMembers">
<dt>Inherited Members</dt>
<dd>
<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="methods">Methods
</h2>


<a id="AllenNeuralDynamics_AindBehaviorServices_DataTypes_SerializeToJson_Process_" data-uid="AllenNeuralDynamics.AindBehaviorServices.DataTypes.SerializeToJson.Process*"></a>

<h3 id="AllenNeuralDynamics_AindBehaviorServices_DataTypes_SerializeToJson_Process_System_IObservable_AllenNeuralDynamics_AindBehaviorServices_DataTypes_DataTypes__" data-uid="AllenNeuralDynamics.AindBehaviorServices.DataTypes.SerializeToJson.Process(System.IObservable{AllenNeuralDynamics.AindBehaviorServices.DataTypes.DataTypes})">
Process(IObservable&lt;DataTypes&gt;)
<a class="header-action link-secondary" title="View source" href="https://github.com/AllenNeuralDynamics/Bonsai.AllenNeuralDynamics/blob/main/src/AllenNeuralDynamics.AindBehaviorServices/AindBehaviorServicesDataTypes.cs/#L513"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IObservable&lt;string&gt; Process(IObservable&lt;DataTypes&gt; source)</code></pre>
</div>

<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>source</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iobservable-1">IObservable</a>&lt;<a class="xref" href="AllenNeuralDynamics.AindBehaviorServices.DataTypes.DataTypes.html">DataTypes</a>&gt;</dt>
<dd></dd>
</dl>

<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iobservable-1">IObservable</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>&gt;</dt>
<dd></dd>
</dl>











<a id="AllenNeuralDynamics_AindBehaviorServices_DataTypes_SerializeToJson_Process_" data-uid="AllenNeuralDynamics.AindBehaviorServices.DataTypes.SerializeToJson.Process*"></a>

<h3 id="AllenNeuralDynamics_AindBehaviorServices_DataTypes_SerializeToJson_Process_System_IObservable_AllenNeuralDynamics_AindBehaviorServices_DataTypes_RenderSynchState__" data-uid="AllenNeuralDynamics.AindBehaviorServices.DataTypes.SerializeToJson.Process(System.IObservable{AllenNeuralDynamics.AindBehaviorServices.DataTypes.RenderSynchState})">
Process(IObservable&lt;RenderSynchState&gt;)
<a class="header-action link-secondary" title="View source" href="https://github.com/AllenNeuralDynamics/Bonsai.AllenNeuralDynamics/blob/main/src/AllenNeuralDynamics.AindBehaviorServices/AindBehaviorServicesDataTypes.cs/#L503"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IObservable&lt;string&gt; Process(IObservable&lt;RenderSynchState&gt; source)</code></pre>
</div>

<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>source</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iobservable-1">IObservable</a>&lt;<a class="xref" href="AllenNeuralDynamics.AindBehaviorServices.DataTypes.RenderSynchState.html">RenderSynchState</a>&gt;</dt>
<dd></dd>
</dl>

<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iobservable-1">IObservable</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>&gt;</dt>
<dd></dd>
</dl>











<a id="AllenNeuralDynamics_AindBehaviorServices_DataTypes_SerializeToJson_Process_" data-uid="AllenNeuralDynamics.AindBehaviorServices.DataTypes.SerializeToJson.Process*"></a>

<h3 id="AllenNeuralDynamics_AindBehaviorServices_DataTypes_SerializeToJson_Process_System_IObservable_AllenNeuralDynamics_AindBehaviorServices_DataTypes_SoftwareEvent__" data-uid="AllenNeuralDynamics.AindBehaviorServices.DataTypes.SerializeToJson.Process(System.IObservable{AllenNeuralDynamics.AindBehaviorServices.DataTypes.SoftwareEvent})">
Process(IObservable&lt;SoftwareEvent&gt;)
<a class="header-action link-secondary" title="View source" href="https://github.com/AllenNeuralDynamics/Bonsai.AllenNeuralDynamics/blob/main/src/AllenNeuralDynamics.AindBehaviorServices/AindBehaviorServicesDataTypes.cs/#L508"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IObservable&lt;string&gt; Process(IObservable&lt;SoftwareEvent&gt; source)</code></pre>
</div>

<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>source</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iobservable-1">IObservable</a>&lt;<a class="xref" href="AllenNeuralDynamics.AindBehaviorServices.DataTypes.SoftwareEvent.html">SoftwareEvent</a>&gt;</dt>
<dd></dd>
</dl>

<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iobservable-1">IObservable</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>&gt;</dt>
<dd></dd>
</dl>












</article>

<div class="contribution d-print-none">
<a href="https://github.com/AllenNeuralDynamics/Bonsai.AllenNeuralDynamics/blob/main/src/AllenNeuralDynamics.AindBehaviorServices/AindBehaviorServicesDataTypes.cs/#L491" 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">
<span>Made with <a href="https://dotnet.github.io/docfx">docfx</a></span>
</div>
</div>
</footer>
</body>
</html>

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,157 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Enum TimestampSource </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Enum TimestampSource ">


<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/AllenNeuralDynamics/Bonsai.AllenNeuralDynamics/new/main/docs/apidoc/new?filename=AllenNeuralDynamics_AindBehaviorServices_DataTypes_TimestampSource.md&amp;value=---%0Auid%3A%20AllenNeuralDynamics.AindBehaviorServices.DataTypes.TimestampSource%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="">

</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="AllenNeuralDynamics.AindBehaviorServices.DataTypes.TimestampSource">




<h1 id="AllenNeuralDynamics_AindBehaviorServices_DataTypes_TimestampSource" data-uid="AllenNeuralDynamics.AindBehaviorServices.DataTypes.TimestampSource" class="text-break">
Enum TimestampSource <a class="header-action link-secondary" title="View source" href="https://github.com/AllenNeuralDynamics/Bonsai.AllenNeuralDynamics/blob/main/src/AllenNeuralDynamics.AindBehaviorServices/AindBehaviorServicesDataTypes.cs/#L370"><i class="bi bi-code-slash"></i></a>
</h1>

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

<div class="markdown summary"></div>
<div class="markdown conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsonConverter(typeof(StringEnumConverter))]
public enum TimestampSource</code></pre>
</div>









<h2 id="fields">Fields
</h2>
<dl class="parameters">
<dt id="AllenNeuralDynamics_AindBehaviorServices_DataTypes_TimestampSource_Harp"><code>[EnumMember(Value = &quot;harp&quot;)]
Harp = 1</code></dt>
<dd></dd>
<dt id="AllenNeuralDynamics_AindBehaviorServices_DataTypes_TimestampSource_Null"><code>[EnumMember(Value = &quot;null&quot;)]
Null = 0</code></dt>
<dd></dd>
<dt id="AllenNeuralDynamics_AindBehaviorServices_DataTypes_TimestampSource_Render"><code>[EnumMember(Value = &quot;render&quot;)]
Render = 2</code></dt>
<dd></dd>
</dl>



</article>

<div class="contribution d-print-none">
<a href="https://github.com/AllenNeuralDynamics/Bonsai.AllenNeuralDynamics/blob/main/src/AllenNeuralDynamics.AindBehaviorServices/AindBehaviorServicesDataTypes.cs/#L370" 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">
<span>Made with <a href="https://dotnet.github.io/docfx">docfx</a></span>
</div>
</div>
</footer>
</body>
</html>
156 changes: 156 additions & 0 deletions api/AllenNeuralDynamics.AindBehaviorServices.DataTypes.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,156 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Namespace AllenNeuralDynamics.AindBehaviorServices.DataTypes </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Namespace AllenNeuralDynamics.AindBehaviorServices.DataTypes ">


<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="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="">

</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="AllenNeuralDynamics.AindBehaviorServices.DataTypes">

<h1 id="AllenNeuralDynamics_AindBehaviorServices_DataTypes" data-uid="AllenNeuralDynamics.AindBehaviorServices.DataTypes" class="text-break">Namespace AllenNeuralDynamics.AindBehaviorServices.DataTypes</h1>
<div class="markdown level0 summary"></div>
<div class="markdown level0 conceptual"></div>
<div class="markdown level0 remarks"></div>

<h3 id="classes">
Classes
</h3>
<dl class="jumplist">
<dt><a class="xref" href="AllenNeuralDynamics.AindBehaviorServices.DataTypes.DataTypes.html">DataTypes</a></dt>
<dd></dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="AllenNeuralDynamics.AindBehaviorServices.DataTypes.DeserializeFromJson.html">DeserializeFromJson</a></dt>
<dd><p>Deserializes a sequence of JSON strings into data model objects.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="AllenNeuralDynamics.AindBehaviorServices.DataTypes.RenderSynchState.html">RenderSynchState</a></dt>
<dd></dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="AllenNeuralDynamics.AindBehaviorServices.DataTypes.SerializeToJson.html">SerializeToJson</a></dt>
<dd><p>Serializes a sequence of data model objects into JSON strings.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="AllenNeuralDynamics.AindBehaviorServices.DataTypes.SoftwareEvent.html">SoftwareEvent</a></dt>
<dd><p>A software event is a generic event that can be used to track any event that occurs in the software.</p>
</dd>
</dl>
<h3 id="enums">
Enums
</h3>
<dl class="jumplist">
<dt><a class="xref" href="AllenNeuralDynamics.AindBehaviorServices.DataTypes.DataType.html">DataType</a></dt>
<dd></dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="AllenNeuralDynamics.AindBehaviorServices.DataTypes.TimestampSource.html">TimestampSource</a></dt>
<dd></dd>
</dl>


</article>

<div class="contribution d-print-none">
</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">
<span>Made with <a href="https://dotnet.github.io/docfx">docfx</a></span>
</div>
</div>
</footer>
</body>
</html>

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,381 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class AindManipulatorCalibrationOutput </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class AindManipulatorCalibrationOutput ">


<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/AllenNeuralDynamics/Bonsai.AllenNeuralDynamics/new/main/docs/apidoc/new?filename=AllenNeuralDynamics_AindManipulator_AindManipulatorCalibrationOutput.md&amp;value=---%0Auid%3A%20AllenNeuralDynamics.AindManipulator.AindManipulatorCalibrationOutput%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="">

</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="AllenNeuralDynamics.AindManipulator.AindManipulatorCalibrationOutput">



<h1 id="AllenNeuralDynamics_AindManipulator_AindManipulatorCalibrationOutput" data-uid="AllenNeuralDynamics.AindManipulator.AindManipulatorCalibrationOutput" class="text-break">
Class AindManipulatorCalibrationOutput <a class="header-action link-secondary" title="View source" href="https://github.com/AllenNeuralDynamics/Bonsai.AllenNeuralDynamics/blob/main/src/AllenNeuralDynamics.AindManipulator/AindManipulatorSchema.cs/#L285"><i class="bi bi-code-slash"></i></a>
</h1>

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

<div class="markdown summary"></div>
<div class="markdown conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">[Combinator]
[WorkflowElementCategory(ElementCategory.Source)]
public class AindManipulatorCalibrationOutput</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><span class="xref">AindManipulatorCalibrationOutput</span></div>
</dd>
</dl>



<dl class="typelist inheritedMembers">
<dt>Inherited Members</dt>
<dd>
<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="constructors">Constructors
</h2>


<a id="AllenNeuralDynamics_AindManipulator_AindManipulatorCalibrationOutput__ctor_" data-uid="AllenNeuralDynamics.AindManipulator.AindManipulatorCalibrationOutput.#ctor*"></a>

<h3 id="AllenNeuralDynamics_AindManipulator_AindManipulatorCalibrationOutput__ctor" data-uid="AllenNeuralDynamics.AindManipulator.AindManipulatorCalibrationOutput.#ctor">
AindManipulatorCalibrationOutput()
<a class="header-action link-secondary" title="View source" href="https://github.com/AllenNeuralDynamics/Bonsai.AllenNeuralDynamics/blob/main/src/AllenNeuralDynamics.AindManipulator/AindManipulatorSchema.cs/#L291"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public AindManipulatorCalibrationOutput()</code></pre>
</div>













<a id="AllenNeuralDynamics_AindManipulator_AindManipulatorCalibrationOutput__ctor_" data-uid="AllenNeuralDynamics.AindManipulator.AindManipulatorCalibrationOutput.#ctor*"></a>

<h3 id="AllenNeuralDynamics_AindManipulator_AindManipulatorCalibrationOutput__ctor_AllenNeuralDynamics_AindManipulator_AindManipulatorCalibrationOutput_" data-uid="AllenNeuralDynamics.AindManipulator.AindManipulatorCalibrationOutput.#ctor(AllenNeuralDynamics.AindManipulator.AindManipulatorCalibrationOutput)">
AindManipulatorCalibrationOutput(AindManipulatorCalibrationOutput)
<a class="header-action link-secondary" title="View source" href="https://github.com/AllenNeuralDynamics/Bonsai.AllenNeuralDynamics/blob/main/src/AllenNeuralDynamics.AindManipulator/AindManipulatorSchema.cs/#L295"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected AindManipulatorCalibrationOutput(AindManipulatorCalibrationOutput other)</code></pre>
</div>

<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>other</code> <a class="xref" href="AllenNeuralDynamics.AindManipulator.AindManipulatorCalibrationOutput.html">AindManipulatorCalibrationOutput</a></dt>
<dd></dd>
</dl>












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


<a id="AllenNeuralDynamics_AindManipulator_AindManipulatorCalibrationOutput_PrintMembers_" data-uid="AllenNeuralDynamics.AindManipulator.AindManipulatorCalibrationOutput.PrintMembers*"></a>

<h3 id="AllenNeuralDynamics_AindManipulator_AindManipulatorCalibrationOutput_PrintMembers_System_Text_StringBuilder_" data-uid="AllenNeuralDynamics.AindManipulator.AindManipulatorCalibrationOutput.PrintMembers(System.Text.StringBuilder)">
PrintMembers(StringBuilder)
<a class="header-action link-secondary" title="View source" href="https://github.com/AllenNeuralDynamics/Bonsai.AllenNeuralDynamics/blob/main/src/AllenNeuralDynamics.AindManipulator/AindManipulatorSchema.cs/#L309"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected virtual bool PrintMembers(StringBuilder stringBuilder)</code></pre>
</div>

<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>stringBuilder</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.text.stringbuilder">StringBuilder</a></dt>
<dd></dd>
</dl>

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











<a id="AllenNeuralDynamics_AindManipulator_AindManipulatorCalibrationOutput_Process_" data-uid="AllenNeuralDynamics.AindManipulator.AindManipulatorCalibrationOutput.Process*"></a>

<h3 id="AllenNeuralDynamics_AindManipulator_AindManipulatorCalibrationOutput_Process" data-uid="AllenNeuralDynamics.AindManipulator.AindManipulatorCalibrationOutput.Process">
Process()
<a class="header-action link-secondary" title="View source" href="https://github.com/AllenNeuralDynamics/Bonsai.AllenNeuralDynamics/blob/main/src/AllenNeuralDynamics.AindManipulator/AindManipulatorSchema.cs/#L299"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IObservable&lt;AindManipulatorCalibrationOutput&gt; Process()</code></pre>
</div>


<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iobservable-1">IObservable</a>&lt;<a class="xref" href="AllenNeuralDynamics.AindManipulator.AindManipulatorCalibrationOutput.html">AindManipulatorCalibrationOutput</a>&gt;</dt>
<dd></dd>
</dl>











<a id="AllenNeuralDynamics_AindManipulator_AindManipulatorCalibrationOutput_Process_" data-uid="AllenNeuralDynamics.AindManipulator.AindManipulatorCalibrationOutput.Process*"></a>

<h3 id="AllenNeuralDynamics_AindManipulator_AindManipulatorCalibrationOutput_Process__1_System_IObservable___0__" data-uid="AllenNeuralDynamics.AindManipulator.AindManipulatorCalibrationOutput.Process``1(System.IObservable{``0})">
Process&lt;TSource&gt;(IObservable&lt;TSource&gt;)
<a class="header-action link-secondary" title="View source" href="https://github.com/AllenNeuralDynamics/Bonsai.AllenNeuralDynamics/blob/main/src/AllenNeuralDynamics.AindManipulator/AindManipulatorSchema.cs/#L304"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IObservable&lt;AindManipulatorCalibrationOutput&gt; Process&lt;TSource&gt;(IObservable&lt;TSource&gt; source)</code></pre>
</div>

<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>source</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iobservable-1">IObservable</a>&lt;TSource&gt;</dt>
<dd></dd>
</dl>

<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iobservable-1">IObservable</a>&lt;<a class="xref" href="AllenNeuralDynamics.AindManipulator.AindManipulatorCalibrationOutput.html">AindManipulatorCalibrationOutput</a>&gt;</dt>
<dd></dd>
</dl>

<h4 class="section">Type Parameters</h4>
<dl class="parameters">
<dt><code>TSource</code></dt>
<dd></dd>
</dl>










<a id="AllenNeuralDynamics_AindManipulator_AindManipulatorCalibrationOutput_ToString_" data-uid="AllenNeuralDynamics.AindManipulator.AindManipulatorCalibrationOutput.ToString*"></a>

<h3 id="AllenNeuralDynamics_AindManipulator_AindManipulatorCalibrationOutput_ToString" data-uid="AllenNeuralDynamics.AindManipulator.AindManipulatorCalibrationOutput.ToString">
ToString()
<a class="header-action link-secondary" title="View source" href="https://github.com/AllenNeuralDynamics/Bonsai.AllenNeuralDynamics/blob/main/src/AllenNeuralDynamics.AindManipulator/AindManipulatorSchema.cs/#L314"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Returns a string that represents the current object.</p>
</div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override string ToString()</code></pre>
</div>


<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>A string that represents the current object.</p>
</dd>
</dl>












</article>

<div class="contribution d-print-none">
<a href="https://github.com/AllenNeuralDynamics/Bonsai.AllenNeuralDynamics/blob/main/src/AllenNeuralDynamics.AindManipulator/AindManipulatorSchema.cs/#L285" 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">
<span>Made with <a href="https://dotnet.github.io/docfx">docfx</a></span>
</div>
</div>
</footer>
</body>
</html>
580 changes: 580 additions & 0 deletions api/AllenNeuralDynamics.AindManipulator.AindManipulatorDevice.html

Large diffs are not rendered by default.

617 changes: 617 additions & 0 deletions api/AllenNeuralDynamics.AindManipulator.AindManipulatorPosition.html

Large diffs are not rendered by default.

163 changes: 163 additions & 0 deletions api/AllenNeuralDynamics.AindManipulator.Axis.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,163 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Enum Axis </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Enum Axis ">

<meta name="description" content="Motor axis available">
<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/AllenNeuralDynamics/Bonsai.AllenNeuralDynamics/new/main/docs/apidoc/new?filename=AllenNeuralDynamics_AindManipulator_Axis.md&amp;value=---%0Auid%3A%20AllenNeuralDynamics.AindManipulator.Axis%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="">

</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="AllenNeuralDynamics.AindManipulator.Axis">




<h1 id="AllenNeuralDynamics_AindManipulator_Axis" data-uid="AllenNeuralDynamics.AindManipulator.Axis" class="text-break">
Enum Axis <a class="header-action link-secondary" title="View source" href="https://github.com/AllenNeuralDynamics/Bonsai.AllenNeuralDynamics/blob/main/src/AllenNeuralDynamics.AindManipulator/AindManipulatorSchema.cs/#L492"><i class="bi bi-code-slash"></i></a>
</h1>

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

<div class="markdown summary"><p>Motor axis available</p>
</div>
<div class="markdown conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public enum Axis</code></pre>
</div>









<h2 id="fields">Fields
</h2>
<dl class="parameters">
<dt id="AllenNeuralDynamics_AindManipulator_Axis_None"><code>[EnumMember(Value = &quot;0&quot;)]
None = 0</code></dt>
<dd></dd>
<dt id="AllenNeuralDynamics_AindManipulator_Axis_X"><code>[EnumMember(Value = &quot;1&quot;)]
X = 1</code></dt>
<dd></dd>
<dt id="AllenNeuralDynamics_AindManipulator_Axis_Y1"><code>[EnumMember(Value = &quot;2&quot;)]
Y1 = 2</code></dt>
<dd></dd>
<dt id="AllenNeuralDynamics_AindManipulator_Axis_Y2"><code>[EnumMember(Value = &quot;3&quot;)]
Y2 = 3</code></dt>
<dd></dd>
<dt id="AllenNeuralDynamics_AindManipulator_Axis_Z"><code>[EnumMember(Value = &quot;4&quot;)]
Z = 4</code></dt>
<dd></dd>
</dl>



</article>

<div class="contribution d-print-none">
<a href="https://github.com/AllenNeuralDynamics/Bonsai.AllenNeuralDynamics/blob/main/src/AllenNeuralDynamics.AindManipulator/AindManipulatorSchema.cs/#L492" 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">
<span>Made with <a href="https://dotnet.github.io/docfx">docfx</a></span>
</div>
</div>
</footer>
</body>
</html>
644 changes: 644 additions & 0 deletions api/AllenNeuralDynamics.AindManipulator.AxisConfiguration.html

Large diffs are not rendered by default.

381 changes: 381 additions & 0 deletions api/AllenNeuralDynamics.AindManipulator.BaseModel.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,381 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class BaseModel </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class BaseModel ">


<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/AllenNeuralDynamics/Bonsai.AllenNeuralDynamics/new/main/docs/apidoc/new?filename=AllenNeuralDynamics_AindManipulator_BaseModel.md&amp;value=---%0Auid%3A%20AllenNeuralDynamics.AindManipulator.BaseModel%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="">

</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="AllenNeuralDynamics.AindManipulator.BaseModel">



<h1 id="AllenNeuralDynamics_AindManipulator_BaseModel" data-uid="AllenNeuralDynamics.AindManipulator.BaseModel" class="text-break">
Class BaseModel <a class="header-action link-secondary" title="View source" href="https://github.com/AllenNeuralDynamics/Bonsai.AllenNeuralDynamics/blob/main/src/AllenNeuralDynamics.AindManipulator/AindManipulatorSchema.cs/#L708"><i class="bi bi-code-slash"></i></a>
</h1>

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

<div class="markdown summary"></div>
<div class="markdown conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">[Combinator]
[WorkflowElementCategory(ElementCategory.Source)]
public class BaseModel</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><span class="xref">BaseModel</span></div>
</dd>
</dl>



<dl class="typelist inheritedMembers">
<dt>Inherited Members</dt>
<dd>
<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="constructors">Constructors
</h2>


<a id="AllenNeuralDynamics_AindManipulator_BaseModel__ctor_" data-uid="AllenNeuralDynamics.AindManipulator.BaseModel.#ctor*"></a>

<h3 id="AllenNeuralDynamics_AindManipulator_BaseModel__ctor" data-uid="AllenNeuralDynamics.AindManipulator.BaseModel.#ctor">
BaseModel()
<a class="header-action link-secondary" title="View source" href="https://github.com/AllenNeuralDynamics/Bonsai.AllenNeuralDynamics/blob/main/src/AllenNeuralDynamics.AindManipulator/AindManipulatorSchema.cs/#L714"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public BaseModel()</code></pre>
</div>













<a id="AllenNeuralDynamics_AindManipulator_BaseModel__ctor_" data-uid="AllenNeuralDynamics.AindManipulator.BaseModel.#ctor*"></a>

<h3 id="AllenNeuralDynamics_AindManipulator_BaseModel__ctor_AllenNeuralDynamics_AindManipulator_BaseModel_" data-uid="AllenNeuralDynamics.AindManipulator.BaseModel.#ctor(AllenNeuralDynamics.AindManipulator.BaseModel)">
BaseModel(BaseModel)
<a class="header-action link-secondary" title="View source" href="https://github.com/AllenNeuralDynamics/Bonsai.AllenNeuralDynamics/blob/main/src/AllenNeuralDynamics.AindManipulator/AindManipulatorSchema.cs/#L718"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected BaseModel(BaseModel other)</code></pre>
</div>

<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>other</code> <a class="xref" href="AllenNeuralDynamics.AindManipulator.BaseModel.html">BaseModel</a></dt>
<dd></dd>
</dl>












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


<a id="AllenNeuralDynamics_AindManipulator_BaseModel_PrintMembers_" data-uid="AllenNeuralDynamics.AindManipulator.BaseModel.PrintMembers*"></a>

<h3 id="AllenNeuralDynamics_AindManipulator_BaseModel_PrintMembers_System_Text_StringBuilder_" data-uid="AllenNeuralDynamics.AindManipulator.BaseModel.PrintMembers(System.Text.StringBuilder)">
PrintMembers(StringBuilder)
<a class="header-action link-secondary" title="View source" href="https://github.com/AllenNeuralDynamics/Bonsai.AllenNeuralDynamics/blob/main/src/AllenNeuralDynamics.AindManipulator/AindManipulatorSchema.cs/#L732"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected virtual bool PrintMembers(StringBuilder stringBuilder)</code></pre>
</div>

<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>stringBuilder</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.text.stringbuilder">StringBuilder</a></dt>
<dd></dd>
</dl>

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











<a id="AllenNeuralDynamics_AindManipulator_BaseModel_Process_" data-uid="AllenNeuralDynamics.AindManipulator.BaseModel.Process*"></a>

<h3 id="AllenNeuralDynamics_AindManipulator_BaseModel_Process" data-uid="AllenNeuralDynamics.AindManipulator.BaseModel.Process">
Process()
<a class="header-action link-secondary" title="View source" href="https://github.com/AllenNeuralDynamics/Bonsai.AllenNeuralDynamics/blob/main/src/AllenNeuralDynamics.AindManipulator/AindManipulatorSchema.cs/#L722"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IObservable&lt;BaseModel&gt; Process()</code></pre>
</div>


<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iobservable-1">IObservable</a>&lt;<a class="xref" href="AllenNeuralDynamics.AindManipulator.BaseModel.html">BaseModel</a>&gt;</dt>
<dd></dd>
</dl>











<a id="AllenNeuralDynamics_AindManipulator_BaseModel_Process_" data-uid="AllenNeuralDynamics.AindManipulator.BaseModel.Process*"></a>

<h3 id="AllenNeuralDynamics_AindManipulator_BaseModel_Process__1_System_IObservable___0__" data-uid="AllenNeuralDynamics.AindManipulator.BaseModel.Process``1(System.IObservable{``0})">
Process&lt;TSource&gt;(IObservable&lt;TSource&gt;)
<a class="header-action link-secondary" title="View source" href="https://github.com/AllenNeuralDynamics/Bonsai.AllenNeuralDynamics/blob/main/src/AllenNeuralDynamics.AindManipulator/AindManipulatorSchema.cs/#L727"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IObservable&lt;BaseModel&gt; Process&lt;TSource&gt;(IObservable&lt;TSource&gt; source)</code></pre>
</div>

<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>source</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iobservable-1">IObservable</a>&lt;TSource&gt;</dt>
<dd></dd>
</dl>

<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iobservable-1">IObservable</a>&lt;<a class="xref" href="AllenNeuralDynamics.AindManipulator.BaseModel.html">BaseModel</a>&gt;</dt>
<dd></dd>
</dl>

<h4 class="section">Type Parameters</h4>
<dl class="parameters">
<dt><code>TSource</code></dt>
<dd></dd>
</dl>










<a id="AllenNeuralDynamics_AindManipulator_BaseModel_ToString_" data-uid="AllenNeuralDynamics.AindManipulator.BaseModel.ToString*"></a>

<h3 id="AllenNeuralDynamics_AindManipulator_BaseModel_ToString" data-uid="AllenNeuralDynamics.AindManipulator.BaseModel.ToString">
ToString()
<a class="header-action link-secondary" title="View source" href="https://github.com/AllenNeuralDynamics/Bonsai.AllenNeuralDynamics/blob/main/src/AllenNeuralDynamics.AindManipulator/AindManipulatorSchema.cs/#L737"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Returns a string that represents the current object.</p>
</div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override string ToString()</code></pre>
</div>


<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>A string that represents the current object.</p>
</dd>
</dl>












</article>

<div class="contribution d-print-none">
<a href="https://github.com/AllenNeuralDynamics/Bonsai.AllenNeuralDynamics/blob/main/src/AllenNeuralDynamics.AindManipulator/AindManipulatorSchema.cs/#L708" 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">
<span>Made with <a href="https://dotnet.github.io/docfx">docfx</a></span>
</div>
</div>
</footer>
</body>
</html>
547 changes: 547 additions & 0 deletions api/AllenNeuralDynamics.AindManipulator.CalibrationRig.html

Large diffs are not rendered by default.

176 changes: 176 additions & 0 deletions api/AllenNeuralDynamics.AindManipulator.ConfigureMotor.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,176 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class ConfigureMotor </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class ConfigureMotor ">


<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/AllenNeuralDynamics/Bonsai.AllenNeuralDynamics/new/main/docs/apidoc/new?filename=AllenNeuralDynamics_AindManipulator_ConfigureMotor.md&amp;value=---%0Auid%3A%20AllenNeuralDynamics.AindManipulator.ConfigureMotor%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="">

</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="AllenNeuralDynamics.AindManipulator.ConfigureMotor">



<h1 id="AllenNeuralDynamics_AindManipulator_ConfigureMotor" data-uid="AllenNeuralDynamics.AindManipulator.ConfigureMotor" class="text-break">
Class ConfigureMotor <a class="header-action link-secondary" title="View source" href="https://github.com/AllenNeuralDynamics/Bonsai.AllenNeuralDynamics/blob/main/src/AllenNeuralDynamics.AindManipulator/IncludeWorkflowMetadata.cs/#L5"><i class="bi bi-code-slash"></i></a>
</h1>

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

<div class="markdown summary"></div>
<div class="markdown conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static class ConfigureMotor</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><span class="xref">ConfigureMotor</span></div>
</dd>
</dl>



<dl class="typelist inheritedMembers">
<dt>Inherited Members</dt>
<dd>
<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>







</article>

<div class="contribution d-print-none">
<a href="https://github.com/AllenNeuralDynamics/Bonsai.AllenNeuralDynamics/blob/main/src/AllenNeuralDynamics.AindManipulator/IncludeWorkflowMetadata.cs/#L5" 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">
<span>Made with <a href="https://dotnet.github.io/docfx">docfx</a></span>
</div>
</div>
</footer>
</body>
</html>
268 changes: 268 additions & 0 deletions api/AllenNeuralDynamics.AindManipulator.ContainsKey.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,268 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class ContainsKey </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class ContainsKey ">


<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/AllenNeuralDynamics/Bonsai.AllenNeuralDynamics/new/main/docs/apidoc/new?filename=AllenNeuralDynamics_AindManipulator_ContainsKey.md&amp;value=---%0Auid%3A%20AllenNeuralDynamics.AindManipulator.ContainsKey%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="">

</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="AllenNeuralDynamics.AindManipulator.ContainsKey">



<h1 id="AllenNeuralDynamics_AindManipulator_ContainsKey" data-uid="AllenNeuralDynamics.AindManipulator.ContainsKey" class="text-break">
Class ContainsKey <a class="header-action link-secondary" title="View source" href="https://github.com/AllenNeuralDynamics/Bonsai.AllenNeuralDynamics/blob/main/src/AllenNeuralDynamics.AindManipulator/ContainsKey.cs/#L10"><i class="bi bi-code-slash"></i></a>
</h1>

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

<div class="markdown summary"></div>
<div class="markdown conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">[Combinator]
[WorkflowElementCategory(ElementCategory.Transform)]
public class ContainsKey</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><span class="xref">ContainsKey</span></div>
</dd>
</dl>



<dl class="typelist inheritedMembers">
<dt>Inherited Members</dt>
<dd>
<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="methods">Methods
</h2>


<a id="AllenNeuralDynamics_AindManipulator_ContainsKey_Process_" data-uid="AllenNeuralDynamics.AindManipulator.ContainsKey.Process*"></a>

<h3 id="AllenNeuralDynamics_AindManipulator_ContainsKey_Process__2_System_IObservable_System_Tuple_System_Collections_Generic_IDictionary___0___1____0___" data-uid="AllenNeuralDynamics.AindManipulator.ContainsKey.Process``2(System.IObservable{System.Tuple{System.Collections.Generic.IDictionary{``0,``1},``0}})">
Process&lt;TKey, TValue&gt;(IObservable&lt;Tuple&lt;IDictionary&lt;TKey, TValue&gt;, TKey&gt;&gt;)
<a class="header-action link-secondary" title="View source" href="https://github.com/AllenNeuralDynamics/Bonsai.AllenNeuralDynamics/blob/main/src/AllenNeuralDynamics.AindManipulator/ContainsKey.cs/#L22"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IObservable&lt;bool&gt; Process&lt;TKey, TValue&gt;(IObservable&lt;Tuple&lt;IDictionary&lt;TKey, TValue&gt;, TKey&gt;&gt; source)</code></pre>
</div>

<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>source</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iobservable-1">IObservable</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.tuple-2">Tuple</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.idictionary-2">IDictionary</a>&lt;TKey, TValue&gt;, TKey&gt;&gt;</dt>
<dd></dd>
</dl>

<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iobservable-1">IObservable</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a>&gt;</dt>
<dd></dd>
</dl>

<h4 class="section">Type Parameters</h4>
<dl class="parameters">
<dt><code>TKey</code></dt>
<dd></dd>
<dt><code>TValue</code></dt>
<dd></dd>
</dl>










<a id="AllenNeuralDynamics_AindManipulator_ContainsKey_Process_" data-uid="AllenNeuralDynamics.AindManipulator.ContainsKey.Process*"></a>

<h3 id="AllenNeuralDynamics_AindManipulator_ContainsKey_Process__2_System_IObservable_System_Tuple___0_System_Collections_Generic_IDictionary___0___1____" data-uid="AllenNeuralDynamics.AindManipulator.ContainsKey.Process``2(System.IObservable{System.Tuple{``0,System.Collections.Generic.IDictionary{``0,``1}}})">
Process&lt;TKey, TValue&gt;(IObservable&lt;Tuple&lt;TKey, IDictionary&lt;TKey, TValue&gt;&gt;&gt;)
<a class="header-action link-secondary" title="View source" href="https://github.com/AllenNeuralDynamics/Bonsai.AllenNeuralDynamics/blob/main/src/AllenNeuralDynamics.AindManipulator/ContainsKey.cs/#L17"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IObservable&lt;bool&gt; Process&lt;TKey, TValue&gt;(IObservable&lt;Tuple&lt;TKey, IDictionary&lt;TKey, TValue&gt;&gt;&gt; source)</code></pre>
</div>

<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>source</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iobservable-1">IObservable</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.tuple-2">Tuple</a>&lt;TKey, <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.idictionary-2">IDictionary</a>&lt;TKey, TValue&gt;&gt;&gt;</dt>
<dd></dd>
</dl>

<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iobservable-1">IObservable</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a>&gt;</dt>
<dd></dd>
</dl>

<h4 class="section">Type Parameters</h4>
<dl class="parameters">
<dt><code>TKey</code></dt>
<dd></dd>
<dt><code>TValue</code></dt>
<dd></dd>
</dl>











</article>

<div class="contribution d-print-none">
<a href="https://github.com/AllenNeuralDynamics/Bonsai.AllenNeuralDynamics/blob/main/src/AllenNeuralDynamics.AindManipulator/ContainsKey.cs/#L10" 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">
<span>Made with <a href="https://dotnet.github.io/docfx">docfx</a></span>
</div>
</div>
</footer>
</body>
</html>
Loading

0 comments on commit ce0b3a7

Please sign in to comment.