ResponseTableCustomGraphOption Class Reference

ResponseTableCustomGraphOption class    is used to set the custom graph of the response table.
   The class can be created from the Study class.
. More...

Public Member Functions

String ExtractAxis ()
    Gets the series set as the extraction source. More...
 
double ExtractTargetValue ()
    Gets the set target X-value for extraction. More...
 
int ExtractType ()
    Gets the specified extraction method. More...
 
bool IsValid ()
    Returns True if an object is valid. More...
 
void SetExtractAxis (String &axis)
    Sets the source series. More...
 
void SetExtractTargetValue (double value)
    Sets the target X-value for extraction when the extraction method is set to "Specified". More...
 
void SetExtractType (int type)
    Sets the extraction method. More...
 
void SetSwapXYAxis (bool on)
    Sets whether to swap the X and Y axes. More...
 
void SetTitle (String &title)
    Sets the title. More...
 
void SetUseExtract (bool on)
    Sets to True if you want to specify the source series. More...
 
bool SwapXYAxis ()
    Gets the flag indicating whether the X and Y axes are swapped. More...
 
String Title ()
    Gets the title. More...
 
bool UseExtract ()
    Gets whether the source series is specified. More...
 

Detailed Description

ResponseTableCustomGraphOption class    is used to set the custom graph of the response table.
   The class can be created from the Study class.
.

Example of calling the class object:

ref = app.GetModel(0).GetStudy(0).CreateResponseTableCustomDefinition()

Member Function Documentation

String ResponseTableCustomGraphOption::ExtractAxis ( )

   Gets the series set as the extraction source.

Returns
Type name of the series
double ResponseTableCustomGraphOption::ExtractTargetValue ( )

   Gets the set target X-value for extraction.

Returns
Target X-value for extraction
int ResponseTableCustomGraphOption::ExtractType ( )

   Gets the specified extraction method.

Returns
Flag for the extraction method
bool ResponseTableCustomGraphOption::IsValid ( )

   Returns True if an object is valid.

Returns
Whether or not the ResponseTableCustomGraphOption object is valid
void ResponseTableCustomGraphOption::SetExtractAxis ( String &  axis)

   Sets the source series.

Parameters
axisType name of the series
void ResponseTableCustomGraphOption::SetExtractTargetValue ( double  value)

   Sets the target X-value for extraction when the extraction method is set to "Specified".

Parameters
valueTarget X-value for extraction
void ResponseTableCustomGraphOption::SetExtractType ( int  type)

   Sets the extraction method.

Parameters
typeFlag for the extraction method
0 : Specified Value
1 : Maximum Value
void ResponseTableCustomGraphOption::SetSwapXYAxis ( bool  on)

   Sets whether to swap the X and Y axes.

Parameters
onFlag to specify swapping
True: Swap
False: Do not swap
void ResponseTableCustomGraphOption::SetTitle ( String &  title)

   Sets the title.

Parameters
titleTitle string
void ResponseTableCustomGraphOption::SetUseExtract ( bool  on)

   Sets to True if you want to specify the source series.

Parameters
on
True : Specifies the source series.
False : Does not specify the source series.
bool ResponseTableCustomGraphOption::SwapXYAxis ( )

   Gets the flag indicating whether the X and Y axes are swapped.

Returns
True if swapped, otherwise False.
String ResponseTableCustomGraphOption::Title ( )

   Gets the title.

Returns
Title string
bool ResponseTableCustomGraphOption::UseExtract ( )

   Gets whether the source series is specified.

Returns
True if specified, otherwise False.