ExtractFrequencyParameter Class is used to specify a required parameter when running a extract frequency for graph data.
The class can be created from Application class.
.
More...
Public Member Functions | |
| bool | IsValid () |
| Returns True if an object is valid. More... | |
| void | SetAxisType (String &mapper) |
| Specifies the X-axis type (For example, time, steps, angle). More... | |
| void | SetCreateGraph (bool createGraph) |
| Specifies whether to create a graph. More... | |
| void | SetDataSet (DataSet *dataset) |
| Specifies a data set to run a extract frequency on. More... | |
| void | SetMax (Variant &val) |
| Specifies the maximum X-axis range. More... | |
| void | SetMin (Variant &val) |
| Specifies the minimum X-axis range. More... | |
| void | SetOrder (Variant &val) |
| Specifies the order. More... | |
| void | SetSeries (Variant &val) |
| Specifies the name or index of a line. More... | |
Detailed Description
ExtractFrequencyParameter Class is used to specify a required parameter when running a extract frequency for graph data.
The class can be created from Application class.
.
Example of calling the class object:
Member Function Documentation
| bool ExtractFrequencyParameter::IsValid | ( | ) |
Returns True if an object is valid.
- Returns
- Whether or not the ExtractFrequencyParameter object is valid
| void ExtractFrequencyParameter::SetAxisType | ( | String & | mapper | ) |
Specifies the X-axis type (For example, time, steps, angle).
- Parameters
-
type Name of the axis type
| void ExtractFrequencyParameter::SetCreateGraph | ( | bool | createGraph | ) |
Specifies whether to create a graph.
- Parameters
-
createGraph Whether to create a graphTrue=1 : Creates a graphFalse=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 ExtractFrequencyParameter::SetDataSet | ( | DataSet * | dataset | ) |
Specifies a data set to run a extract frequency on.
- Parameters
-
dataset DataSet object
| void ExtractFrequencyParameter::SetMax | ( | Variant & | max | ) |
Specifies the maximum X-axis range.
- Parameters
-
max Maximum X-axis range
| void ExtractFrequencyParameter::SetMin | ( | Variant & | min | ) |
Specifies the minimum X-axis range.
- Parameters
-
min Minimum X-axis range
| void ExtractFrequencyParameter::SetOrder | ( | Variant & | order | ) |
Specifies the order.
- Parameters
-
order Harmonic order
| void ExtractFrequencyParameter::SetSeries | ( | Variant & | val | ) |
Specifies the name or index of a line.
- Parameters
-
val Name or index of a line