ResponseDataParameter class is used to specify response graph parameters when creating response values from study results.
The class can be created from Application class.
. More...

Public Member Functions
bool	IsValid ()
	Returns True if an object is valid. More...

void	SetAllLine (bool allLine)
	Specifies if all the lines of the response graph data are selected. More...

void	SetCalculationType (String &type)
	Specifies calculation method of response graph data. More...

void	SetCaseRangeTable (VariantList &table)
	Specifies if all the lines of the response graph are selected. More...

void	SetCaseRangeType (Variant &type)
	Specifies whether to perform calculation for each case of the response graph data. More...

void	SetEndValue (Variant &end)
	Specifies the end point of the calculation range of a response graph data. More...

void	SetHarmonic (String &harmonic)
	Specifies harmonic order. For calculation type of 2D harmonic amplitude, this is a time order. More...

void	SetLine (Variant &value)
	Specifies a line for a a response graph data. More...

void	SetPeriodicity (String &periodicity)
	Specifies periodicity. For calculation type of 2D harmonic amplitude, this is a time periodicity. More...

void	SetRangeFromLastStep (Variant &value)
	Specifies the calculation range from the last range of a response graph data. More...

void	SetSpaceHarmonic (String &harmonic)
	Specifies space harmonic order for 2D harmonic amplitude. More...

void	SetSpacePeriodicity (String &periodicity)
	Specifies space periodicity for 2D harmonic amplitude. More...

void	SetStartValue (Variant &start)
	Specifies the start point of the calculation range of a response graph data. More...

void	SetThresholdValue (Variant &threshold)
	Specifies threshold value. More...

void	SetTitle (String &name)
	Specifies the title for a response graph. More...

void	SetUnit (String &xaxisunit)
	Specifies unit for a start point and end point in a response graph data. More...

void	SetVariable (String &variable)
	Specifies the variable name for a response graph data. More...

Detailed Description

ResponseDataParameter class is used to specify response graph parameters when creating response values from study results.
The class can be created from Application class.
.

Example of creating the class object:

app.CreateResponseDataParameter("result_title")

Member Function Documentation

bool ResponseDataParameter::IsValid ( )

Returns True if an object is valid.

Returns: Whether or not the ResponseDataParameter objects in the list are valid

void ResponseDataParameter::SetAllLine ( bool allLine )

Specifies if all the lines of the response graph data are selected.

Parameters

allLine

True=1 : Creates data for all lines.

False=0 : Creates data for a specified line.

void ResponseDataParameter::SetCalculationType ( String & type )

Specifies calculation method of response graph data.

Parameters

type

Type of calculation method
                         SimpleAverage : Simple average
                         IntegralAverage : Integration average
                         RMS : RMS (root mean square)
                         Minimum : Minimum value
                         Maximum : Maximum value
                         SingleValue : Single value
                         Range : Range (maximum value - minimum value)
                         RippleRate : Ripple rate
                         MaximumAbsoluteGradient : Maximum gradient (absolute value)
                         Sum : Total sum
                         Threshold : Time to threshold
                         AboveThreshold : Time above threshold
                         BelowThreshold : Time below threshold
                         Harmonic：Harmonic Amplitude
                         Harmonic Phase：Harmonic Phase
                         MaxInColumn: Maximum Value in Column
                         MaxDifference: Maximum (Lq-Ld)
                         MaxRatio: Maximum (Lq/Ld)
                         2DHarmonic: 2D Harmonic Amplitude

void ResponseDataParameter::SetCaseRangeTable ( VariantList & table )

Specifies if all the lines of the response graph are selected.

Parameters

table Table

void ResponseDataParameter::SetCaseRangeType ( Variant & type )

Specifies whether to perform calculation for each case of the response graph data.

Parameters

type	0 : Uses all steps in all cases 1 : Uses same value for all cases 2 : Specifies values for each case 3 : Uses interval before last step for all cases

void ResponseDataParameter::SetEndValue ( Variant & end )

Specifies the end point of the calculation range of a response graph data.

Parameters

end	End point for calculation range

void ResponseDataParameter::SetHarmonic ( String & harmonic )

Specifies harmonic order. For calculation type of 2D harmonic amplitude, this is a time order.

Parameters

harmonic Harmonic order

void ResponseDataParameter::SetLine ( Variant & value )

Specifies a line for a a response graph data.

Parameters

value Name or index of the line

void ResponseDataParameter::SetPeriodicity ( String & periodicity )

Specifies periodicity. For calculation type of 2D harmonic amplitude, this is a time periodicity.

Parameters

periodicity

Periodicity
                         none ： none
                         Half ： 1/2

void ResponseDataParameter::SetRangeFromLastStep ( Variant & value )

Specifies the calculation range from the last range of a response graph data.

Parameters

value Interval from last step

void ResponseDataParameter::SetSpaceHarmonic ( String & harmonic )

Specifies space harmonic order for 2D harmonic amplitude.

Parameters

harmonic Space harmonic order

void ResponseDataParameter::SetSpacePeriodicity ( String & periodicity )

Specifies space periodicity for 2D harmonic amplitude.

Parameters

periodicity

Space periodicity
                         none ： none
                         Half ： 1/2

void ResponseDataParameter::SetStartValue ( Variant & start )

Specifies the start point of the calculation range of a response graph data.

Parameters

start Start point for calculation range

void ResponseDataParameter::SetThresholdValue ( Variant & threshold )

Specifies threshold value.

Parameters

threshold Threshold value

void ResponseDataParameter::SetTitle ( String & name )

Specifies the title for a response graph.

Parameters

name	Name of the response graph data

void ResponseDataParameter::SetUnit ( String & xaxisunit )

Specifies unit for a start point and end point in a response graph data.

Parameters

xaxisunit Specifies units for start and end points Example: Time -> "s", Step -> "Step"

void ResponseDataParameter::SetVariable ( String & variable )

Specifies the variable name for a response graph data.

Parameters

variable Variable name

Public Member Functions

Detailed Description

Member Function Documentation