Documentation of 'jhplot.io.FileAida' Java class.
FileAida
jhplot.io

Class FileAida



  • public class FileAida
    extends java.lang.Object
    Open an AIDA file and retrieve objects for plotting. Used to read AIDA files
    • Constructor Summary

      Constructors 
      Constructor and Description
      FileAida()
      Create FileAida
      FileAida(java.lang.String file)
      Create object to read AIDA file.
      FileAida(java.lang.String file, boolean readOnly)
      Create object to read AIDA file.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      void cd(java.lang.String dir)
      Navigate to a directory inside the file
      void close()
      Close the file
      void doc()
      Show online documentation.
      java.lang.Object get(java.lang.String skey)
      Get object associated with the key name
      java.util.ArrayList<IManagedObject> getAll()
      Get list of all objects
      java.util.ArrayList<java.lang.String> getAllNames()
      Get list of all objects
      java.util.ArrayList<java.lang.String> getAllNames(java.lang.String a)
      Get list of all objects
      java.util.ArrayList<java.lang.String> getAllTypes()
      Get list of all types
      java.util.ArrayList<java.lang.String> getAllTypes(java.lang.String a)
      Get list of all types
      ITree getITree()
      Return ITree for further manipulations
      java.lang.String[] listObjectNames()
      List name of the objects inside trees
      void load(java.io.File f, boolean readOnly)
      Load a AIDA file
      void load(java.lang.String file, boolean readOnly)
      Load a AIDA file
      java.lang.String pwd()
      Print the current directory
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • FileAida

        public FileAida(java.lang.String file)
        Create object to read AIDA file. Read only mode.
        Parameters:
        file - Input AIDA file
      • FileAida

        public FileAida(java.lang.String file,
                        boolean readOnly)
        Create object to read AIDA file. Read only mode.
        Parameters:
        file - Input AIDA file
        readOnly -
      • FileAida

        public FileAida()
        Create FileAida
    • Method Detail

      • load

        public void load(java.lang.String file,
                         boolean readOnly)
        Load a AIDA file
        Parameters:
        f - input file
        readOnly - - only read
      • load

        public void load(java.io.File f,
                         boolean readOnly)
        Load a AIDA file
        Parameters:
        f - input file
        readOnly - - only read
      • get

        public java.lang.Object get(java.lang.String skey)
        Get object associated with the key name
        Parameters:
        skey - key name
        Returns:
        Object
      • listObjectNames

        public java.lang.String[] listObjectNames()
        List name of the objects inside trees
        Returns:
        object types
      • getAllNames

        public java.util.ArrayList<java.lang.String> getAllNames(java.lang.String a)
        Get list of all objects
        Parameters:
        a - path
        Returns:
        list of all objects
      • getAllNames

        public java.util.ArrayList<java.lang.String> getAllNames()
        Get list of all objects
        Returns:
        list of all objects
      • getAllTypes

        public java.util.ArrayList<java.lang.String> getAllTypes()
        Get list of all types
        Returns:
        list of all types
      • getAllTypes

        public java.util.ArrayList<java.lang.String> getAllTypes(java.lang.String a)
        Get list of all types
        Parameters:
        a - path
        Returns:
        list of all types
      • cd

        public void cd(java.lang.String dir)
        Navigate to a directory inside the file
      • pwd

        public java.lang.String pwd()
        Print the current directory
        Parameters:
        show - current directory
      • close

        public void close()
                   throws java.io.IOException
        Close the file
        Throws:
        java.io.IOException
      • getAll

        public java.util.ArrayList<IManagedObject> getAll()
        Get list of all objects
        Returns:
        list of all objects
      • getITree

        public ITree getITree()
        Return ITree for further manipulations
        Returns:
        ITree
      • doc

        public void doc()
        Show online documentation.

DMelt 3.0 © DataMelt by jWork.ORG