hed3

class Hed3Validator(parsedString, hedSchemas, definitions, options)

Hed3Validator class

Constructor.

Arguments:

  • parsedString (ParsedHedString) – The parsed HED string to be validated.

  • hedSchemas (Schemas) – The collection of HED schemas.

  • definitions (Map.<string, ParsedHedGroup>) – The parsed definitions.

  • options (Object.<string, boolean>) – The validation options.

Hed3Validator.Hed3Validator

Constructor.

Hed3Validator.definitions

type: Map.<string, ParsedHedGroup>

The parsed definitions.

Hed3Validator.checkDefinitionGroupSyntax(tagGroup)

Check the syntax of HED 3 definitions.

Arguments:
Hed3Validator.checkDefinitionStringSyntax()

Check full-string Definition syntax.

Hed3Validator.checkForInvalidTopLevelTagGroupTags()

Check for tags marked with the topLevelTagGroup attribute that are not in top-level tag groups.

Hed3Validator.checkForInvalidTopLevelTags()

Check for invalid top-level tags.

Hed3Validator.checkForMissingDefinitions(tag, defShortTag="Def")

Check for missing HED 3 definitions.

Arguments:

  • tag (ParsedHedTag) – The HED tag.

  • defShortTag (string) – The short tag to check for.

Hed3Validator.checkIfTagIsValid(tag, previousTag)

Check if an individual HED tag is in the schema or is an allowed extension.

Hed3Validator.checkIfTagUnitClassUnitsAreValid(tag)

Check that the unit is valid for the tag’s unit class.

Arguments:
Hed3Validator.checkPlaceholderStringSyntax()

Check full-string placeholder syntax.

Hed3Validator.checkPlaceholderTagSyntax(tag)

Check basic placeholder tag syntax.

Arguments:
Hed3Validator.checkTemporalSyntax(tagGroup)

Check the syntax of HED 3 onsets and offsets.

Arguments:
Hed3Validator.checkValueTagSyntax(tag)

Check the syntax of tag values.

Arguments:
Hed3Validator.validateFullParsedHedString()

Validate the full parsed HED string.

Hed3Validator.validateHedTagGroup(parsedTagGroup)

Validate a HED tag group.

Hed3Validator.validateIndividualHedTag(tag, previousTag)

Validate an individual HED tag.

Hed3Validator.validateTopLevelTagGroups()

Validate the top-level HED tag groups in a parsed HED string.

Hed3Validator.validateTopLevelTags()

Validate the top-level HED tags in a parsed HED string.

Hed3Validator.validateUnits(tag)

Validate a unit and strip it from the value.

Arguments:
Returns:

Hed3Validator.validateValue(value, isNumeric)

Determine if a stripped value is valid.

Arguments:

  • value (string) – The stripped value.

  • isNumeric (boolean) – Whether the tag is numeric.