Package geomss.geom.reader

Class TecplotGeomReader

  • All Implemented Interfaces:
    GeomReader, java.lang.Comparable
    public class TecplotGeomReader
extends AbstractGeomReader
    A GeomReader for reading and writing geometry from/to an Tecplot ASCII formatted triangle file. The first 3 columns of data are assumed to be the X,Y,Z points.

    Modified by: Joseph A. Huwaldt

    Version:
    July 12, 2019
    Author:
    Joseph A. Huwaldt, Date: July 12, 2019

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String EXTENSION  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int canReadData​(java.io.File inputFile)
      Method that determines if this reader can read geometry from the specified input file.
      java.lang.String getExtension()
      Returns the preferred file extension (not including the ".") for files of this GeomReader's type.
      boolean isUnitAware()
      This method always returns false as TRI files do not encode the units that are being used.
      GeomList<TriangleList> read​(java.io.File inputFile)
      Reads in a Tecplot ASCII formatted triangle geometry file from the specified input file and returns a GeomList object that contains a set of TriangleList objects (1 for each "zone" in the Tecplot file).
      java.lang.String toString()
      Returns a string representation of the object.

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Method Detail

      • toString

        public java.lang.String toString()
        Returns a string representation of the object. This will return a brief description of the format read by this reader.
        Overrides:
        toString in class java.lang.Object
        Returns:
        A brief description of the format read by this reader.

      • getExtension

        public java.lang.String getExtension()
        Returns the preferred file extension (not including the ".") for files of this GeomReader's type.
        Returns:
        The preferred file extension for files of this readers type.

      • canReadData

        public int canReadData​(java.io.File inputFile)
                throws java.io.IOException
        Method that determines if this reader can read geometry from the specified input file.
        Specified by:
        canReadData in interface GeomReader
        Overrides:
        canReadData in class AbstractGeomReader
        Parameters:
        inputFile - The input file containing the geometry to be read in.
        Returns:
        GeomReader.NO if the file format is not recognized by this reader. GeomReader.YES if the file has the extension ".dat" and contains a Tecplot header.
        Throws:
        java.io.IOException - If there is a problem reading from the specified file.

      • read

        public GeomList<TriangleList> read​(java.io.File inputFile)
                            throws java.io.IOException
        Reads in a Tecplot ASCII formatted triangle geometry file from the specified input file and returns a GeomList object that contains a set of TriangleList objects (1 for each "zone" in the Tecplot file).

        WARNING: This file format is not unit aware. You must set the units to be used by calling "setFileUnits()" before calling this method!

        Specified by:
        read in interface GeomReader
        Overrides:
        read in class AbstractGeomReader
        Parameters:
        inputFile - The input file containing the geometry to be read in. May not be null.
        Returns:
        A GeomList object containing the geometry read in from the file. If the file has no geometry in it, then this list will have no triangles in it (will have a size() of zero).
        Throws:
        java.io.IOException - If there is a problem reading the specified file.
        See Also:
        AbstractGeomReader.setFileUnits(javax.measure.unit.Unit)

      • isUnitAware

        public boolean isUnitAware()
        This method always returns false as TRI files do not encode the units that are being used. You must call setFileUnits to set the units being used before reading from a file of this format.
        Returns:
        This implementation always returns false.
        See Also:
        AbstractGeomReader.setFileUnits(javax.measure.unit.Unit)