Sample Class Methods
- Last UpdatedNov 06, 2025
- 6 minute read
For a list of all members of this type, see Sample members.
| Name | Description | |
|---|---|---|
  | Add | The Add() method adds a new Sample record to the Sample table. |
| Cancel | The Cancel() method updates the sample status column with cancel (8) for the specified sample record in the Sample table. |
| Delete | The Delete() method deletes the specified sample record from the Sample table. |
| FinalizeSampleData | The FinalizeSampleData() method marks the specified sample in the Sample table as final. |
| FinalizeSampleDataAsync | The FinalizeSampleDataAsync() asynchronous method marks the specified sample in the Sample table as final. |
| GenerateSample | The GenerateSample() method adds a new sample to the sample table and creates one or more records in the Sample_Char_Link table. |
| GenerateSampleAsync | The GenerateSampleAsync() asynchronous method adds a new sample to the sample table and creates one or more records in the Sample_Char_Link table.
The GenerateSampleAsync() asynchronous method adds a new sample to the sample table and creates one or more records in the Sample_Char_Link table. Note: The Suppress Message represents internal code only and is not part of the GenerateSampleAsync method. |
| GetAll | Overloaded. The GetAll() method retrieves one or more sample records from the Sample table, as specified by the filter parameters. Passing no filter parameters will retrieve all sample records from the table. |
| GetByFilter | Overloaded. The GetByFilter() method retrieves a set of sample records from the Sample table based on the input filters and from the specified time range. |
| GetByKey | The GetByKey() method retrieves the specified sample record from the Sample table. |
| GetChars | The GetChars() method retrieves the characteristic link records for all of the characteristics linked to the specified sample record. |
| GetChartDataByFilter | Overloaded. For the specified characteristic, the GetChartDataByFilter() method retrieves the chart data for all samples that match the filter parameters. Passing no filter parameters will retrieve all the measurements for all of the characteristic's samples. |
| GetChartFilters | The GetChartFilters() gets the chart filters for the specified characteristic by finding the sample with the most recent measurement in the Result table and getting the filter values from that sample. |
| GetChartPoint | The GetChartPoint() method retrieves all the chart data for a single sample point. A sample point can have multiple measurements for it. |
| GetChartTypeByFilter | Overloaded. The GetChartTypeByFilter() method retrieves the chart type and the data for determining the control limits for a characteristic identified by its ID, with optional sample filters. Passing no filter parameters will retrieve the chart type for the most recent sample entered for the characteristic. |
| GetControlRules | The GetControlRules() retrieves the list of control rules that have been linked to the specified QM specification, excluding any control rule that has been excluded from use with the specified characteristic. |
| RecordSampleData | The RecordSampleData() method updates a sample record in the Sample table. |
| RecordSampleDataAsync | The RecordSampleDataAsync() asynchronous method updates a sample record in the Sample table. |
| SetSamplePulled | The SetSamplePulled() method updates the pulled_by and pulled_time fields of the specified sample record in the Sample table to set the sample as having been pulled. The pulled_by field will be set to the currently logged in user. The time at which the sample was pulled can be specified. If it's not, it will be set to the current time. |
| SetSampleUnpulled | The SetSampleUnpulled() method sets the specified sample record as unpulled by nulling out the pulled_by and pulled_time fields in the Sample Table. A sample can be unpulled as long as no results have been collected for any of the characteristic associated with the specified sample. |
| ToggleSampleFinalFlag | The ToggleSampleFinalFlag() method updates the final and finalized_at fields of the specified sample record in the Sample table to set the final state of the sample. If the sample is being set to final, the finalized_by field will be set to the the user specified or, if one is not specfied, the currently logged in user. If the sample is being set as not final, the finalized_by field will be set to null. For a sample that is being set to final, the time at which the sample was finalized at can also be specified. If it's not, it will be set to the current time. If a sample is being set as not final, the finalized_at field will be set to null. |
| Update | The Update() method updates all fields for the specified sample record in the Sample table. |
| UpdateSpecific | The UpdateSpecific() method updates selected columns of the specified sample record in the Sample table. |