Xceed Logo
Shop
Xceed Toolkit Plus for WPF v5.1 Documentation
Xceed.Wpf.ListBox Assembly / Xceed.Wpf.Data.Stats Namespace / RootMeanSquareFunction Class
Members


In This Topic
    RootMeanSquareFunction Class
    In This Topic

    Class that represents the Root-Mean-Square statistical function, which is the square root of the arithmetical average of a set of squared instantaneous values. The root mean square is also known as the quadratic mean.

    The Root-Mean-Square function is not supported when using a remote data source.

    Syntax
    'Declaration
 
Public Class RootMeanSquareFunction 
   Inherits CumulativeStatFunction
    'Usage
 
Dim instance As RootMeanSquareFunction
    public class RootMeanSquareFunction : CumulativeStatFunction
    Remarks
    Null (Nothing in Visual Basic) and DBNull values will be ignored.
    Inheritance Hierarchy

    System.Object
       Xceed.Wpf.Data.Stats.StatFunction
          Xceed.Wpf.Data.Stats.CumulativeStatFunction
             Xceed.Wpf.Data.Stats.RootMeanSquareFunction

    Public Constructors
     NameDescription
    Public ConstructorRootMeanSquareFunction ConstructorOverloaded. Initializes a new instance of the RootMeanSquareFunction class.  
    Top
    Public Properties
     NameDescription
    Public PropertyResultPropertyNameGets or sets the unique, case-sensitive property name from which the result of the statistical function can be retrieved. (Inherited from Xceed.Wpf.Data.Stats.StatFunction)
    Public PropertySourcePropertyNameGets or sets the name of the column whose values will be used to calculate the result of the statistical function. (Inherited from Xceed.Wpf.Data.Stats.StatFunction)
    Top
    Protected Properties
     NameDescription
    Protected Internal PropertyIsInitializedGets a value indicating whether the Initialize method has been called, indicating that the types in which the values will be accumulated have been initialized. (Inherited from Xceed.Wpf.Data.Stats.StatFunction)
    Protected PropertyIsSealedGets a value indicating whether an instance of a statistical function is in an immutable state. (Inherited from Xceed.Wpf.Data.Stats.StatFunction)
    Protected Internal PropertyPrerequisiteFunctionsGets a list of the statistical functions whose results are required by the current function in order to calculate its own result. (Inherited from Xceed.Wpf.Data.Stats.StatFunction)
    Protected Internal PropertyRequiresAccumulationGets a value indicating whether the statistical function needs to accumulate its own results. (Inherited from Xceed.Wpf.Data.Stats.StatFunction)
    Top
    Public Methods
     NameDescription
    Public MethodGetSourcePropertyNames (Inherited from Xceed.Wpf.Data.Stats.StatFunction)
    Top
    Protected Methods
     NameDescription
    Protected Internal MethodAccumulateOverridden. Accumulates the values required to calculate the result of the statistical function.  
    Protected Internal MethodAccumulateChildResultOverridden. Accumulates the values required to calculate the result of the statistical function from the results of a child group.  
    Protected MethodCheckSealedChecks whether an instance of a statistical function is in an immutable state. (Inherited from Xceed.Wpf.Data.Stats.StatFunction)
    Protected Internal MethodGetEquivalenceKeyRetrieves a value that represents the statistical function's unique equivalence key. (Inherited from Xceed.Wpf.Data.Stats.StatFunction)
    Protected Internal MethodGetResultOverridden. Retrieves the result of the statistical function.  
    Protected MethodInitializeOverridden. Initializes the statistical function specifying the types in which the values will be accumulated.  
    Protected Internal MethodInitializeFromInstanceInitializes the properties of the current instance of the same-type statistical function when a new instance of the same function needs to be created. (Inherited from Xceed.Wpf.Data.Stats.StatFunction)
    Protected Internal MethodInitializePrerequisitesInitializes the prerequisite statistical functions defined by the PrerequisiteFunctions property. (Inherited from Xceed.Wpf.Data.Stats.StatFunction)
    Protected Internal MethodIsEquivalentRetrieves a value indicating whether a statistical function is the equivalent of the current function such that both will return the same result for the same set of values. (Inherited from Xceed.Wpf.Data.Stats.StatFunction)
    Protected Internal MethodResetOverridden. Resets the statistical function to its original state.  
    Protected Internal MethodValidateOverridden. Validates the statistical function to ensure that it is able to calculate its result.  
    Top
    Requirements

    Target Platforms: Windows 11, Windows 10, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

    See Also

    Reference

    RootMeanSquareFunction Members
    Xceed.Wpf.Data.Stats Namespace

    Send Feedback