DataSetParameter Class Reference

DataSetParameter class is used to specify a required parameter when creating a data set from a result in a study.
The class can be called from Application class.
. More...

Public Member Functions
void	AddPart (String &name)
	Specifies a part name for dataset. More...
void	AddStudy (String &name, int caseNo)
	Specifies a study or case to create a dataset. More...
void	SetComponent (String &name)
	Specifies the type of components (such as X-component, Y-component, and absolute value) for a result in a dataset. More...
void	SetCondition (String &name)
	Specifies condition title for a dataset. More...
void	SetResultTypeName (String &typeName)
	Specifies the type of result (such as hysteresis loss or torque) for a dataset. More...
void	SetStep (String &value)
	Specifies a step ID when [Selected] is set as the step specifying method for a dataset (type=Selected is set in the SetStepType command). Specifies a step interval when [Interval] is selected as the step specifying method for a dataset (type=Interval is selected in the SetStepType command). . More...
void	SetStepType (String &name)
	Specifies the step specification method for a dataset. More...

Detailed Description

DataSetParameter class is used to specify a required parameter when creating a data set from a result in a study.
The class can be called from Application class.
.

Example of creating the class object:

app.CreateDataSetParameter("dataset_title")

Member Function Documentation

void DataSetParameter::AddPart

(

String &

name

)

Specifies a part name for dataset.

Parameters

name

Part name

void DataSetParameter::AddStudy	(	String &	name,
		int	caseNo
	)

Specifies a study or case to create a dataset.

Parameters

name	Study name
caseNo	Index of the case

void DataSetParameter::SetComponent

(

String &

name

)

Specifies the type of components (such as X-component, Y-component, and absolute value) for a result in a dataset.

Parameters

name	Component type Absolute : Absolute value X : X-component Y : Y-component Z : Z-component

void DataSetParameter::SetCondition

(

String &

name

)

Specifies condition title for a dataset.

Parameters

name	Condition title

void DataSetParameter::SetResultTypeName

(

String &

typeName

)

Specifies the type of result (such as hysteresis loss or torque) for a dataset.

Parameters

typeName

Result type name

For information about the condition type name that can be specified as typeName , see Properties for the Table Display .

void DataSetParameter::SetStep

(

String &

value

)

Specifies a step ID when [Selected] is set as the step specifying method for a dataset (type=Selected is set in the SetStepType command).
Specifies a step interval when [Interval] is selected as the step specifying method for a dataset (type=Interval is selected in the SetStepType command).
.

Parameters

value

Step ID or step interval

The specified method is ignored when [All] is selected as the step specifying method for creating a dataset (type=all is selected in the SetStepType command).

void DataSetParameter::SetStepType

(

String &

name

)

Specifies the step specification method for a dataset.

Parameters

name	All Selected Interval