Sample Additional Factor

Sepasoft MES Module Suite

The sample additional factor object holds all of the information associated with one sample.

Object Functions


getDataType()

Description

Returns the data type of this additional factor. See DataType in the Ignition documentation for more information.

Syntax

getDataType()


  • Parameters

None

  • Returns

 The data type of this additional factor.

Code Example

Copy Code
Code
uuid = '3b4ffd1a-43f4-4cef-9e7c-7f722a01b513'
sample = system.mes.spc.sample.getSample(uuid)
factor = sample.getAddlFactor('factor 1')
print factor.getDataType()
>>> 
String
>>>

getName()

Description

Returns the name of this additional factor.

Syntax

getName()


  • Parameters

None

  • Returns

 Name of the additional factor.

getRecordDateTime()

Description

Returns the date and time the value was recorded for this additional factor.

Syntax

 getRecordDateTime()


  • Parameters

None

  • Returns

Date and time the value was recorded for this additional factor.

Code Example

Copy Code
Code
uuid = '3b4ffd1a-43f4-4cef-9e7c-7f722a01b513'
sample = system.mes.spc.sample.getSample(uuid)
factor = sample.getAddlFactor('factor 1')
print factor.getRecordDateTime()

getValue()

Description

Returns the value for this additional factor.

Syntax

getValue()


  • Parameters

None

  • Returns

Object value - The value of this additional factor.

Code Example

Copy Code
Code
sampleUUID = '3b4ffd1a-43f4-4cef-9e7c-7f722a01b513'
sample = system.mes.spc.sample.getSample(sampleUUID)
factor = sample.getAddlFactor('factor 1')
print factor.getValue()
>>> 
12345
>>>

isModified()

Description

Returns true if this additional factor has been modified.

Syntax

isModified()


  • Parameters

None

  • Returns

True, if this additional factor has been modified.

isNew()

Description

Returns true if this additional factor has been modified.

Syntax

isNew()


  • Parameters

None

  • Returns

True, if this additional factor has been modified.

resetModified()

Description

This script function will undo the modifications.

Syntax

resetModified()


  • Parameters

None

  • Returns

Nothing

updateValue(value, recordDateTime)

Description

Updates the value and the required date and time that is being recorded for this additional factor.

Syntax

updateValue(value, recordDateTime)


  • Parameters

Object value - The value to be updated.

Date recordDateTime - The date and time that this value is recorded.

  • Returns

Nothing

Code Example

Copy Code
Code
uuid = '3b4ffd1a-43f4-4cef-9e7c-7f722a01b513'
sample = system.mes.spc.sample.getSample(uuid)
factor = sample.getAddlFactor('factor 1')
date = factor.getRecordDateTime()
factor.updateValue('1111',date)
system.mes.spc.sample.update(sample, False)




Sepasoft MES Module Suite