XeStylized Class Reference

An object which can be drawn with style (actually XeStyle). More...

#include <XeCore.h>

Inheritance diagram for XeStylized:

List of all members.

Public Member Functions
virtual void	applyStyle ()
	Virtual method applying the XeStyle to the object.
virtual void	draw (string options="L", int flag=0)=0
	Pure virtual method applying the XeStyle to the object.
void	drawFrame (double xmi=AUTOMATIC, double xma=AUTOMATIC, double ymi=AUTOMATIC, double yma=AUTOMATIC, int xScale=AUTO, int yscale=AUTO)
	Draw a Frame to hold the object.
void	drawIt (int plot, string options="L", int flag=0)
	Optional draw of the stylized object.
void	drawWithCanvasAndFrame (string options="C", int flag=0)
	Draw the object with its canvas and frame.
void	drawWithFrame (string options="C", int flag=0)
	Draw the object with its frame.
virtual string	generatedXLabel ()
	automatic generation of X label
virtual string	generatedYLabel ()
	automatic generation of Y label
int	getDefaultXScale ()
	get default X scale
int	getDefaultYScale ()
	get default Y scale
int	getFillColor ()
int	getFillStyle ()
int	getLineColor ()
int	getLineStyle ()
int	getLineWidth ()
int	getMarkerColor ()
double	getMarkerSize ()
int	getMarkerStyle ()
virtual double	getMaxX ()=0
	Pure virtual method returning X maximum value.
virtual double	getMaxY ()=0
	Pure virtual method returning Y maximum value.
virtual double	getMinX ()=0
	Pure virtual method returning X minimum value.
virtual double	getMinY ()=0
	Pure virtual method returning Y minimum value.
virtual double	getMinYNotZero ()=0
	Pure virtual method returning Y minimum value for those different from 0.
XeStyle *	getStyle ()
string	getXLabel ()
string	getYLabel ()
string	getZLabel ()
void	printStyle ()
void	setDefaultXScale (int scale)
	set default x scale
void	setDefaultYScale (int scale)
	set default y scale
void	setFillColor (int color=DEFAULT_FILL_COLOR)
void	setFillProperties (int color=DEFAULT_FILL_COLOR, int style=DEFAULT_FILL_STYLE)
void	setFillStyle (int width=DEFAULT_FILL_STYLE)
void	setLineColor (int color=DEFAULT_LINE_COLOR)
void	setLineProperties (int color=DEFAULT_LINE_COLOR, int width=DEFAULT_LINE_WIDTH, int style=DEFAULT_LINE_STYLE)
void	setLineStyle (int style=DEFAULT_LINE_STYLE)
void	setLineStyleColor (int index=0)
	Set line color according to predefined "reasonable" style.
void	setLineWidth (int width=DEFAULT_LINE_WIDTH)
void	setMarkerColor (int color=DEFAULT_MARKER_COLOR)
void	setMarkerProperties (int color=DEFAULT_MARKER_COLOR, double size=DEFAULT_MARKER_SIZE, int style=DEFAULT_MARKER_STYLE)
void	setMarkerSize (double size=DEFAULT_MARKER_SIZE)
void	setMarkerStyle (int style=DEFAULT_MARKER_STYLE)
void	setMarkerStyleColor (int index=0)
	Set marker color according to predefined "reasonable" style.
void	setRainbowColor (int index, int nC, int mode=ASYMMETRIC)
	set the color according the rainbow
void	setStyle (XeStyle *style=NULL)
	Set the object style.
void	setXLabel (string xL)
void	setXYLabels (string xL="", string yL="", string zL="")
	Set the labels.
void	setYLabel (string yL)
void	setZLabel (string zL)
	XeStylized (string name, string xL="", string yL="", string zL="")
Protected Attributes
int	defaultXScale
int	defaultYScale
XeStyle	style
string	xLabel
string	yLabel
string	zLabel

---

Detailed Description

An object which can be drawn with style (actually XeStyle).

---

Constructor & Destructor Documentation

XeStylized::XeStylized	(	string	name,
		string	xL = "",
		string	yL = "",
		string	zL = ""
	)

Returns:

constructor

Parameters:

	Object	name
	xL	X-label when object drawing
	yL	Y-label when object drawing
	zL	Z-label when object drawing

---

Member Function Documentation

virtual void XeStylized::draw	(	string	options = "L",
		int	flag = 0
	)			[pure virtual]

Pure virtual method applying the XeStyle to the object.

Parameters:

	options	drawing options
	flag	multipurpose flag

Implemented in XeGraph, XeMultiGraph, and SensitivityBands.

void XeStylized::drawFrame	(	double	xmi = AUTOMATIC,
		double	xma = AUTOMATIC,
		double	ymi = AUTOMATIC,
		double	yma = AUTOMATIC,
		int	xScale = AUTO,
		int	yscale = AUTO
	)

Draw a Frame to hold the object.

Parameters:

	xmi	MinX (or AUTOMATIC)
	xma	MaxX (or AUTOMATIC)
	ymi	MinY (or AUTOMATIC)
	yma	MaxY (or AUTOMATIC)
	xScale	can be LINEAR, LOG, AUTO
	yscale	can be LINEAR, LOG, AUTO

void XeStylized::drawIt	(	int	plot,
		string	options = "L",
		int	flag = 0
	)

Optional draw of the stylized object.

Parameters:

	plot	either NONE, AUTO, LINEAR, or LOG
	options	drawing options
	flag	multipurpose flag

void XeStylized::drawWithCanvasAndFrame	(	string	options = "C",
		int	flag = 0
	)

Draw the object with its canvas and frame.

Parameters:

	options	drawing options
	flag	multipurpose flag

void XeStylized::drawWithFrame	(	string	options = "C",
		int	flag = 0
	)

Draw the object with its frame.

Parameters:

	options	drawing options
	flag	multipurpose flag

int XeStylized::getDefaultXScale

(

)

get default X scale

Returns:

LINEAR or LOG

int XeStylized::getDefaultYScale

(

)

get default Y scale

Returns:

LINEAR or LOG

void XeStylized::setDefaultXScale

(

int

scale

)

set default x scale

Parameters:

scale

LINEAR or LOG

void XeStylized::setDefaultYScale

(

int

scale

)

set default y scale

Parameters:

scale

LINEAR or LOG

void XeStylized::setLineStyleColor

(

int

index = 0

)

Set line color according to predefined "reasonable" style.

Parameters:

index

Index in the color scheme

void XeStylized::setMarkerStyleColor

(

int

index = 0

)

Set marker color according to predefined "reasonable" style.

Parameters:

index

Index in the color scheme

void XeStylized::setRainbowColor	(	int	index,
		int	nC,
		int	mode = ASYMMETRIC
	)

set the color according the rainbow

Parameters:

	index	index (0 is at purple, last one is red)
	nC	number of indices (if SYMMETRIC, nC=2*colors+1)
	mode	ASYMMETRIC or SYMMETRIC, whether we have one or two rainbows

void XeStylized::setStyle

(

XeStyle *

style = NULL

)

Set the object style.

Parameters:

style

XeStyle to be applied to the object

void XeStylized::setXYLabels	(	string	xL = "",
		string	yL = "",
		string	zL = ""
	)

Set the labels.

Parameters:

	xL	X-label when object drawing
	yL	Y-label when object drawing
	zL	Z-label when object drawing

---

The documentation for this class was generated from the following file:

• /home/lellouch/Dropbox/Xenon/Xephyr/XeCore.h