Click or drag to resize
XSField Class
Class XSField.

 

Code of field: S

Type of field: continuous range data.

Storage: Four 64 bit real numbers.

Applicable to:

Continuous range data where four possible values can be recorded: minimum, low percentile (ex: 5% percentile), high percentile (ex: 95% percentile) and maximum values.

Inheritance Hierarchy

Namespace:  Biolomics.BioCallback
Assembly:  Biolomics.BioCallback (in Biolomics.BioCallback.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
public class XSField : XField

The XSField type exposes the following members.

Constructors
  NameDescription
Public methodXSField(XSField)
Copy ctor
Public methodXSField(TSField, XRecord)
Initializes a new instance of the XSField class.
Public methodXSField(XSField, XRecord)
Copy ctor but into a new XRecord
Top
Properties
  NameDescription
Public propertyFieldValue
Gets or sets the field value.
(Overrides XFieldFieldValue.)
Public propertyHP
Gets or sets the high percentil.
Public propertyIsModified
Gets or sets a value indicating whether this instance is modified.
(Inherited from XField.)
Public propertyLP
Gets or sets the low percentil.
Public propertyMax
Gets or sets the maximum.
Public propertyMin
Gets or sets the minimum.
Top
Methods
  NameDescription
Public methodCanRead
Determines whether current connection can read from Field.
(Inherited from XField.)
Public methodCanWrite
Determines whether current connection can write from Field.
(Inherited from XField.)
Public methodClear
Clears this instance.
(Inherited from XField.)
Public methodClone
Clones this instance.
Public methodCloneAsXField
We cannot use name 'Clone' here otherwise Implements vector.TId(Of XSField) fails because XSField.Clone() returns a XField instead of a XSField !!!
(Overrides XFieldCloneAsXField(XRecord).)
Public methodDataToView
Converts field value to readable string.
(Inherited from XField.)
Public methodDataToView(Int32)
Mandatory otherwise DataToView(5) returns letter 5 of string given by DataToView(), instead of the subfield value
(Inherited from XField.)
Public methodEquals
Determines whether the specified Object is equal to this instance.
(Inherited from XField.)
Protected methodField
each derived class embed its own TField member, which can be a TAField, TCField, TEField, etc. this function must return that original TField
(Overrides XFieldField.)
Public methodFieldDef
Gets the Field definition.
(Inherited from XField.)
Public methodFieldType
The Field type.
(Inherited from XField.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodHPStr
Gets the High percentil as a string.
Public methodKey
Gets Field Key.
(Inherited from XField.)
Public methodLPStr
Gets the Low percentil as a string.
Public methodMaxStr
Gets the Maximum as a string.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodMinStr
Gets the Minimum.
Public methodParentRecord
Gets the parent record.
(Inherited from XField.)
Public methodRead
Reads the Content from source object.
(Inherited from XField.)
Public methodReset
Resets this instance.
(Inherited from XField.)
Public methodSetDefaultValues
Sets the default values.
(Inherited from XField.)
Public methodSetValues
Sets the values.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodWrite
Writes data into a TQuery and Format it depending to field type
(Inherited from XField.)
Top
Examples
This is an example of use of XSField to change XSField value
Example VB.Net
Imports System
Imports BioloMICS.BioCallback
Imports BioloMICS.SharedClasses
Imports Biolomics.Utility.DatabaseConstants

Public Class Program

    <STAThread()>
    Shared Sub Main()
        Dim program As New Program
        program.ChangeField()
    End Sub

    '    Write sub functions here
    Public Sub ChangeField()
        '    get the current connection
        Dim SqlCo As XConnection = Run.GetCurrentConnection()
        If SqlCo Is Nothing Then
            Return
        End If

        '    get a table from its User name
        Dim TableDef As XTableDef = SqlCo.GetTableDefByUserNameEng("Your_Table_Name")
        If TableDef Is Nothing Then   '    may happen if that table doesn't exist
            Return
        End If
        '    load a Field from that table
        Dim FieldDefMap As New XFieldDefMap
        Dim FieldDef As XFieldDef = SqlCo.GetFieldByDBName("Your_S_Field_name", TableDef.Key)
        If FieldDef Is Nothing Then   '    that field doesn't exist
            Return
        End If
        FieldDefMap.Add(FieldDef)

        '    load record with id=6
        Dim Where As XWhere = XWhere.Eq(StaticFields.id, 6)
        Dim RecordMap As XRecordMap = Run.LoadRecords(TableDef.Key, FieldDefMap, Where)

        For Each Record As XRecord In RecordMap
            Dim Field As XSField = TryCast(Record.Fields(FieldDef.Key), XSField)
            If Field Is Nothing Then   '    this field doesn't exist or is not a S-Field
                Continue For
            End If

            '    change the values here, set LP and HP as 25% and 75 % of the Min-Max range
            Dim dx As Double = Field.Max - Field.Min
            Field.LP = Field.Min + 0.25 * dx
            Field.HP = Field.Min + 0.75 * dx

            Record.Save(False)
        Next

    End Sub

End Class
See Also