HED JavaScript Library
    Preparing search index...

    Class ReservedChecker

    Index
    noExtensionTags requiresDefTags requireValueTags reservedNames timelineTags twoPartValueTags reservedMap valueForms
    checkHedString checkTagGroupLevels checkTopGroupRequirements checkUnique getGoverningTag getInstance hasGroupAttribute hasTopLevelTagGroupAttribute
    noExtensionTags: Set<string>
    requiresDefTags: Set<string>
    requireValueTags: Set<string>
    reservedNames: Set<string>
    timelineTags: Set<string>
    twoPartValueTags: Set<string>
    reservedMap: Map<string, Object> = ...

    The rows of the reserved-tag file, keyed by tag name.

    valueForms: Map<string, Object> = ...

    The value forms of the tags whose value has two parts, keyed by tag name.

    • Perform syntactical checks on the provided HED string to detect violations.

      Parameters

      • hedString: ParsedHedString

        The HED string to be checked.

      • fullValidation: boolean

        If true, perform full validation; otherwise, perform a quick check.

      Returns Issue[]

      An array of issues if violations are found otherwise, an empty array.

    • Check whether tags are not in groups -- or top-level groups as required

      Parameters

      • hedString: ParsedHedString

        The HED string to be checked for reserved tag syntax.

      • fullValidation: boolean

        If true, perform full validation; otherwise, perform a quick check.

      Returns Issue[]

      An array of Issue objects if there are violations; otherwise, an empty array.

    • Check the group rules of the reserved tags. The levels have already been verified.

      Parameters

      • hedString: ParsedHedString

        The HED string to check for group conflicts.

      Returns Issue[]

      An array of Issue objects if there are violations; otherwise, an empty array.

      Notes: Each group is checked against the row of its governing tag: the number of anchors and inner groups and the other tags allowed at its top level.

    • Check for tags with the unique attribute.

      Parameters

      • hedString: ParsedHedString

        The HED string to be checked for tags with the unique attribute.

      Returns Issue[]

      An array of Issue objects if there are violations; otherwise, an empty array.

    • Return the reserved tag whose row gives the group rules (specification 3.2.8 rule 3).

      Parameters

      • reservedTags: ParsedHedTag[]

        The top-level reserved tags of one group.

      Returns any

      The only tag or, for two tags of which one lists the other in its secondaryWith, that other tag; null for any other combination, which cannot share a group.

    • Return a boolean indicating whether a tag is required to be in a tag group.

      Parameters

      • tag: ParsedHedTag

        The HED tag to be checked.

      Returns boolean

      If true, this indicates that tag must be in a tag group.

      Note: This checks both reserved and schema tag requirements.

    • Indicate whether a tag should be a top-level tag.

      Parameters

      • tag: ParsedHedTag

        HED tag to check for top-level requirements.

      Returns boolean

      If true, the tag is required to be at the top level.

      Note: This check both the reserved requirements and the 'topLevelTagGroup' attribute in the schema.

    Settings
    Member Visibility

    On This Page
    Properties
    Methods