ecl-logo Documentation

UploadReferenceElectrodeModel

UploadReferenceElectrodeModel[]referenceElectrodeModel

creates a new referenceElectrodeModel that contains information about the material, working limits, and storage conditions of the reference electrode.

UploadReferenceElectrodeModel[templateReferenceElectrodeModel]referenceElectrodeModel

creates a new referenceElectrodeModel with electrode-related information provided by options and with remaining parameters drew from the templateReferenceElectrodeModel.

Details

  • If an existing reference electrode model is found that matches all of the parameters specified for the new reference electrode model, the existing model is returned.
  • Reference electrode models generated with this function may be then prepared via ExperimentPrepareReferenceElectrode.
  • Input
    Output
    Compatibility Options
    Dimensions & Positions Options
    Electrode Cleaning Options
    Operating Limits Options
    Organizational Information Options
    Physical Properties Options
    Storage Information Options
    Wiring Information Options
    General Options

Examples

Basic Examples  (4)

Create a new reference electrode model from a template model and provide the new information using different options:

Create a new Blank reference electrode model with the provided the information provided in options, with Blank set to Null:

When a model with the same reference electrode parameters is already in the database, the existing model will be returned:

If a Name is specified, a new reference electrode model will be created even if there is already a model existing in the database with the same reference electrode parameters:

Additional Examples  (1)

When creating a new Blank reference electrode model, set Blank to Null, and ReferenceElectrodeType, SolutionVolume, Dimensions, BulkMaterial, CoatMaterial, ElectrodeShape, WiringConnectors, MaxNumberOfUses, MinPotential, MaxPotential, and SonicationSensitive are required to be explicitly specified. Name, Synonyms, DefaultStorageCondition, ElectrodePackagingMaterial, WiringDiameters, WiringLength, MaxNumberOfPolishings, WettedMaterials, IncompatibleMaterials are optional to be specified:

Options  (26)

Blank  (1)

Use the Blank option to specify the blank reference electrode model (this blank model can be used to prepare the new model by filling the blank with the ReferenceSolution defined in the new model) of the newly generated reference electrode model:

BulkMaterial  (1)

When uploading a new blank reference electrode model, use the BulkMaterial option to specify the conductive material (if the electrode is not coated) or the internal material (if the electrode is coated) of this newly generated reference electrode model:

CoatMaterial  (1)

When uploading a new blank reference electrode model, use the CoatMaterial option to specify the conductive material on the surface (if the electrode is coated) of this newly generated reference electrode model:

DefaultStorageCondition  (2)

When uploading a new blank reference electrode model, use the DefaultStorageCondition option to specify under which condition this newly generated reference electrode model should be stored:

When uploading a new blank reference electrode model, use the DefaultStorageCondition option to specify under which condition this newly generated reference electrode model should be stored:

Dimensions  (1)

When uploading a new blank reference electrode model, use the Dimensions option to specify the physical dimensions of this newly generated reference electrode model:

ElectrodePackagingMaterial  (1)

When uploading a new blank reference electrode model, use the ElectrodePackagingMaterial option to specify the material of the casing outside the conductive material of this newly generated reference electrode model:

ElectrodeShape  (1)

When uploading a new blank reference electrode model, use the ElectrodeShape option to specify the physical geometry of this newly generated reference electrode model:

IncompatibleMaterials  (1)

When uploading a new blank reference electrode model, use the IncompatibleMaterials option to specify the materials that will be damaged in contact of this newly generated reference electrode model:

MaxNumberOfPolishings  (1)

When uploading a new blank reference electrode model, use the MaxNumberOfPolishings option to specify the number of polishings can be performed on the non-working part (the part that does not directly contact the experiment solution) of the electrodes of this newly generated reference electrode model before the electrodes should be discarded:

MaxNumberOfUses  (1)

When uploading a new blank reference electrode model, use the MaxNumberOfUses option to specify the number of usages the electrodes of this newly generated reference electrode model can endure before being discarded:

MaxPotential  (1)

When uploading a new blank reference electrode model, use the MaxPotential option to specify the highest voltage this newly generated reference electrode model can endure without being damaged during experiments:

MinPotential  (1)

When uploading a new blank reference electrode model, use the MinPotential option to specify the lowest voltage this newly generated reference electrode model can endure without being damaged during experiments:

Name  (1)

Use the Name option to specify the Name for the newly generated reference electrode model. If a Name is specified, a new reference electrode model will be created even if there is already a model existing in the database with the same reference electrode parameters:

RecommendedRefreshPeriod  (1)

Use the RecommendedRefreshPeriod option to specify the time period the reference solution filled in the glass tube of this newly generated reference electrode model should be refreshed:

RecommendedSolventType  (1)

Use the RecommendedSolventType option to specify which type of solvent of the experiment solution this newly generated reference electrode model is recommended to work in:

ReferenceCouplingSample  (1)

Use the ReferenceCouplingSample option to specify the model of the sample that contains a molecule to form a redox coupling pair of the reference electrode's material of the newly generated reference electrode model:

ReferenceElectrodeType  (1)

Use the ReferenceElectrodeType to specify the type of the newly generated reference electrode model:

ReferenceSolution  (1)

Use the ReferenceSolution option to specify the model of the reference solution filled in the glass tube of the newly generated reference electrode model:

SolutionVolume  (1)

When uploading a new blank reference electrode model, use the SolutionVolume option to specify the volume of reference solution filled in the glass tube of this newly generated reference electrode model for it to properly work:

SonicationSensitive  (1)

When uploading a new blank reference electrode model, use the SonicationSensitive option to specify if this newly generated reference electrode model can be sonication-cleaned and not being damaged:

Synonyms  (1)

Use the Synonyms option to provide alternative names for the newly generated reference electrode model:

WettedMaterials  (1)

When uploading a new blank reference electrode model, use the WettedMaterials option to specify the materials of this newly generated reference electrode model that in direct contact with the experiment solution:

WiringConnectors  (1)

When uploading a new blank reference electrode model, use the WiringConnectors option to specify the details of the wiring connectors of this newly generated reference electrode model:

WiringDiameters  (1)

When uploading a new blank reference electrode model, use the WiringDiameters option to specify diameters of each wiring connector of this newly generated reference electrode model. If WiringDiameters is informed, the ExposedWire wiring connectors should have a non-Null diameter and the non-ExposedWire wiring connectors should have a Null diameter:

WiringLength  (1)

When uploading a new blank reference electrode model, use the WiringLength option to specify the length of the conductive part of this newly generated reference electrode model:

Messages  (66)

IncompatibleMaterials contains BulkMaterial  (1)

When upload a new blank model, if the provided IncompatibleMaterials contains the provided BulkMaterial, an error will be thrown:

IncompatibleMaterials contains CoatMaterial  (1)

When upload a new blank model, if the provided IncompatibleMaterials contains the provided CoatMaterial when CoatMaterial is not Null, an error will be thrown:

IncompatibleMaterials contains ElectrodePackagingMaterial  (1)

When upload a new blank model, if the provided IncompatibleMaterials contains the provided ElectrodePackagingMaterial when ElectrodePackagingMaterial is not Null, an error will be thrown:

MaxNumberOfPolishings greater than MaxNumberOfUses  (1)

If the MaxNumberOfPolishings option is greater than the MaxNumberOfUses option, an error will be thrown:

Options with too high precisions  (1)

If an option is given with higher precision than the experiment setup can achieve, the value is rounded to the experiment precision and a warning is displayed:

Template reference electrode model is deprecated  (1)

If the provided template reference electrode model is deprecated, an error will be thrown:

The ReferenceCouplingSample has a different redox coupling molecule from the molecule in ReferenceSolution  (1)

If the redox coupling molecule in the ReferenceCouplingSample is different from the the molecule in the provided ReferenceSolution, an error will be thrown:

The ReferenceSolution solvent mismatch RecommendedSolventType  (1)

If the ReferenceSolution's solvent does not match with the RecommendedSolventType, an error will be thrown:

URENullPriceForPublicPreparableModel  (1)

If the Price option is not explicitly provided for a public and preparable model, an error will be thrown:

WettedMaterials does not contain BulkMaterial  (1)

When upload a new blank model, if the provided WettedMaterials does not contain the provided BulkMaterial when CoatMaterial is set to Null, an error will be thrown:

WettedMaterials does not contain CoatMaterial  (1)

When upload a new blank model, if the provided WettedMaterials does not contain the provided CoatMaterial when CoatMaterial is not set to Null, an error will be thrown:

WettedMaterials does not contain ElectrodePackagingMaterial  (1)

When upload a new blank model, if the provided WettedMaterials does not contain the provided ElectrodePackagingMaterial when ElectrodePackagingMaterial is set to Null, an error will be thrown:

WiringConnectors and WiringDiameters do not have the same lengths  (2)

When upload a new blank model, if the provided WiringConnectors and WiringDiameters do not have the same lengths, an error will be thrown:

When upload a new blank model, if the provided WiringConnectors and WiringDiameters do not have the same lengths, an error will be thrown:

Wiring diameter not Null for non-ExposedWire wiring connectors  (1)

When upload a new blank model, if the provided WiringDiameters contains a non-Null diameter for a corresponding non-ExposedWire wiring connector, an error will be thrown:

Blank  (1)

If the provided Blank is not a "Bare" type reference electrode model, an error will be thrown:

BulkMaterial  (2)

When uploading a new Blank model, if the BulkMaterial is not explicitly specified, an error will be thrown:

If the BulkMaterial option does not match with the template reference electrode model's blank model, or the blank model specified by the Blank option, an error will be thrown:

CoatMaterial  (2)

When uploading a new Blank model, if the CoatMaterial is not explicitly specified, an error will be thrown:

If the CoatMaterial option does not match with the template reference electrode model's blank model, or the blank model specified by the Blank option, an error will be thrown:

DefaultStorageCondition  (1)

If the provided DefaultStorageCondition is different from the DefaultStorageCondition of the Reference Solution, an error will be thrown:

Dimensions  (2)

When uploading a new Blank model, if the Dimensions is not explicitly specified, an error will be thrown:

If the Dimensions option does not match with the template reference electrode model's blank model, or the blank model specified by the Blank option, an error will be thrown:

ElectrodePackagingMaterial  (1)

If the ElectrodePackagingMaterial option does not match with the template reference electrode model's blank model, or the blank model specified by the Blank option, an error will be thrown:

ElectrodeShape  (2)

When uploading a new Blank model, if the ElectrodeShape is not explicitly specified, an error will be thrown:

If the ElectrodeShape option does not match with the template reference electrode model's blank model, or the blank model specified by the Blank option, an error will be thrown:

MaxNumberOfPolishings  (1)

If the MaxNumberOfPolishings option is not less or equal to the MaxNumberOfPolishings defined by the template reference electrode model's blank model, or by the blank model specified by the Blank option, an error will be thrown:

MaxNumberOfUses  (2)

When uploading a new Blank model, if the MaxNumberOfUses is not explicitly specified, an error will be thrown:

If the MaxNumberOfUses option is not less or equal to the MaxNumberOfUses defined by the template reference electrode model's blank model, or by the blank model specified by the Blank option, an error will be thrown:

MaxPotential  (2)

When uploading a new Blank model, if the MaxPotential is not explicitly specified, an error will be thrown:

If the MaxPotential option is not less or equal to the MaxPotential defined by the template reference electrode model's blank model, or by the blank model specified by the Blank option, an error will be thrown:

MinPotential  (2)

When uploading a new Blank model, if the MinPotential is not explicitly specified, an error will be thrown:

If the MinPotential option is not greater or equal to the MinPotential defined by the template reference electrode model's blank model, or by the blank model specified by the Blank option, an error will be thrown:

Name  (1)

If the provided Name is identical with the Name of an existing reference electrode model, an error will be thrown:

RecommendedRefreshPeriod  (2)

If the RecommendedRefreshPeriod is specified when the model being upload is a Blank model, an error will be thrown:

If the RecommendedRefreshPeriod is set to Null when the model being upload is not a Blank reference electrode model, an error will be thrown:

RecommendedSolventType  (2)

If the RecommendedSolventType is specified when the model being upload is a Blank model, an error will be thrown:

If the RecommendedSolventType is set to Null when the model being upload is not a Blank reference electrode model, an error will be thrown:

ReferenceCouplingSample  (5)

If the ReferenceCouplingSample is specified when the model being upload is a Blank model, an error will be thrown:

If the ReferenceCouplingSample is specified when the model being upload is a pseudo reference electrode model, an error will be thrown:

If the ReferenceCouplingSample is set to Null when the model being upload is a non-pseudo reference electrode model, an error will be thrown:

If the provided ReferenceCouplingSample's Analytes field is not populated, an error will be thrown:

If the provided ReferenceCouplingSample's Analytes field has more than one entry, an error will be thrown:

ReferenceElectrodeType  (4)

If the RecommendedSolventType is not explicity specified when the model being upload is a Blank model, an error will be thrown:

If the ReferenceElectrodeType is the same with the Blank model's ReferenceElectrodeType, an error will be thrown:

If the ReferenceElectrodeType is not a 'Bare', an error will be thrown:

If the ReferenceElectrodeType is a 'Bare' type when the model being uploaded is a non-Blank model, an error will be thrown:

ReferenceSolution  (10)

If the provided ReferenceSolution has less than two non-Null entries in its Composition field, an error will be thrown:

If the provided ReferenceSolution has no entries in its Solvent field, an error will be thrown:

If the provided ReferenceSolution has more than one entry in its Solvent field, an error will be thrown:

If the provided ReferenceSolution's solvent molecule has no DefaultSampleModel, an error will be thrown:

If the provided ReferenceSolution's solvent sample has more than one entry in its Composition field, an error will be thrown:

If the provided ReferenceSolution's Analytes field is not populated, an error will be thrown:

If the provided ReferenceSolution's Analytes field has more than one entry, an error will be thrown:

If the provided ReferenceSolution's solvent molecule has no DefaultSampleModel, an error will be thrown:

If the ReferenceSolution is specified when the model being upload is a Blank model, an error will be thrown:

If the ReferenceSolution is set to Null when the model being upload is not a Blank reference electrode model, an error will be thrown:

SolutionVolume  (2)

When uploading a new Blank model, if the SolutionVolume is not explicitly specified, an error will be thrown:

If the SolutionVolume option does not match with the template reference electrode model's blank model, or the blank model specified by the Blank option, an error will be thrown:

SonicationSensitive  (2)

When uploading a new Blank model, if the SonicationSensitive is not explicitly specified, an error will be thrown:

If the SonicationSensitive option does not match with the template reference electrode model's blank model, or the blank model specified by the Blank option, an error will be thrown:

WettedMaterials  (1)

If the WettedMaterials option does not match with the template reference electrode model's blank model, or the blank model specified by the Blank option, an error will be thrown:

WiringConnectors  (2)

When uploading a new Blank model, if the WiringConnectors is not explicitly specified, an error will be thrown:

If the WiringConnectors option does not match with the template reference electrode model's blank model, or the blank model specified by the Blank option, an error will be thrown:

WiringDiameters  (1)

If the WiringDiameters option does not match with the template reference electrode model's blank model, or the blank model specified by the Blank option, an error will be thrown:

WiringLength  (1)

If the WiringLength option does not match with the template reference electrode model's blank model, or the blank model specified by the Blank option, an error will be thrown: