📄 swarm.analysis.ezgraph.protocol.html
字号:
<HTML><HEAD><TITLE>EZGraph</TITLE><METANAME="GENERATOR"CONTENT="Modular DocBook HTML Stylesheet Version 1.53"><LINKREL="HOME"TITLE="Documentation Set for Swarm 2.1.1"HREF="set.html"><LINKREL="UP"TITLE="Analysis Library"HREF="swarm.analysis.sgml.reference.html"><LINKREL="PREVIOUS"TITLE="EZDistribution"HREF="swarm.analysis.ezdistribution.protocol.html"><LINKREL="NEXT"TITLE="EZSequence"HREF="swarm.analysis.ezsequence.protocol.html"></HEAD><BODYCLASS="REFENTRY"BGCOLOR="#FFFFFF"TEXT="#000000"LINK="#0000FF"VLINK="#840084"ALINK="#0000FF"><DIVCLASS="NAVHEADER"><TABLEWIDTH="100%"BORDER="0"CELLPADDING="0"CELLSPACING="0"><TR><THCOLSPAN="3"ALIGN="center">Documentation Set for Swarm 2.1.1</TH></TR><TR><TDWIDTH="10%"ALIGN="left"VALIGN="bottom"><AHREF="swarm.analysis.ezdistribution.protocol.html">Prev</A></TD><TDWIDTH="80%"ALIGN="center"VALIGN="bottom">Reference IX. Analysis Library</TD><TDWIDTH="10%"ALIGN="right"VALIGN="bottom"><AHREF="swarm.analysis.ezsequence.protocol.html">Next</A></TD></TR></TABLE><HRALIGN="LEFT"WIDTH="100%"></DIV><H1><ANAME="SWARM.ANALYSIS.EZGRAPH.PROTOCOL">EZGraph</A></H1><DIVCLASS="REFNAMEDIV"><ANAME="AEN22017"></A><H2>Name</H2>EZGraph -- A class for easily create graphs.</DIV><DIVCLASS="REFSECT1"><ANAME="AEN22020"></A><H2>Description</H2><P> This class allows the user to easily create graphs of various quantities in the model s/he is investigating. The user first creates the EZGraph, and then creates "Sequences"; (lines) which will appear in the graph. The sequences are generated based on data provided by a single object or a collection of target objects, in reponse to a specified selector. One of the features of the EZGraph is that it will automatically generate average, total, min, max and count sequences without the user having to mess with Averagers amd other low-level classes.</P></DIV><DIVCLASS="REFSECT1"><ANAME="AEN22023"></A><H2>Protocols adopted by EZGraph</H2><P> <AHREF="swarm.objectbase.swarmobject.protocol.html">SwarmObject</A> <AHREF="swarm.simtoolsgui.guicomposite.protocol.html">GUIComposite</A> <AHREF="swarm.defobj.creatable.protocol.html">CREATABLE</A></P></DIV><DIVCLASS="REFSECT1"><ANAME="AEN22029"></A><H2>Methods</H2><DIVCLASS="REFSECT2"><ANAME="AEN22031"></A><H3>Phase: Creating</H3><P></P><UL><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ANALYSIS.EZGRAPH.METHOD.PC.M45"></A><P></P>+ <BCLASS="FUNCPROTOTYPE">create:</B> (id <Zone>)<VARCLASS="PDPARAM">aZone</VAR> <BCLASS="FUNCPROTOTYPE">setTitle:</B> (const char *)<VARCLASS="PDPARAM">aTitle</VAR> <BCLASS="FUNCPROTOTYPE">setAxisLabelsX:</B> (const char *)<VARCLASS="PDPARAM">xl</VAR> <BCLASS="FUNCPROTOTYPE">Y:</B> (const char *)<VARCLASS="PDPARAM">yl</VAR> <BCLASS="FUNCPROTOTYPE">setWindowGeometryRecordName:</B> (const char *)<VARCLASS="PDPARAM">windowGeometryRecordName</VAR> <BR> Convenience method for creating `graphical' EZGraph instances<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ANALYSIS.EZGRAPH.METHOD.PC.M15"></A><P></P>+ <BCLASS="FUNCPROTOTYPE">create:</B> (id <Zone>)<VARCLASS="PDPARAM">aZone</VAR> <BCLASS="FUNCPROTOTYPE">setFileOutput:</B> (BOOL)<VARCLASS="PDPARAM">fileOutputFlag</VAR> <BR> Convenience method for creating a non-graphical EZGraph, the filename is generated from the sequence name<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ANALYSIS.EZGRAPH.METHOD.PC.M14"></A><P></P>+ <BCLASS="FUNCPROTOTYPE">create:</B> (id <Zone>)<VARCLASS="PDPARAM">aZone</VAR> <BCLASS="FUNCPROTOTYPE">setFileName:</B> (const char *)<VARCLASS="PDPARAM">aFileName</VAR> <BR> Convenience method for creating a non-graphical EZGraph, in this case, the filename is explicitly set by the user<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ANALYSIS.EZGRAPH.METHOD.PC.M767"></A><P></P>- <BCLASS="FUNCPROTOTYPE">setGraphics:</B> (BOOL)<VARCLASS="PDPARAM">state</VAR> <BR> The setGraphics method sets the state of the display. Set the state to 0 if a graphical display of the graph is not required. The default state is 1 meaning that by default the data appears graphically in a window. <P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ANALYSIS.EZGRAPH.METHOD.PC.M757"></A><P></P>- <BCLASS="FUNCPROTOTYPE">setFileOutput:</B> (BOOL)<VARCLASS="PDPARAM">state</VAR> <BR> The setFileOutput method sets the state of file I/O. Set the state to 1 if data for the sequences is to be sent to a file. The default state is 0 meaning that by default no file I/O is carried out by the EZGraph class.<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ANALYSIS.EZGRAPH.METHOD.PC.M755"></A><P></P>- <BCLASS="FUNCPROTOTYPE">setFileName:</B> (const char *)<VARCLASS="PDPARAM">aFileName</VAR> <BR> The setFileName method sets the name used for disk file data output. (Only relevant if the state of setFileOutput is set to 1.) The name set here is prepended to the names of each data sequence. If file name is NOT set, with this method, the file name for the sequence will default simply to the sequence name.<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ANALYSIS.EZGRAPH.METHOD.PC.M883"></A><P></P>- <BCLASS="FUNCPROTOTYPE">setTitle:</B> (const char *)<VARCLASS="PDPARAM">aTitle</VAR> <BR> The setTitle method uses a title string to label a graph window in the graphical version of EZGraph. The label appears at the top of the graph window. (Only relevant if the state of setGraphics is set to 1.)<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ANALYSIS.EZGRAPH.METHOD.PC.M678"></A><P></P>- <BCLASS="FUNCPROTOTYPE">setAxisLabelsX:</B> (const char *)<VARCLASS="PDPARAM">xl</VAR> <BCLASS="FUNCPROTOTYPE">Y:</B> (const char *)<VARCLASS="PDPARAM">yl</VAR> <BR> The setAxisLabels:X:Y method sets the horizontal and vertical labels on the histogram in the graphical version of EZGraph. (Only relevant if the state of setGraphics is set to 1.)<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ANALYSIS.EZGRAPH.METHOD.PC.M710"></A><P></P>- <BCLASS="FUNCPROTOTYPE">setColors:</B> (const char * const *)<VARCLASS="PDPARAM">colors</VAR> <BCLASS="FUNCPROTOTYPE">count:</B> (unsigned)<VARCLASS="PDPARAM">nc</VAR> <BR> Set a custom vector of colors for the graph lines<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ANALYSIS.EZGRAPH.METHOD.PC.M228"></A><P></P>- <BCLASS="FUNCPROTOTYPE">createEnd</B><BR><P></P></DIV></LI></UL></DIV><DIVCLASS="REFSECT2"><ANAME="AEN22139"></A><H3>Phase: Using</H3><P></P><UL><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ANALYSIS.EZGRAPH.METHOD.PU.M839"></A><P></P>- <BCLASS="FUNCPROTOTYPE">setRangesXMin:</B> (double)<VARCLASS="PDPARAM">xmin</VAR> <BCLASS="FUNCPROTOTYPE">Max:</B> (double)<VARCLASS="PDPARAM">xmax</VAR> <BR> Fix the range of X values on the graph between some range.<P></P></DIV></LI><LI><DIVCLASS="FUNCSYNOPSIS"><ANAME="SWARM.ANALYSIS.EZGRAPH.METHOD.PU.M841"></A><P></P>- <BCLASS="FUNCPROTOTYPE">setRangesYMin:</B> (double)<VARCLASS="PDPARAM">ymin</VAR
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -