Model.hm_plotentity

Model.hm_plotentity(collection, dataname, plottype)

Plots entity as either a vector or a contour plot.

Parameters:

• collection (Collection) – The collection containing the entities to plot. Currently only supported for constraints.

• dataname (hwString) – The data name which is to be extracted and plotted.

• plottype (int) –

  The type of plot to create. Valid values are:

  0 - Clear plot

  1 - Vector plot (not valid for constraints)

  2 - Interactive contour plot

  3 - Static scalar plot

Returns:

• hwReturnStatus - Status object

Example

Create a contour plot of data name weights for all constraints

import hm
import hm.entities as ent

model = hm.Model()

constraints = hm.Collection(model, ent.Constraint)

model.hm_plotentity(collection=constraints, dataname="weights", plottype=2)