Class default

constructor

• new default(tagSpec: TagSpec, hedSchemas: Schemas, hedString: string): default

  Constructor.

  Parameters

  • tagSpec: TagSpec

    The token for this tag.
  • hedSchemas: Schemas

    The collection of HED schemas.
  • hedString: string

    The original HED string.

  Returns default

  Throws

  If tag conversion or parsing fails.

_normalized

canonicalTag

formattedTag

schema

isDeprecated

• get isDeprecated(): boolean

  Indicates whether the tag is deprecated

  Returns boolean

isExtended

• get isExtended(): boolean

  Indicates whether the tag is deprecated

  Returns boolean

normalized

• get normalized(): string

  Return the normalized version of this tag.

  Returns string

  • The normalized version of this tag.

schemaTag

• get schemaTag(): SchemaTag

  Get the schema tag object for this tag.

  Returns SchemaTag

  The schema tag object for this tag.

takesValueTag

• get takesValueTag(): SchemaValueTag

  Get the schema tag object for this tag's value-taking form.

  Returns SchemaValueTag

  The schema tag object for this tag's value-taking form.

unitClasses

• get unitClasses(): SchemaUnitClass[]

  Get the unit classes for this HED tag.

  Returns SchemaUnitClass[]

  The unit classes for this HED tag.

_convertTag

• _convertTag(hedSchemas: Schemas, hedString: string, tagSpec: TagSpec): void

  Convert this tag to its various forms

  Parameters

  • hedSchemas: Schemas

    The collection of HED schemas.
  • hedString: string

    The original HED string.
  • tagSpec: TagSpec

    The token for this tag.

  Returns void

  Throws

  If tag conversion or parsing fails.

_getSplitValue

• _getSplitValue(remainder: string): string[]

  Handle reserved three-level tags.

  Parameters

  • remainder: string

    The remainder of the tag string after schema tag.

  Returns string[]

_separateUnits

• _separateUnits(schemaTag: SchemaTag, remainder: string): any[]

  Separate the remainder of the tag into three parts.

  Parameters

  • schemaTag: SchemaTag

    The part of the tag that is in the schema.
  • remainder: string

    The leftover part.

  Returns any[]

  • [SchemaUnit, string, string] representing the actual Unit, the unit string and the value string.

  Throws

  • If parsing the remainder section fails.

checkValue

• checkValue(value: string): string

  Check if value is a valid value for this tag.

  Parameters

  • value: string

    The value to be checked.

  Returns string

  An empty string if value is value, otherwise an indication of failure.

equivalent

• equivalent(other: default): boolean

  Determine if this HED tag is equivalent to another HED tag.

  Note: HED tags are deemed equivalent if they have the same schema and normalized tag string.

  Parameters

  • other: default

    A HED tag to compare with this one.

  Returns boolean

  Whether the other tag is equivalent to this HED tag.

format

• format(long?: boolean): string

  Nicely format this tag.

  Parameters

  • long: boolean = true

    Whether the tags should be in long form.

  Returns string

  • The nicely formatted version of this tag.

hasAttribute

• hasAttribute(attribute: string): boolean

  Determine whether this tag has a given attribute.

  Parameters

  • attribute: string

    An attribute name.

  Returns boolean

  Whether this tag has the named attribute.

isUnitClass

• isUnitClass(): boolean

  Checks if this HED tag has the unitClass attribute.

  Returns boolean

  Whether this HED tag has the unitClass attribute.

takesValue

• takesValue(): boolean

  Checks if this HED tag has the takesValue attribute.

  Returns boolean

  Whether this HED tag has the takesValue attribute.

toString

• toString(): string

  Override of Object.prototype.toString.

  Returns string

  The original form of this HED tag.