GraphIntegralParameter Class Reference

GraphIntegralParameter class is used to specify a required parameter when calculating the loop integral for graph data.
The class can be called from Application class.
. More...

Public Member Functions
void	AddDataSet (DataSet *dataset)
	Specifies a data set to calculate the loop integral for. More...
bool	IsCreateGraph ()
	Returns True if the graph will be created. More...
bool	IsValid ()
	Returns True if an object is valid. More...
Variant	Max ()
	Returns the maximum value for the integral range. More...
Variant	Min ()
	Returns the minimum value for the integral range. More...
String	RangeUnit ()
	Returns the notation for the range unit. More...
void	SetCreateGraph (bool createGraph)
	Specifies whether to create a graph. More...
void	SetMax (Variant &val)
	Specifies the maximum common parameter range value. More...
void	SetMin (Variant &val)
	Specifies the minimum common parameter range value. More...
void	SetRangeUnit (String &val)
	Specifies the unit for the min/max values. More...
String	Title ()
	Returns the title of the new graph. More...

Detailed Description

GraphIntegralParameter class is used to specify a required parameter when calculating the loop integral for graph data.
The class can be called from Application class.
.

Example of creating the class object:

app.CreateGraphIntegralParameter("loop_integral_title")

Member Function Documentation

void GraphIntegralParameter::AddDataSet

(

DataSet *

dataset

)

Specifies a data set to calculate the loop integral for.

Parameters

dataset

DataSet object

bool GraphIntegralParameter::IsCreateGraph

(

)

Returns True if the graph will be created.

Returns

Graph creation flag

bool GraphIntegralParameter::IsValid

(

)

Returns True if an object is valid.

Returns

Whether or not the GraphIntegralParameter object is valid

Variant GraphIntegralParameter::Max

(

)

Returns the maximum value for the integral range.

Returns

Maximum value

Variant GraphIntegralParameter::Min

(

)

Returns the minimum value for the integral range.

Returns

Minimum value

String GraphIntegralParameter::RangeUnit

(

)

Returns the notation for the range unit.

Returns

Range unit

void GraphIntegralParameter::SetCreateGraph

(

bool

createGraph

)

Specifies whether to create a graph.

Parameters

createGraph

Whether to create a graph True=1 : Creates a graph False=0 : Does not create a graph

createGraph can be omitted. When it is omitted, the value is specified as False (a graph is not created).

void GraphIntegralParameter::SetMax

(

Variant &

max

)

Specifies the maximum common parameter range value.

Parameters

max	Maximum parameter range value

void GraphIntegralParameter::SetMin

(

Variant &

min

)

Specifies the minimum common parameter range value.

Parameters

min	Minimum parameter range value

void GraphIntegralParameter::SetRangeUnit

(

String &

val

)

Specifies the unit for the min/max values.

Parameters

val	Notation for the unit

String GraphIntegralParameter::Title

(

)

Returns the title of the new graph.

Returns

Title of new graph