Sepasoft MES Module Suite
This object holds the evaluation results for an attribute signal combination.
Event Methods
getDefinitionName()
Description
Returns definition name of the signal which was evaluated.
Syntax
getDefinitionName()
- Parameters
None
- Returns
String definitionName - The definition name of this signal.
getSignalName()
Description
Returns the name of the signal associated with this result.
Syntax
getSignalName()
- Parameters
None
- Returns
String name - Name of the evaluated signal.
getAttributeName()
Description
Returns the name of the attribute associated with this result.
Syntax
getAttributeName()
- Parameters
None
- Returns
String attributeName - Name of the attribute associated with this result.
getViolatingSampleDate()
Description
Returns the date of the most recent sample that is in violation of the signal.
Syntax
getViolatingSampleDate()
- Parameters
None
- Returns
Date violatingSampleDate - The date of sample to which the violation of signal has occurred recently.
setViolatingSampleDate(violatingSampleDate)
Description
Set the date of the most recent sample that is in violation of the signal.
Syntax
setViolatingSampleDate(violatingSampleDate)
- Parameters
Date violatingSampleDate - The date of the most recent sample that is in violation of the signal.
- Returns
Nothing
setLastSampleDate(lastSampleDate)
Description
Set the date for the last approved sample.
Syntax
setLastSampleDate(lastSampleDate)
- Parameters
Date lastSampleDate - The date to be set for the sample which was recently approved.
- Returns
Nothing
getLastSampleDate()
Description
Returns the date of the last approved sample. This can be used in combination to determine if the last approved sample caused the signal violation.
Syntax
getLastSampleDate()
- Parameters
None
- Returns
Date lastSampleDate - The date to be set for the sample which was recently approved.
isSignalViolation()
Description
Returns true if the signal - attribute combination are in violation.
Syntax
isSignalViolation()
- Parameters
None
- Returns
boolean True if the signal is violated and False otherwise.
setEvaluationError(message)
Description
Set the message for any evaluation error.
Syntax
setEvaluationError(message)
- Parameters
String message - The note to be set for any evaluation error.
- Returns
None
isEvaluationError()
Description
Returns true if an error occurred during the signal evaluation.
Syntax
isEvaluationError()
- Parameters
None
- Returns
boolean True if an error occurred during the signal evaluation and False otherwise.
hasMessage()
Description
Returns true if a message exists.
Syntax
hasMessage()
- Parameters
None
- Returns
boolean - True if a message exists and False otherwise.
getMessage()
Description
Returns textual description of error encountered during the signal evaluation.
Syntax
getMessage()
- Parameters
None
- Returns
String message - The description of error encountered during the signal evaluation.
setMessage(message)
Description
Set the textual description of error encountered during the signal evaluation.
Syntax
setMessage(message)
- Parameters
String message - The note to be displayed when an error occurs.
- Returns
None
getLocationPath()
Description
Gets the location path for this evaluated signal.
Syntax
getLocationPath()
- Parameters
None
- Returns
String locationPath - The location path for this signal.
getPathSegment(segmentName)
Description
Gets the path for the specified segment.
Syntax
getPathSegment(segmentName)
- Parameters
String segmentName - Name of the segment to get the path for. Options: Enterprise, Site, Area, Line, Cell, Cell_group, Location, Storage_zone, Storage_unit.
- Returns
String pathSegment - The path segment corresponding to specified by segment name parameter.
Sepasoft MES Module Suite