Skip to content

Updated the schema data #302

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 26, 2025
Merged

Updated the schema data #302

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
94 changes: 52 additions & 42 deletions docs/html/BidsFile.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ <h5>Parameters:</h5>
<td class="name"><code>file</code></td>

<td class="type">
<span class="param-type">object</span>
<span class="param-type">Object</span>
</td>

<td class="description last">The representation of the file for error messages.</td>
Expand All @@ -74,9 +74,11 @@ <h5>Parameters:</h5>
<tr>
<td class="name"><code>validatorClass</code></td>

<td class="type"></td>
<td class="type">
<span class="param-type"><a href="BidsValidator.html">BidsValidator</a></span>
</td>

<td class="description last"></td>
<td class="description last">The validator class corresponding to this file.</td>
</tr>
</tbody>
</table>
Expand Down Expand Up @@ -104,18 +106,18 @@ <h3 class="subsection-title">Classes</h3>
<h3 class="subsection-title">Members</h3>

<h4 class="name" id="file">
<span class="type-signature"></span>file<span class="type-signature"> :object</span>
<span class="type-signature"></span>file<span class="type-signature"> :Object</span>
</h4>

<div class="description">
The file object representing this file data. This is used to generate
<a href="BidsIssue.html">BidsIssue</a> objects.
The Object representing this file data. This is used to generate
<a href="BidsHedIssue.html">BidsHedIssue</a> objects.
</div>

<h5>Type:</h5>
<ul>
<li>
<span class="param-type">object</span>
<span class="param-type">Object</span>
</li>
</ul>

Expand All @@ -125,90 +127,96 @@ <h5>Type:</h5>
<ul class="dummy">
<li>
<a href="bids_types_file.js.html">bids/types/file.js</a>,
<a href="bids_types_file.js.html#line18">line 18</a>
<a href="bids_types_file.js.html#line20">line 20</a>
</li>
</ul>
</dd>
</dl>

<h4 class="name" id="name">
<span class="type-signature"></span>name<span class="type-signature"> :string</span>
<h4 class="name" id="hasHedData">
<span class="type-signature"></span>hasHedData<span class="type-signature"></span>
</h4>

<div class="description">The name of this file.</div>

<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<div class="description">Determine whether this file has any HED data.</div>

<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="bids_types_file.js.html">bids/types/file.js</a>,
<a href="bids_types_file.js.html#line12">line 12</a>
<a href="bids_types_file.js.html#line94">line 94</a>
</li>
</ul>
</dd>
</dl>

<h4 class="name" id="validatorClass">
<span class="type-signature"></span>validatorClass<span class="type-signature"></span>
<h4 class="name" id="isTimelineFile">
<span class="type-signature"></span>isTimelineFile<span class="type-signature"></span>
</h4>

<div class="description">The validator class used to validate this file.</div>
<div class="description">Whether this is a TSV file timeline file.</div>

<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="bids_types_file.js.html">bids/types/file.js</a>,
<a href="bids_types_file.js.html#line77">line 77</a>
<a href="bids_types_file.js.html#line54">line 54</a>
</li>
</ul>
</dd>
</dl>

<h3 class="subsection-title">Methods</h3>

<h4 class="name" id="hasHedData">
<span class="type-signature"></span>hasHedData<span class="signature">()</span
><span class="type-signature"> &rarr; {boolean}</span>
<h4 class="name" id="name">
<span class="type-signature"></span>name<span class="type-signature"> :string</span>
</h4>

<div class="description">Determine whether this file has any HED data.</div>
<div class="description">The name of this file.</div>

<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>

<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="bids_types_file.js.html">bids/types/file.js</a>,
<a href="bids_types_file.js.html#line42">line 42</a>
<a href="bids_types_file.js.html#line12">line 12</a>
</li>
</ul>
</dd>
</dl>

<h5>Returns:</h5>
<h4 class="name" id="validatorClass">
<span class="type-signature"></span>validatorClass<span class="type-signature"></span>
</h4>

<div class="param-desc">- True if this file has HED data.</div>
<div class="description">The validator class used to validate this file.</div>

<dl>
<dt>Type</dt>
<dd>
<span class="param-type">boolean</span>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="bids_types_file.js.html">bids/types/file.js</a>,
<a href="bids_types_file.js.html#line103">line 103</a>
</li>
</ul>
</dd>
</dl>

<h3 class="subsection-title">Methods</h3>

<h4 class="name" id="validate">
<span class="type-signature"></span>validate<span class="signature">(schemas)</span
><span class="type-signature"> &rarr; {Array.&lt;<a href="BidsIssue.html">BidsIssue</a>>}</span>
><span class="type-signature"> &rarr; {Array.&lt;<a href="BidsHedIssue.html">BidsHedIssue</a>>}</span>
</h4>

<div class="description">Validate this validator's tsv file.</div>
Expand Down Expand Up @@ -245,7 +253,7 @@ <h5>Parameters:</h5>
<ul class="dummy">
<li>
<a href="bids_types_file.js.html">bids/types/file.js</a>,
<a href="bids_types_file.js.html#line52">line 52</a>
<a href="bids_types_file.js.html#line64">line 64</a>
</li>
</ul>
</dd>
Expand All @@ -258,7 +266,7 @@ <h5>Returns:</h5>
<dl>
<dt>Type</dt>
<dd>
<span class="param-type">Array.&lt;<a href="BidsIssue.html">BidsIssue</a>></span>
<span class="param-type">Array.&lt;<a href="BidsHedIssue.html">BidsHedIssue</a>></span>
</dd>
</dl>
</article>
Expand Down Expand Up @@ -288,6 +296,7 @@ <h3>Classes</h3>
<li><a href="HedStringParser.html">HedStringParser</a></li>
<li><a href="HedStringTokenizer.html">HedStringTokenizer</a></li>
<li><a href="Issue.html">Issue</a></li>
<li><a href="IssueError_IssueError.html">IssueError</a></li>
<li><a href="ParsedHedColumnSplice.html">ParsedHedColumnSplice</a></li>
<li><a href="ParsedHedString.html">ParsedHedString</a></li>
<li><a href="ParsedHedSubstring.html">ParsedHedSubstring</a></li>
Expand Down Expand Up @@ -348,7 +357,6 @@ <h3>Global</h3>
<li><a href="global.html#getElementCount">getElementCount</a></li>
<li><a href="global.html#getElementTagName">getElementTagName</a></li>
<li><a href="global.html#getElementTagValue">getElementTagValue</a></li>
<li><a href="global.html#getGenerationForSchemaVersion">getGenerationForSchemaVersion</a></li>
<li><a href="global.html#getParentTag">getParentTag</a></li>
<li><a href="global.html#getTagListString">getTagListString</a></li>
<li><a href="global.html#getTagName">getTagName</a></li>
Expand All @@ -358,6 +366,8 @@ <h3>Global</h3>
<li><a href="global.html#hedStringIsAGroup">hedStringIsAGroup</a></li>
<li><a href="global.html#isClockFaceTime">isClockFaceTime</a></li>
<li><a href="global.html#isDateTime">isDateTime</a></li>
<li><a href="global.html#isDeprecated">isDeprecated</a></li>
<li><a href="global.html#isExtended">isExtended</a></li>
<li><a href="global.html#isNumber">isNumber</a></li>
<li><a href="global.html#loadBundledSchema">loadBundledSchema</a></li>
<li><a href="global.html#loadLocalSchema">loadLocalSchema</a></li>
Expand All @@ -367,7 +377,7 @@ <h3>Global</h3>
<li><a href="global.html#localSchemaList">localSchemaList</a></li>
<li><a href="global.html#mergeSchemas">mergeSchemas</a></li>
<li><a href="global.html#normalized">normalized</a></li>
<li><a href="global.html#parseHedString">parse</a></li>
<li><a href="global.html#parseHedString">parseHedString</a></li>
<li><a href="global.html#parseHedStrings">parseHedStrings</a></li>
<li><a href="global.html#parseSchemaXML">parseSchemaXML</a></li>
<li><a href="global.html#parseTSV">parseTSV</a></li>
Expand Down Expand Up @@ -401,7 +411,7 @@ <h3>Global</h3>
<br class="clear" />

<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.4</a> on Sat Feb 08 2025 11:13:20
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.4</a> on Wed Feb 26 2025 06:00:12
GMT-0600 (Central Standard Time)
</footer>

Expand Down
10 changes: 6 additions & 4 deletions docs/html/BidsHedIssue_BidsHedIssue.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ <h5>Parameters:</h5>
<ul class="dummy">
<li>
<a href="bids_types_issues.js.html">bids/types/issues.js</a>,
<a href="bids_types_issues.js.html#line65">line 65</a>
<a href="bids_types_issues.js.html#line53">line 53</a>
</li>
</ul>
</dd>
Expand Down Expand Up @@ -110,6 +110,7 @@ <h3>Classes</h3>
<li><a href="HedStringParser.html">HedStringParser</a></li>
<li><a href="HedStringTokenizer.html">HedStringTokenizer</a></li>
<li><a href="Issue.html">Issue</a></li>
<li><a href="IssueError_IssueError.html">IssueError</a></li>
<li><a href="ParsedHedColumnSplice.html">ParsedHedColumnSplice</a></li>
<li><a href="ParsedHedString.html">ParsedHedString</a></li>
<li><a href="ParsedHedSubstring.html">ParsedHedSubstring</a></li>
Expand Down Expand Up @@ -170,7 +171,6 @@ <h3>Global</h3>
<li><a href="global.html#getElementCount">getElementCount</a></li>
<li><a href="global.html#getElementTagName">getElementTagName</a></li>
<li><a href="global.html#getElementTagValue">getElementTagValue</a></li>
<li><a href="global.html#getGenerationForSchemaVersion">getGenerationForSchemaVersion</a></li>
<li><a href="global.html#getParentTag">getParentTag</a></li>
<li><a href="global.html#getTagListString">getTagListString</a></li>
<li><a href="global.html#getTagName">getTagName</a></li>
Expand All @@ -180,6 +180,8 @@ <h3>Global</h3>
<li><a href="global.html#hedStringIsAGroup">hedStringIsAGroup</a></li>
<li><a href="global.html#isClockFaceTime">isClockFaceTime</a></li>
<li><a href="global.html#isDateTime">isDateTime</a></li>
<li><a href="global.html#isDeprecated">isDeprecated</a></li>
<li><a href="global.html#isExtended">isExtended</a></li>
<li><a href="global.html#isNumber">isNumber</a></li>
<li><a href="global.html#loadBundledSchema">loadBundledSchema</a></li>
<li><a href="global.html#loadLocalSchema">loadLocalSchema</a></li>
Expand All @@ -189,7 +191,7 @@ <h3>Global</h3>
<li><a href="global.html#localSchemaList">localSchemaList</a></li>
<li><a href="global.html#mergeSchemas">mergeSchemas</a></li>
<li><a href="global.html#normalized">normalized</a></li>
<li><a href="global.html#parseHedString">parse</a></li>
<li><a href="global.html#parseHedString">parseHedString</a></li>
<li><a href="global.html#parseHedStrings">parseHedStrings</a></li>
<li><a href="global.html#parseSchemaXML">parseSchemaXML</a></li>
<li><a href="global.html#parseTSV">parseTSV</a></li>
Expand Down Expand Up @@ -223,7 +225,7 @@ <h3>Global</h3>
<br class="clear" />

<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.4</a> on Sat Feb 08 2025 11:13:20
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.4</a> on Wed Feb 26 2025 06:00:12
GMT-0600 (Central Standard Time)
</footer>

Expand Down
Loading
Loading