VariableSymbol - HiStructClient/femcad-doc GitHub Wiki

VariableSymbol is a powerful class which can automaticly output the variable with its formulas and values.

rectangleAreaVS := VariableSymbol{
   Name := "Rectangle Area",
   QuantityType := Fcs.EngineeringQuantity.Area,     # All the EngineeringQuantity-s are in \FcsDocument
                                                       \FcsDocTools
   Definition := a*b,                                # Mathematical notation 
   Symbol := "V_{area}",                             # LaTex sign code - google LateX converter for more signs
   Reference := "",
   HumanName := "Area of a rectangle",
   Description := "Counts the area of a rectangle",
   Explanation := "No need to know more",
   Assumption := "The world is flat"
}

b := 10 * Unit.km

a := VariableSymbol {
   QuantityType := Fcs.EngineeringQuantity.Length,
   Definition := 800 * Unit.m,
   Symbol := "a"
}

VariableSymbol can be outputted with FCS RenderWriter:

FCS.Reporting.Paragraph{ TextFn = rw => "I am the second paragraph with variable symbol:  "+    
                                     rw.SADEVu(rectangleAreaVS) },

List of RenderWriter outputs by KeyLetters: SADEVu ==> Outputs symbol, definition, evaluation and result with units

D     ==> Outputs formula definiton without symbol
Eu    ==> Outputs evaluation with units without symbol
E     ==> Outputs evaluation without symbol
SD    ==> Outputs definition
S     ==> Outputs symbol
SEVu  ==> Outputs values and evaluation with units
SADEVu => Outputs definition, values and evaluation with units
SVu   ==> Outputs evaluation result
Vu    ==> Outputs evaluation with units
R     ==> Outputs reference
X     ==> Outputs explanation