MORPHEE Quantities property description

MORPHEE quantities can be retrieved using User Application Monitoring or Control.

MORPHEE quantities diagram

The below diagram is not representative of python object. It just describes how MORPHEE quantities properties are set:

classDiagram
  Common properties <|-- Measurement
  Common properties <|-- Formula
  Common properties <|-- Constant
  Common properties <|-- String
  Common properties <|-- Reference
  Common properties <|-- Table
  Table <|-- LUT
  Constant <|-- String Constant
  Constant <|-- Numerical Constant
  Common properties : string id
  Common properties : string description
  Common properties : string component       
  Common properties : double displayMaximum
  Common properties : double displayMinimum
  Common properties : string unit          
  Common properties : string displayUnit              
  Common properties : bool isParameter   
  Common properties : double maximum       
  Common properties : double minimum       
  Common properties : int mode          
  Common properties : string parameterBloc 
  Common properties : string rawUnit       
  Common properties : string type 
  Measurement : double displayValue  
  Measurement : string frequencyGroup
  Measurement : double value         
  Numerical Constant : double value         
  String Constant : string value         
  String : string value         
  Reference: bool readOnly     
  Reference: string referenceType
  Reference: string refId  
  Table : int maxCol 
  Table : int maxLine
  Table : int nbCol  
  Table : int nbLine 
  Table : string value  
  Formula : string formula 

Common Quantity properties

Common properties is a set of base properties that are in all quantity type.

Type	Name	Description
string	id	Identifier of the Morphee quantity
string	description	Description of the Morphee quantity
string	component	Component name where quantity is defined
double	displayMaximum	Display maximum value of the quantity
double	displayMinimum	Display minimum value of the quantity
string	unit	Unit of the Morphee quantity
string	displayUnit	Unit of the Morphee quantity, for display
bool	isParameter	true if the quantity is a parameter
double	maximum	Maximum value of the quantity. The property returns 0 if the quantity has no minimum.
double	minimum	Minimum value of the quantity. The property returns 0 if the quantity has no minimum.
int	mode	Loading mode of quantity (might be different than component mode, cf optional channel): 0 bench, 1 campaign, 3 test
string	parameterBloc	If the quantity is a parameter, it returns the bloc name (tab name in parameter monitor).
string	rawUnit	Raw unit of the Morphee quantity
string	type	Quantity type (Formula, Look up table, Table, Measurement, String, Constant number, Constant string, Reference)

Measurement quantity properties

Measurement quantity "type" property value is "Measurement".

Type	Name	Description
double	displayValue	Display value for Calculated and Measurement Channel as double. Most of the time DisplayValue is equals to Value. But the display unit of the quantity can be changed dynamically in MORPHEE.
string	frequencyGroup	Refresh period rate (Fast, Normal, Slow)
double	value	Raw value for Calculated and Measurement Channel as double

Numerical constant properties

Numerical constant quantity "type" property value is "Constant number".

Type	Name	Description
double	value	Value of the numerical constant as a double

String constant properties

String constant quantity "type" property value is "Constant string".

Type	Name	Description
string	value	Value of the constant as a string

Reference quantity properties

Reference quantity "type" property value is "Reference".

Type	Name	Description
bool	readOnly	True if the reference can only be used to read the value of the referenced quantity
string	referenceType	Type of Reference (LUT, Number, String, Table)
string	refId	Identifier of the referenced quantity (may be null if the reference is undefined)

String quantity properties

String quantity "type" property value is "String".

Type	Name	Description
string	value	Current text value of the string quantity

Table quantity properties

Table quantity "type" property value is "Table".

Type	Name	Description
int	maxCol	Maximum number of column in the table
int	maxLine	Maximum number of line in the table
int	nbCol	Current number of column in the table
int	nbLine	Current number of line in the table
string	value	Content value of the table

LUT quantity properties

LUT quantity derives from table quantity and do not have additional property. LUT quantity "type" property value is "Look up table".

Formula quantity properties

Formula quantity derives from Measurement quantity. Formula quantity "type" property value is "Formula".

Type	Name	Description
string	formula	The formula used to calculate the quantity value.