Skip to end of metadata
Go to start of metadata

SPC Settings is used as part of a user's scripts to filter and display SPC samples. Its functions can retrieve an entire Sample Definition, or just specific properties, such as Attributes, Locations, Rules (Signals) and Control Limits. A sub-set, 'helper' object, SPC Definition, that executes faster (doesn't load the entire Sample Definition object) can be loaded by getDefinition() (see below). See SPC Definition for a list of available function.


Properties


 createSettings(definitionName, attribute, filters, controlLimits, signals, dataFormatName)
Description

 Create a new instance of a SPCSettings object based on the parameters.

Syntax

createSettings(definitionName, attribute, filters, controlLimits, signals, dataFormatName)


  • Parameters

String definitionName - The sample definition name for the new settings.

String attribute - The attribute name for the new settings.

String filters - The filters for the new settings. Multiple filter expressions can be separated by commas.

String controlLimits - The control limits for the new settings.  Multiple control limits can be separated by commas.

String signals - The SPC rules (signals) for the new settings.  Multiple SPC rules can be separated by commas.

String dataFormatName - The data format (control chart type) for the new settings.

  • Returns

 A new instance of a SPCSettings object.

 decodeFilters(filterList)
Description

 Decode a list of SPC filter expressions into a java Map object. Each filter key can have multiple filter values.

Syntax

decodeFilters(filterList)


  • Parameters

An instance of a java List object containing SPC filter expression strings. Example: "Location=Enterprise\Site\Area\Quality Test Station 1, Location=Enterprise\Site\Area\Quality Test Station 2, Product Code=DEF"

  • Returns

 An instance of a java Map. The map key is the filter name. For example, "Location" or "Product Code". The value for the key contains a java List object containing all of the filter values. For example, the key "Location" can have the filters values of "Quality Station 1" and "Quality Station 2".

 decodeList(input)
Description

 Decode a string that can represent a SPC filter, control limits, SPC rules (signals), etc. into a java List object. The input string will be parsed on wither the comma or pipe (|) character and each parsed result will be added to the returned List object.

Syntax

decodeList(input)


  • Parameters

The string value to parse.

  • Returns

 A java List object containing the parsed strings.

 decodeParams(optionalParams)
Description

 Decode a list of SPC parameters into a java Map object. Each parameter key can have only one parameter value.

Syntax

decodeParams(optionalParams)


  • Parameters

A string containing optional parameters separated by either the comma or pipe (|) characters. Example: "PaddingBarCount=4,RowLimit=100,DataBarCount=7,IncludeDisabledAttributes=true"

  • Returns

 An instance of a java Map containing key value pairs.

 encodeList(list)
Description

 Encode the specified java List into a single string separated by the pipe (\) character.

Syntax

encodeList(list)


  • Parameters

An instance of a java List object containing string values.

  • Returns

A single string containing all of the items from the list. 

 formatDate(date)
Description

Returns a string for the specified date to is formatted correctly for a filter expression.

Syntax

formatDate()


  • Parameters

A Date object to format.

  • Returns

A SPC settings formatted date string.

 getAdditionalFactors()
Description

Gets the additional factors defined with this SPC settings.

Syntax

getAdditionalFactors()


  • Parameters

None

  • Returns

String additionalFactors - The additional factors defined with this SPC settings.

 getAttribute()
Description

Returns the attribute for this settings.

Syntax

getAttribute()


  • Parameters

None

  • Returns

String attribute - The attribute associated with this SPC settings.

 getControlLimits()
Description

Returns the control limits for this SPC settings.

Syntax

getControlLimits()


  • Parameters

None

  • Returns

String controlLimits - The control limits associated with this setting.

 getDataFormat()
Description

Returns the data format associated with this settings.

Syntax

getDataFormat()


  • Parameters

None

  • Returns

SPCDataFormat - The data format associated with this setting.

 getDefinition()
Description

Gets the SPC definition.

Syntax

getDefinition()


  • Parameters

None

  • Returns

SPCDefinition - The definition corresponding to this settings.

 getErrorMessage()
Description

Returns an error message if any.

Syntax

getErrorMessage()


  • Parameters

None

  • Returns

String message - Any error messages are returned, otherwise an empty string is returned.

 getFilters()
Description

Gets the filters of the specified SPC settings.

Syntax

getFilters()


  • Parameters

None

  • Returns

String filters - The filters associated with this SPC settings. 

 getId()
Description

Gets the identifier for this SPC setting.

Syntax

getId()


  • Parameters

None

  • Returns

Integer id - The identifier for this setting.

 getMeasurement()
Description

Gets the measurement.

Syntax

getMeasurement()


  • Parameters

None

  • Returns

 String measurement - The measurement corresponding to this setting.

 getNonconformingFilter()
Description

Gets the non conforming filter for the setting.

Syntax

getNonconformingFilter()


  • Parameters

None

  • Returns

String nonconformingFilter - The non conforming filter for this setting.

 getOptionalParams()
Description

Returns the optional parameters for this setting (PaddingBarCount, RowLimit, DataBarCount, and IncludeDisabledAttributes).

Syntax

getOptionalParams()


  • Parameters

None

  • Returns

String optionalParams - Returns a string containing all four optional parameters and their values, separated by commas. Example: "PaddingBarCount=4,RowLimit=100,DataBarCount=7,IncludeDisabledAttributes=true"

 getSignals()
Description

Gets the signals associated with this settings.

Syntax

getSignals()


  • Parameters

None

  • Returns

String signals - The signals associated with this settings.

 hasError()
Description

Checks if there is any error in the settings.

Syntax

hasError()


  • Parameters

None

  • Returns

boolean True if there is any error and False otherwise.

 setAdditionalFactors(additionalFactors)
Description

Sets the additional factors for the SPC settings.

Syntax

setAdditionalFactors(additionalFactors)


  • Parameters

String additionalFactors - The additional factors to set for.

  • Returns

Nothing

 setAttribute(attribute)
Description

Sets the attribute for this setting.

Syntax

setAttribute(attribute)


  • Parameters

String attribute - The attribute to set for.

  • Returns

Nothing

 setControlLimits(controlLimits)
Description

Sets the control limits for this SPC setting.

Syntax

setControlLimits(controlLimits)


  • Parameters

String controlLimits - The control limits to set for.

  • Returns

Nothing

 setDataFormat(dataFormat)
Description

Sets the data format for this SPC setting.

Syntax

setDataFormat(dataFormat)


  • Parameters

SPCDataFormat - The data format to set for.

  • Returns

Nothing
 

 setDefinition(definition)
Description

Sets the SPC definition.

Syntax

setDefinition(definition)


  • Parameters

SPCDefinition - The definition to set for.

  • Returns

Nothing

 setErrorMessage(errorMessage)
Description

Sets the error message for this SPC setting.

Syntax

setErrorMessage(errorMessage)


  • Parameters

String errorMessage - The error message to set for.

  • Returns

Nothing

 setFilters(filters)
Description

Sets the filters for this SPC setting.

Syntax

setFilters(filters)


  • Parameters

String filters - The filters to set for.

  • Returns

Nothing

 setId(id)
Description

Sets the id for this setting.

Syntax

setId(id)


  • Parameters

Integer id - The id to set for.

  • Returns

Nothing

 setMeasurement(measurement)
Description

Sets the measurement for the SPC setting. 

Syntax

setMeasurement(measurement)


  • Parameters

String measurement - This is the full name of the measurement number such as "Measurement 1", "Measurement 2" or "Measurement 17".

  • Returns

Nothing

...
settings = system.quality.spc.settings.createSettings(definitionName, attribute, filter, controlLimits, signals, dataFormat ) 
settings.setMeasurement('Measurement 2')
...
 setNonconformingFilter(filter)
Description

Sets the non conforming filter for the settings.

Syntax

setNonconformingFilter(filter)


  • Parameters

String nonconformingFilter - The filter to set for.

  • Returns

Nothing

 setOptionalParams(optionalParams)
Description

Sets the optional parameters for this SPC settings.

Syntax

setOptionalParams(optionalParams)


  • Parameters

String optionalParams - The optional parameters to set for. Use a string containing all four optional parameters and their values, separated by either commas or pipes (|).
Example: "PaddingBarCount=4,RowLimit=100,DataBarCount=7,IncludeDisabledAttributes=true"

  • Returns

Nothing

 setParetoFilter(paretoFilter)
Description

Sets the pareto filter for this SPC settings.

Syntax

setParetoFilter(paretoFilter)


  • Parameters

String paretoFilter - The filter to set for.

  • Returns

Nothing

 setSignals(signals)
Description

Set signals for this SPC setting.

Syntax

setSignals(signals)


  • Parameters

String signals - Signals to set for.

  • Returns

Nothing






  • No labels