com.ibm.rational.test.lt.kernel.logging

Interface IAnnotation



  • public interface IAnnotation
    • Method Detail

      • isActive

        boolean isActive()
        Return true iff the annotation is accepting data.
        Returns:
        boolean
      • write

        IAnnotation.Location write(byte[] data)
        write bytes to the queue for processing.
        Parameters:
        data - the data to put in the annotation file
        Returns:
        the offset in the file where the bytes will be written.
      • stopAnnotation

        void stopAnnotation()
        stop the annotation service. Causes isActive() to return false, drains the queue and stops the thread Don't return until finished.
      • stopAnnotation

        void stopAnnotation(boolean waitFlag)
        stop the annotation service. Causes isActive() to return false, drains the queue and stops the thread If waitFlag is true, don't return until finished. Otherwise, return immediately
        Parameters:
        waitFlag -
      • deleteFile

        void deleteFile()
        delete the annotation file.
      • setTargetEventId

        void setTargetEventId(String id)
        save the event id of the history event which will receive the annotation.
        Parameters:
        id -
      • getTargetEventId

        String getTargetEventId()
        get the saved target event id
        Returns:
        the target event id
      • getFileNameList

        ArrayList<String> getFileNameList()
        return the full path name of the local file to which the annotation data was written.
        Returns:
        the full path name of the local file
      • getWBDirectory

        String getWBDirectory()
        return the workbench path set in the constructor
        Returns:
        the workbench path name
      • getFileSize

        int getFileSize()
        Returns:
        the current size of the first annotation file
      • getFileSize

        int getFileSize(int n)
        Parameters:
        n - the index into the file list of the file in question
        Returns:
        the size of the nth file in the file list
IBM Rational Performance Tester SDK

© Copyright IBM Corp. 2013. All rights reserved.