DataCacheSpecificationWeightColumn class

DataCacheSpecificationWeightColumn

Represents a DataCache specifications weight column.

Constructors

• (DataCacheSpecification dcs "Attach weight to this dcs.") - Instanciate a new weight column.
  
• (DataCacheSpecification dcs "Attach weight to this dcs.", string name "Name of the existing weight column.") - Get existing new weight column.
  

Methods

• Empty Delete() - Removes the weight from the DCS.
  
• Unknown GetCategories(string variable "Variable name.") - Get the ids and names of the possible categories.
  
• number GetCurrentNumber(string variable "Variable name.", number category "Category id.") - Get the calculated weight number for a variable's category.
  
• number GetTarget(string variable "Variable name.", number category "Category id.") - Get the target for a variable's category.
  
• Empty MoveTargetsToDifferentVariable(string from "Variable name.", string to "Variable name.") - Move the current numbers and targets to another variable.
  
• Empty RemoveVariable(string variable "Variable name.") - Remove a variable from the calculation.
  
• Dictionary Save() - Save the weight after validation into the dcs and recalculate weight. Return value is a dictionary of all the variable values, weight values, modified sum (all arrays of numbers) and the log (string).
  
• Empty SetTarget(string variable "Variable name.", number category "Category id.", number target "Target to set for the weight.") - Set the target for a variable's category.
  
• string ToString() - The string representation of the object.
  
• string Validate(bool includeWarnings "Should validation also return warnings or not.") - Validate the current configuration. Returns first error message, or Empty if no error.
  

Properties

• number MaxIteration { get; set; } - Get/Set MaxIteration before stopping calculation.
  
• number MaxWeight { get; set; } - Get/Set how large the largest weight can become.
  
• number MinDeviation { get; set; } - Get/Set the minimum deviation before weight is considered stable.
  
• number MinWeight { get; set; } - Get/Set how small the smallest weight can become.
  
• string Name { get; set; } - Get/Set Name.
  
• string ObjectTypeName { get; } - The name of the type of object.
  
• Unknown PossibleVariables { get; } - List the variables available in the DCS.
  
• Unknown SelectedVariables { get; } - List the current variables used to calculate this weight.
  
• number TotalNumber { get; set; } - Get/Set the sum that the weight should add up to.
  
• TypeInformation TypeInformation { get; } - Get information about this class.