Action
    Preparing search index...

    Class StdfTableReader

    This class provides a simple interface for reading data on the STDF format.

    2.1

    Hierarchy (View Summary)

    Index

    Methods

    Cast Equals GetHashCode ToString TryCast Equals

    Default capability

    constructor ColumnCount TableMetadata Close Dispose ReadLine ReadValue Reset TryParseFormatHeader

    Methods

    • Casts this object to the specified type. Throws error on failure.

      Type Parameters

      • T1

        The target type of the cast.

      • T2

        The type of the object to cast.

      Parameters

      Returns T1

    • Determines whether the specified object is equal to the current object.

      Parameters

      • obj: any

        The object to compare with the current object.

      Returns boolean

      true if the specified object is equal to the current object; otherwise, false.

    • Serves as the default hash function.

      Returns number

      A hash code for the current object.

    • Returns a string that represents the current object.

      Returns string

      A string that represents the current object.

    • Casts this object to the specified type. Returns null on failure.

      Type Parameters

      • T1

        The target type of the cast.

      • T2

        The type of the object to cast.

      Parameters

      Returns null | T1

    • Determines whether the specified object instances are considered equal.

      Parameters

      • objA: any

        The first object to compare.

      • objB: any

        The second object to compare.

      Returns boolean

      true if the objects are considered equal; otherwise, false. If both objA and objB are null, the method returns true.

    Default capability

    • get ColumnCount(): number

      Gets the column count.

      Returns number

      2.1

    • Closes this StdfTableReader instance. Will close the input stream.

      Returns void

      2.1

    • Disposes of this StdfTableReader instance. Will close the input stream.

      Returns void

      2.1

    • Reads the end of line marker on the current row. Must be invoked after ReadValue has been called for all the columns on the row, and before the first value on the next row can be read.

      Returns void

      2.1

    • Reads and parses the next value from the input.

      Returns unknown

      An object representing the next value on the current row. A null value is returned to mark the end of the input.

      2.1

    • Resets the input stream and starts reading from the beginning.

      Returns void

      2.1

    • Given an input stream, this method tries to parse the first line as an STDF file header.

      Parameters

      Returns boolean

      True if the file starts with an STDF header; otherwise, false.

      The method throws exception only in case of I/O problems, and never when there are format issues. The reason is to avoid inconvenient hangs in debugger sessions, when trap on exception is turned on and the application searches for a matching file type.

      2.1

    Settings

    Member Visibility

    On This Page

    Methods
    Default capability