org.epics.graphene.profile.settings

Class SaveSettings

java.lang.Object

org.epics.graphene.profile.settings.SaveSettings

All Implemented Interfaces:

Settings

public class SaveSettings
extends Object
implements Settings

A general purpose collection of messages to be saved to a .CSV output file for profiling.

Includes various properties, such as author and dataset comments, as well as hardware comments such as RAM.

Author:

asbarber

Constructor Summary

Constructors

Constructor and Description
SaveSettings()

Method Summary

Methods

Modifier and Type	Method and Description
String	getAuthorMessage() Gets the author associated with the profile.
String	getDatasetMessage() Gets the comment associated with the data set.
Object[]	getOutput() List of headers for the data members.
BufferedImage	getSaveImage() Gets the image to be saved.
String	getSaveMessage() Gets the general comment associated with the profile.
Object[]	getTitle() List of headers for the data members.
void	setAuthorMessage(String author) Set the author associated with the profile.
void	setDatasetMessage(String message) Set the comment associated with the data set.
void	setSaveImage(BufferedImage saveImage) Sets the image to be saved.
void	setSaveMessage(String message) Set the general comment associated with the profile.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SaveSettings

public SaveSettings()

Method Detail

setDatasetMessage

public void setDatasetMessage(String message)

Set the comment associated with the data set. This comment will be written to the CSV log file when saving the statistics.

This is appropriate for discussing the distribution of the data, dimensions of the data, etc.

Parameters:

message - comment about the data

setSaveMessage

public void setSaveMessage(String message)

Set the general comment associated with the profile. This comment will be written to the CSV log file when saving the statistics.

This is appropriate for discussing the parameters of the renderer, etc.

Parameters:

message - general comment about the profiling

setAuthorMessage

public void setAuthorMessage(String author)

Set the author associated with the profile. This comment will be written to the CSV log file when saving the statistics.

This is appropriate for stating the user who profiled. This can help provide understanding in different results due to computer hardware differences.

Parameters:

author - author for the profiling

setSaveImage

public void setSaveImage(BufferedImage saveImage)

Sets the image to be saved. The image is one of the images rendered during profiling. This field is not written to the comments of the CSV log file.

Parameters:

saveImage - image of the graph to be saved

getDatasetMessage

public String getDatasetMessage()

Gets the comment associated with the data set. This comment will be written to the CSV log file when saving the statistics. This is appropriate for discussing the distribution of the data, dimensions of the data, etc.

Returns:

message about the data set

getSaveMessage

public String getSaveMessage()

Gets the general comment associated with the profile. This comment will be written to the CSV log file when saving the statistics. This is appropriate for discussing the parameters of the renderer, etc.

Returns:

general message about the profiling results

getAuthorMessage

public String getAuthorMessage()

Gets the author associated with the profile. This comment will be written to the CSV log file when saving the statistics.

This is appropriate for stating the user who profiled. This can help provide understanding in different results due to computer hardware differences.

Returns:

author for the profiling

getSaveImage

public BufferedImage getSaveImage()

Gets the image to be saved. The image is one of the images rendered during profiling. This field is not written to the comments of the CSV log file.

Returns:

image of the graph to be saved

getTitle

public Object[] getTitle()

List of headers for the data members.

Specified by:

getTitle in interface Settings

Returns:

header data fields

getOutput

public Object[] getOutput()

List of headers for the data members.

Specified by:

getOutput in interface Settings

Returns:

header data fields