Public Member Functions | List of all members
ResultViewItemList Class Reference

ResultViewItemList class is used to add result items to be displayed in the Result View Dialog
The class can be called from the Study class or AnalysisGroup.
. More...

Public Member Functions

void AddItemFromCalculation (CalculationDefinition *calculation)
 Adds the given calculation to the ResultViewItemList. More...
 
void AddItemFromCapture (Variant &var, Variant &studyVar=-1)
 Adds the given image to the ResultViewItemList. More...
 
void AddItemFromCompositeResult (CompositeResultDefinition *composite)
 Adds the composite result to the ResultViewItemList. More...
 
void AddItemFromContour (ContourDefinition *contour)
 Adds the given contour to the ResultViewItemList. More...
 
void AddItemFromDataSet (DataSet *dataSet)
 Adds the given dataSet to the ResultViewItemList. More...
 
void AddItemFromDifferenceEfficiencyMap (DifferenceEfficiencyMapDefinition *efficiencyMap)
 Adds the difference efficiencyMap to the ResultViewItemList. More...
 
void AddItemFromEfficiencyMap (EfficiencyMapDefinition *efficiencyMap)
 Adds the given efficiencyMap to the ResultViewItemList. More...
 
void AddItemFromEfficiencyMapGraph (EfficiencyMapDefinition *efficiencyMap, int type)
 Adds the efficiency map NT curve graph to the ResultViewItemList. More...
 
void AddItemFromExternalEfficiencyMap (ExternalEfficiencyMapDefinition *efficiencyMap)
 Adds the given external data entry efficiencyMap to the ResultViewItemList. More...
 
void AddItemFromFluxLine (FluxLineDefinition *fluxLine)
 Adds the given fluxLine to the ResultViewItemList. More...
 
void AddItemFromGraphModel (GraphModel *graph)
 Adds the given graph to the ResultViewItemList. More...
 
void AddItemFromPostCondition (Condition *condition)
 Adds the given condition to the ResultViewItemList. More...
 
void AddItemFromProbe (ProbeDefinition *probe)
 Adds the given probe to the ResultViewItemList. More...
 
void AddItemFromResponseTableGraph (int type, Variant &studyVar=-1)
 Add a response value chart to the ResultViewItemList. More...
 
void AddItemFromResponseTableGraph (ResponseTableCorrection *correction, int type)
 Add the response graph created from the corrected response table to the ResultViewItemList. More...
 
void AddItemFromSectionGraph (SectionGraph *sectionGraph)
 Adds the given sectionGraph to the ResultViewItemList. More...
 
void AddItemFromThermalEfficiencyMap (ThermalEfficiencyMapDefinition *efficiencyMap)
 Adds the given efficiencyMap to the ResultViewItemList. More...
 
void AddItemFromThermalEfficiencyMapGraph (ThermalEfficiencyMapDefinition *efficiencyMap, int type)
 Adds the efficiency map NT curve graph to the ResultViewItemList. More...
 
void AddItemFromVector (VectorDefinition *vector)
 Adds the given vector to the ResultViewItemList. More...
 
void AddItemFromVectorExpression (VectorExpression *vector)
 Adds the vector expression to the ResultViewItemList. More...
 
void ClearItemList ()
 Clears the ResultViewItemList.
 
void DeleteResultViewItem (Variant &var)
 Deletes the result item with the given var name. More...
 
bool IsValid ()
 Returns True if an object is valid. More...
 
int NumResultViewItem ()
 Returns the number of Result View Items. Returns 0 as default is apply has not been selected. More...
 
void SetEfficiencyResultType (Variant &var, Variant &type, int displayType=0)
 Specifies the result type of the efficiency map. More...
 

Detailed Description

ResultViewItemList class is used to add result items to be displayed in the Result View Dialog
The class can be called from the Study class or AnalysisGroup.
.

Example of calling the class object:

app.GetModel(0).GetStudy(0).GetResultViewItemList()
app.GetAnalysisGroup(0).GetResultViewItemList()

Member Function Documentation

void ResultViewItemList::AddItemFromCalculation ( CalculationDefinition calculation)

Adds the given calculation to the ResultViewItemList.

Parameters
calculationThe calculation item to be added to ResultViewItemList
void ResultViewItemList::AddItemFromCapture ( Variant &  var,
Variant &  studyVar = -1 
)

Adds the given image to the ResultViewItemList.

Parameters
varThe index or name of image to be added to ResultViewItemList
studyVarStudy index or name of the image to add
void ResultViewItemList::AddItemFromCompositeResult ( CompositeResultDefinition composite)

Adds the composite result to the ResultViewItemList.

Parameters
compositeThe composite result object to be added to ResultViewItemList
void ResultViewItemList::AddItemFromContour ( ContourDefinition contour)

Adds the given contour to the ResultViewItemList.

Parameters
contourThe contour to be added to ResultViewItemList
void ResultViewItemList::AddItemFromDataSet ( DataSet dataSet)

Adds the given dataSet to the ResultViewItemList.

Parameters
dataSetThe dataSet item to be added to ResultViewItemList
void ResultViewItemList::AddItemFromDifferenceEfficiencyMap ( DifferenceEfficiencyMapDefinition efficiencyMap)

Adds the difference efficiencyMap to the ResultViewItemList.

Parameters
efficiencyMapThe difference efficiencyMap to be added to ResultViewItemList
void ResultViewItemList::AddItemFromEfficiencyMap ( EfficiencyMapDefinition efficiencyMap)

Adds the given efficiencyMap to the ResultViewItemList.

Parameters
efficiencyMapThe efficiencyMap to be added to ResultViewItemList
void ResultViewItemList::AddItemFromEfficiencyMapGraph ( EfficiencyMapDefinition efficiencyMap,
int  type 
)

Adds the efficiency map NT curve graph to the ResultViewItemList.

Parameters
efficiencyMapThe efficiencyMap to be added to ResultViewItemList
typeCurve type
void ResultViewItemList::AddItemFromExternalEfficiencyMap ( ExternalEfficiencyMapDefinition efficiencyMap)

Adds the given external data entry efficiencyMap to the ResultViewItemList.

Parameters
efficiencyMapThe external data entry efficiencyMap to be added to ResultViewItemList
void ResultViewItemList::AddItemFromFluxLine ( FluxLineDefinition fluxLine)

Adds the given fluxLine to the ResultViewItemList.

Parameters
fluxLineThe flux line to be added to ResultViewItemList
void ResultViewItemList::AddItemFromGraphModel ( GraphModel graph)

Adds the given graph to the ResultViewItemList.

Parameters
graphThe graph item to be added to ResultViewItemList
void ResultViewItemList::AddItemFromPostCondition ( Condition condition)

Adds the given condition to the ResultViewItemList.

Parameters
conditionThe condition item to be added to ResultViewItemList
void ResultViewItemList::AddItemFromProbe ( ProbeDefinition probe)

Adds the given probe to the ResultViewItemList.

Parameters
probeThe probe to be added to ResultViewItemList
void ResultViewItemList::AddItemFromResponseTableGraph ( int  type,
Variant &  studyVar = -1 
)

Add a response value chart to the ResultViewItemList.

Parameters
typeType
studyVarStudy index or name
void ResultViewItemList::AddItemFromResponseTableGraph ( ResponseTableCorrection correction,
int  type 
)

Add the response graph created from the corrected response table to the ResultViewItemList.

Parameters
correctionResponseTableCorrection object
typeType
void ResultViewItemList::AddItemFromSectionGraph ( SectionGraph sectionGraph)

Adds the given sectionGraph to the ResultViewItemList.

Parameters
sectionGraphThe sectionGraph to be added to ResultViewItemList
void ResultViewItemList::AddItemFromThermalEfficiencyMap ( ThermalEfficiencyMapDefinition efficiencyMap)

Adds the given efficiencyMap to the ResultViewItemList.

Parameters
efficiencyMapThe efficiencyMap to be added to ResultViewItemList
void ResultViewItemList::AddItemFromThermalEfficiencyMapGraph ( ThermalEfficiencyMapDefinition efficiencyMap,
int  type 
)

Adds the efficiency map NT curve graph to the ResultViewItemList.

Parameters
efficiencyMapThe efficiencyMap to be added to ResultViewItemList
typeCurve type
void ResultViewItemList::AddItemFromVector ( VectorDefinition vector)

Adds the given vector to the ResultViewItemList.

Parameters
vectorThe vector to be added to ResultViewItemList
void ResultViewItemList::AddItemFromVectorExpression ( VectorExpression vector)

Adds the vector expression to the ResultViewItemList.

Parameters
vectorThe vector expression object to be added to ResultViewItemList
void ResultViewItemList::DeleteResultViewItem ( Variant &  var)

Deletes the result item with the given var name.

Parameters
varThe result item name
bool ResultViewItemList::IsValid ( )

Returns True if an object is valid.

Returns
Whether or not the ResultViewItemList object is valid
int ResultViewItemList::NumResultViewItem ( )

Returns the number of Result View Items. Returns 0 as default is apply has not been selected.

Returns
Returns the number of Result View Items
void ResultViewItemList::SetEfficiencyResultType ( Variant &  var,
Variant &  type,
int  displayType = 0 
)

Specifies the result type of the efficiency map.

Parameters
varThe result item name
typeThe result type
Item name Description
RotationSpeed Speed
AverageTorque Torque
Efficiency Efficiency
OutputPower Output Power
Id Current (Id)
Iq Current (Iq)
TotalLoss Total Loss
CopperLoss Copper Loss
IronLoss Iron Loss
JouleLoss Eddy Current Loss (Iron Loss)
HysteresisLoss Hysteresis Loss (Iron Loss)
MechanicalLoss Mechanical Loss
DirectAxisFlux Flux (d-Axis)
QuadratureAxisFlux Flux (q-Axis)
Voltage Voltage
Phase Load Angle
Current Current
Slip Slip
StatorCopperLoss Stator Copper Loss
RotorCopperLoss Rotor Copper Loss
StrayLoss Stray Loss
TorqueRipple Torque Ripple
Vd Voltage (Vd)
Vq Voltage (Vq)
PowerFactor Power Factor
DirectAxisFlux2 Flux (d-Axis 2)
QuadratureAxisFlux2 Flux (q-Axis 2)
Vd2 Voltage (Vd 2)
Vq2 Voltage (Vq 2)
PowerFactor2 Power Factor 2
PwmJouleLoss PWM Eddy Current Loss (Iron Loss)
ClassicalEddyLoss Classical Eddy Current Loss (Iron Loss)
ExcessEddyLoss Excess Eddy Current Loss (Iron Loss)
AcJouleLoss AC Copper Loss
UserParameter User Parameter

If you use the UserParameters, add the index number.
Example:
SetEfficiencyResultType("var", "UserParameter1");
displayTypeThe display type