EnumData

See also:

Format Specification or Source Specification for EnumData.

class types.hdmf_experimental.EnumData(varargin)[source]

Bases: types.hdmf_common.VectorData, types.untyped.DatasetClass

ENUMDATA - Data that come from a fixed set of values. A data value of i corresponds to the i-th value in the VectorData referenced by the ‘elements’ attribute.

Required Properties*:

data, description, elements

Constructor Summary
EnumData(varargin)

ENUMDATA - Constructor for EnumData

Syntax:

enumData = types.hdmf_experimental.ENUMDATA() creates a EnumData object with unset property values.

enumData = types.hdmf_experimental.ENUMDATA(Name, Value) creates a EnumData object where one or more property values are specified using name-value pairs.

Input Arguments (Name-Value Arguments):

  • data (uint8) - Data property for dataset class (EnumData)

  • description (char) - Description of what these vectors represent.

  • elements (Object reference to VectorData) - Reference to the VectorData object that contains the enumerable elements

Output Arguments:
Property Summary
elements

REQUIRED (Object reference to VectorData) Reference to the VectorData object that contains the enumerable elements

Method Summary
validate_elements(val)

Reference to type VectorData

Tip

* If a required property link is not functional, the property may be defined in a superclass. Please refer to the superclass documentation.