Class WideChar32DataType

    • Field Detail

      • dataType

        public static final WideChar32DataType dataType
        A statically defined WideCharDataType instance.
    • Constructor Detail

      • WideChar32DataType

        public WideChar32DataType()
    • Method Detail

      • getLength

        public int getLength()
        Description copied from interface: DataType
        Get the length (number of 8-bit bytes) of this DataType.
        Specified by:
        getLength in interface DataType
        Returns:
        the length of this DataType
      • getDescription

        public java.lang.String getDescription()
        Description copied from interface: DataType
        Get a String briefly describing this DataType.
        Specified by:
        getDescription in interface DataType
        Returns:
        a one-liner describing this DataType.
      • getBuiltInSettingsDefinitions

        protected SettingsDefinition[] getBuiltInSettingsDefinitions()
        Description copied from class: BuiltIn
        Gets a list of all the settingsDefinitions used by this datatype.
        Overrides:
        getBuiltInSettingsDefinitions in class BuiltIn
        Returns:
        a list of the settingsDefinitions used by this datatype.
      • clone

        public DataType clone​(DataTypeManager dtm)
        Description copied from interface: DataType
        Returns a new instance of this DataType with its universalID and SourceArchive identity retained. Note: for built-in DataType's, clone and copy should have the same affect.
        Specified by:
        clone in interface DataType
        Parameters:
        dtm - the data-type manager instance whose data-organization should apply.
      • getRepresentation

        public java.lang.String getRepresentation​(MemBuffer buf,
                                                  Settings settings,
                                                  int length)
        Description copied from interface: DataType
        Get bytes from memory in a printable format for this type.
        Specified by:
        getRepresentation in interface DataType
        Parameters:
        buf - the data.
        settings - the settings to use for the representation.
        length - the number of bytes to represent.
        Returns:
        the representation of the data in this format, never null.
      • getValue

        public java.lang.Object getValue​(MemBuffer buf,
                                         Settings settings,
                                         int length)
        Description copied from interface: DataType
        Get the data in the form of the appropriate Object for this DataType. For instance if the data type is an AddressDT, return an Address object. a Byte, return a Scalar* (maybe this should be a Byte) a Float, return a Float
        Specified by:
        getValue in interface DataType
        Parameters:
        buf - the data buffer.
        settings - the settings to use.
        length - the number of bytes to get the value from.
        Returns:
        the data Object.
      • getValueClass

        public java.lang.Class<?> getValueClass​(Settings settings)
        Description copied from interface: DataType
        Get the Class of the value to be returned by this data type.
        Specified by:
        getValueClass in interface DataType
        Overrides:
        getValueClass in class DataTypeImpl
        Parameters:
        settings - the relevant settings to use or null for default.
        Returns:
        Class of the value to be returned by this data type or null if it can vary or is unspecified. Types which correspond to a string or char array will return the String class.
      • getDefaultLabelPrefix

        public java.lang.String getDefaultLabelPrefix​(MemBuffer buf,
                                                      Settings settings,
                                                      int length,
                                                      DataTypeDisplayOptions options)
        Description copied from interface: DataType
        Returns the appropriate string to use as the default label prefix.
        Specified by:
        getDefaultLabelPrefix in interface DataType
        Overrides:
        getDefaultLabelPrefix in class AbstractDataType
        Parameters:
        buf - memory buffer containing the bytes.
        settings - the Settings object
        options - options for how to format the default label prefix.
        Returns:
        the default label prefix or null if none specified.
      • getDefaultLabelPrefix

        public java.lang.String getDefaultLabelPrefix()
        Description copied from interface: DataType
        Returns the appropriate string to use as the default label prefix in the absence of any data.
        Specified by:
        getDefaultLabelPrefix in interface DataType
        Overrides:
        getDefaultLabelPrefix in class AbstractDataType
        Returns:
        the default label prefix or null if none specified.
      • hasStringValue

        public boolean hasStringValue​(Settings settings)
        Description copied from interface: ArrayStringable
        For cases where an array of this type exists, determines if a String value will be returned.

        Specified by:
        hasStringValue in interface ArrayStringable
        Returns:
        true if array of this type with the specified settings will return a String value.
      • getArrayDefaultLabelPrefix

        public java.lang.String getArrayDefaultLabelPrefix​(MemBuffer buf,
                                                           Settings settings,
                                                           int len,
                                                           DataTypeDisplayOptions options)
        Description copied from interface: ArrayStringable
        For cases where an array of this type exists, get the appropriate string to use as the default label prefix for the array.
        Specified by:
        getArrayDefaultLabelPrefix in interface ArrayStringable
        Parameters:
        buf - memory buffer containing the bytes.
        settings - the Settings object
        options - options for how to format the default label prefix.
        Returns:
        the default label prefix or null if none specified.
      • getArrayDefaultOffcutLabelPrefix

        public java.lang.String getArrayDefaultOffcutLabelPrefix​(MemBuffer buf,
                                                                 Settings settings,
                                                                 int len,
                                                                 DataTypeDisplayOptions options,
                                                                 int offcutOffset)
        Description copied from interface: ArrayStringable
        For cases where an array of this type exists, get the appropriate string to use as the default label prefix, taking into account the fact that there exists a reference to the data that references offcutLength bytes into this type
        Specified by:
        getArrayDefaultOffcutLabelPrefix in interface ArrayStringable
        Parameters:
        buf - memory buffer containing the bytes.
        settings - the Settings object
        options - options for how to format the default label prefix.
        Returns:
        the default label prefix or null if none specified.
      • getCharsetName

        public java.lang.String getCharsetName​(Settings settings)
        Description copied from interface: DataTypeWithCharset
        Get the character set for a specific data type and settings
        Specified by:
        getCharsetName in interface DataTypeWithCharset
        Parameters:
        settings - data instance settings
        Returns:
        Charset for this datatype and settings