minsky::GodleyIcon Class Reference

#include <godleyIcon.h>

Inheritance diagram for minsky::GodleyIcon:

Collaboration diagram for minsky::GodleyIcon:

Classes
struct	MoveCellArgs
	move the contents of cell at (srcRow, srcCol) to (destRow, destCol). More...

Public Types
typedef std::vector< VariablePtr >	Variables

Public Member Functions
	GodleyIcon ()
	GodleyIcon (const GodleyIcon &)=default
	~GodleyIcon ()
bool	editorMode () const override
	indicate whether icon is in editor mode or icon mode More...
void	toggleEditorMode () override
bool	buttonDisplay () const
	enable/disable drawing buttons in table on canvas display More...
void	toggleButtons ()
bool	variableDisplay () const
void	toggleVariableDisplay ()
void	adjustPopupWidgets ()
void	scaleIcon (float w, float h)
	scale icon until it's height or width matches h or w depending on which is minimum More...
float	leftMargin () const
	left margin of bank icon with Godley icon More...
float	bottomMargin () const
	bottom margin of bank icon with Godley icon More...
void	resize (const LassoBox &) override
	resize this item on the canvas More...
void	removeControlledItems (GroupItems &) override
void	setCell (int row, int col, const string &val)
	set cell(row,col) with contents val More...
void	deleteRow (unsigned row)
	delete row before row More...
void	moveCell (const GodleyIcon::MoveCellArgs &)
std::map< string, double >	flowSignature (unsigned col) const
	flows, along with multipliers, appearing in col More...
const Variables &	flowVars () const
const Variables &	stockVars () const
std::vector< Summary >	summarise () const
	summary of variables in this godley table More...
void	update ()
	updates the variable lists with the Godley table More...
GodleyIcon *	clone () const override
ItemPtr	select (float x, float y) const override
	returns the variable if point (x,y) is within a variable icon, null otherwise, indicating that the Godley table has been selected. More...
ClickType::Type	clickType (float x, float y) const override
	returns the clicktype given a mouse click at x, y. More...
void	draw (cairo_t *cairo) const override
	draw icon to context More...
std::string	rowSum (int row) const
	return the A-L-E row sum for row More...
std::string	valueId (const std::string &x) const
	returns valueid for variable reference in table More...
Units	stockVarUnits (const std::string &stockName, bool check) const
	performs dimensional analysis on stock var column stockName More...
void	setCurrency (const std::string &currency)
void	insertControlled (Selection &selection) override
void	onMouseDown (float, float) override
	respond to mouse down events More...
void	onMouseUp (float, float) override
	respond to mouse up events More...
bool	onMouseMotion (float, float) override
	respond to mouse motion events with button pressed More...
bool	onMouseOver (float, float) override
	respond to mouse motion events (hover) without button pressed More...
void	onMouseLeave () override
	respond to mouse leave events (when mouse leaves item) More...
bool	onKeyPress (int, const std::string &, int) override
	respond to key press events More...
bool	inItem (float, float) const override
void	destroyFrame () override
	clean up popup window structures on window close More...
bool	wiresAttached () const
	return true if any wires are attached to the variables More...
const GodleyIcon *	godleyIconCast () const override
GodleyIcon *	godleyIconCast () override
Public Member Functions inherited from minsky::ItemT< GodleyIcon >
std::string	classType () const override
ItemT *	clone () const override
void	TCL_obj (classdesc::TCL_obj_t &t, const std::string &d) override
void	RESTProcess (classdesc::RESTProcess_t &rp, const std::string &d) override
	dummy template definition for use with gui executable More...
void	RESTProcess (classdesc::RESTProcess_t &rp, const std::string &d) const override
void	json_pack (classdesc::json_pack_t &j) const override
	ItemT ()=default
	ItemT (const ItemT &)=default
	ItemT (ItemT &&)=delete
ItemT &	operator= (const ItemT &)=default
ItemT &	operator= (ItemT &&)=delete
Public Member Functions inherited from minsky::Item
	Item ()
virtual std::weak_ptr< Port >	ports (std::size_t i) const
	callback to be run when item deleted from group More...
std::size_t	portsSize () const
	number of ports More...
float	portX (std::size_t i)
float	portY (std::size_t i)
virtual bool	contains (float xx, float yy) const
bool	contains (const Point &p) const
void	updateBoundingBox () override
void	throw_error (const std::string &) const
	mark item on canvas, then throw More...
virtual bool	ioVar () const
	indicates this is a group I/O variable More...
virtual double	value () const
	current value of output port More...
double	rotation () const
double	rotation (const double &r)
std::pair< double, bool >	rotationAsRadians () const
	return the rotation as radians, and whether rotation should have additional straight angle added for text that stays upright. More...
float	iWidth () const
float	iWidth (const float &w)
float	iHeight () const
float	iHeight (const float &h)
virtual void	flip ()
	rotate icon though 180∘ More...
std::string	id () const
	return an id uniquely identifying this item More...
virtual float	x () const
virtual float	y () const
virtual float	zoomFactor () const
void	ensureBBValid () const
float	width () const
float	height () const
virtual std::vector< Point >	corners () const
float	left () const
float	right () const
float	top () const
float	bottom () const
std::string	bookmarkId () const
	Id of bookmark associated with this. More...
void	adjustBookmark () const override
	adjust bookmark list to reflect current configuration More...
float	resizeHandleSize () const
	resize handles should be at least a percentage if the icon size (#1025) More...
virtual bool	onResizeHandle (float x, float y) const
virtual bool	onItem (float x, float y) const
	returns true if (x,y) is on the icon More...
virtual void	deleteAttachedWires ()
	delete all attached wires More...
virtual bool	visible () const
	whether this item is visible on the canvas. More...
void	moveTo (float x, float y)
virtual float	scaleFactor () const
	factor by which item has been resized More...
virtual float	scaleFactor (const float &sf)
void	dummyDraw () const
	draw into a dummy cairo context, for purposes of calculating port positions More...
virtual void	displayTooltip (cairo_t *, const std::string &) const
	display tooltip text, eg on mouseover More...
virtual void	updateIcon (double t)
	update display after a step() More...
	Item (const Item &)=default
Item &	operator= (const Item &)=default
virtual	~Item ()
void	drawPorts (cairo_t *cairo) const
virtual void	drawResizeHandles (cairo_t *cairo) const
virtual std::shared_ptr< Port >	closestOutPort (float x, float y) const
	returns closest output port to x,y More...
virtual std::shared_ptr< Port >	closestInPort (float x, float y) const
void	RESTProcess (classdesc::RESTProcess_t &rp, const std::string &d) override
	runs the RESTProcess descriptor suitable for this type More...
void	RESTProcess (classdesc::RESTProcess_t &rp, const std::string &d) const override
virtual void	displayDelayedTooltip (float x, float y)
	enable extended tooltip help message appropriate for mouse at (x,y) More...
virtual void	disableDelayedTooltip ()
virtual Units	units (bool check=false) const
	compute the dimensional units More...
Units	checkUnits () const
	perform units consistency checks More...
ItemPtr	itemPtrFromThis () const
	return a shared_ptr to this More...
Public Member Functions inherited from minsky::NoteBase
virtual std::string const &	detailedText () const
virtual std::string const &	detailedText (const std::string &x)
virtual std::string const &	tooltip () const
virtual std::string const &	tooltip (const std::string &x)
virtual	~NoteBase ()=default

Public Attributes
GodleyTable	table
	table data. Must be declared before editor More...
GodleyTableEditor	editor {*this}
	rendering as a godley table More...
GodleyTableWindow	popup {*this}
	for rendering the popup window More...
std::string	currency
Public Attributes inherited from minsky::Item
float	m_x =0
float	m_y =0
	position in canvas, or within group More...
float	m_sf =1
	scale factor of item on canvas, or within group More...
bool	onResizeHandles =false
	set to true to indicate mouse is ovcaler resize handles More...
bool	onBorder =false
	true to indicate mouse hovering over border More...
std::string	deleteCallback
BoundingBox	bb
	canvas bounding box. More...
Public Attributes inherited from minsky::NoteBase
bool	mouseFocus =false
	true if target of a mouseover More...
bool	selected =false
	true if selected for cut, copy or group operation More...
bool	bookmark =false
	Is this item also a bookmark? More...

Static Public Attributes
static SVGRenderer	svgRenderer
	SVG icon to display when not in editor mode. More...

Private Member Functions
	CLASSDESC_ACCESS (GodleyIcon)
void	updateBB ()
double	titleOffs () const
void	updateVars (Variables &vars, const vector< string > &varNames, VariableBase::Type varType)
void	positionVariables () const
	move contained variables to correct locations within icon More...
float	toEditorX (float) const
	convert mouse coordinates into editor coords More...
float	toEditorY (float) const
	convert mouse coordinates into editor coords More...

Private Attributes
float	flowMargin =0
	for placement of bank icon within complex More...
float	stockMargin =0
bool	m_editorMode =false
bool	m_variableDisplay =false
Variables	m_flowVars
Variables	m_stockVars

Friends
struct	SchemaHelper

Additional Inherited Members
Static Public Member Functions inherited from minsky::Item
static void	drawSelected (cairo_t *cairo)
Static Protected Member Functions inherited from minsky::Item
static void	drawResizeHandle (cairo_t *cairo, double x, double y, double sf, double angle)
Protected Attributes inherited from minsky::Item
double	m_width =10
double	m_height =10
ItemPortVector	m_ports
minsky::Item::MemoisedRotator	memoisedRotator

Detailed Description

Definition at line 41 of file godleyIcon.h.

Member Typedef Documentation

Variables

typedef std::vector<VariablePtr> minsky::GodleyIcon::Variables

Definition at line 111 of file godleyIcon.h.

Constructor & Destructor Documentation

GodleyIcon() [1/2]

minsky::GodleyIcon::GodleyIcon ( )

inline

Definition at line 64 of file godleyIcon.h.

References minsky::GodleyTableEditor::adjustWidgets(), minsky::GodleyTableEditor::disableButtons(), editor, minsky::Item::iHeight(), and minsky::Item::iWidth().

Referenced by clone().

{iWidth(150); iHeight(150); editor.adjustWidgets(); editor.disableButtons();}

Here is the call graph for this function:

Here is the caller graph for this function:

GodleyIcon() [2/2]

minsky::GodleyIcon::GodleyIcon ( const GodleyIcon &  )

default

~GodleyIcon()

minsky::GodleyIcon::~GodleyIcon ( )

inline

Definition at line 66 of file godleyIcon.h.

{Item::removeControlledItems();}

Member Function Documentation

adjustPopupWidgets()

void minsky::GodleyIcon::adjustPopupWidgets ( )

inline

Definition at line 85 of file godleyIcon.h.

References minsky::GodleyTableEditor::adjustWidgets(), and popup.

{popup.adjustWidgets();}

Here is the call graph for this function:

bottomMargin()

float minsky::GodleyIcon::bottomMargin ( ) const

inline

bottom margin of bank icon with Godley icon

Definition at line 93 of file godleyIcon.h.

References minsky::Item::scaleFactor(), stockMargin, variableDisplay(), and minsky::Item::zoomFactor().

{return variableDisplay()? stockMargin*scaleFactor()*zoomFactor(): 0;}

Here is the call graph for this function:

buttonDisplay()

bool minsky::GodleyIcon::buttonDisplay

(

)

const

enable/disable drawing buttons in table on canvas display

Definition at line 161 of file godleyIcon.cc.

{return m_editorMode && editor.drawButtons;}

CLASSDESC_ACCESS()

minsky::GodleyIcon::CLASSDESC_ACCESS ( GodleyIcon  )

private

clickType()

ClickType::Type minsky::GodleyIcon::clickType ( float  x, float  y  ) const

overridevirtual

returns the clicktype given a mouse click at x, y.

Reimplemented from minsky::Item.

Definition at line 589 of file godleyIcon.cc.

  {
    if (m_editorMode) return Item::clickType(x,y);
    const double dx=fabs(x-this->x()), dy=fabs(y-this->y());
    auto z=zoomFactor()*scaleFactor();
    const double w=0.5*iWidth()*z, h=0.5*iHeight()*z;
    if (onResizeHandle(x,y)) return ClickType::onResize;         
    // Make it possible to pull wires from variables attached to Godley icons. For ticket 940  
    if (auto item=select(x,y))
      return item->clickType(x,y);         
    if (dx < w && dy < h)
      return ClickType::onItem;
    return ClickType::outside;
  }

clone()

GodleyIcon* minsky::GodleyIcon::clone ( ) const

inlineoverridevirtual

Reimplemented from minsky::Item.

Definition at line 121 of file godleyIcon.h.

References GodleyIcon().

                                       {
      auto r=new GodleyIcon(*this);  
          r->update();       
          r->group.reset();
          return r;
    }      

Here is the call graph for this function:

deleteRow()

void minsky::GodleyIcon::deleteRow

(

unsigned

row

)

delete row before row

Definition at line 225 of file godleyIcon.cc.

References minsky::Minsky::balanceDuplicateColumns(), and pyminsky::minsky.

  {
    if (row>0 && row<=table.rows())
      {
        table.deleteRow(row-1);
        // if shared column data is deleted, remove it from the other tables too
        for (size_t col=1; col<table.cols(); ++col)
          minsky().balanceDuplicateColumns(*this, col);
        table.markEdited();
      }
  }

Here is the call graph for this function:

destroyFrame()

void minsky::GodleyIcon::destroyFrame ( )

inlineoverridevirtual

clean up popup window structures on window close

Reimplemented from minsky::Item.

Definition at line 162 of file godleyIcon.h.

References minsky::RenderNativeWindow::destroyFrame(), and popup.

{popup.destroyFrame();}

Here is the call graph for this function:

draw()

void minsky::GodleyIcon::draw ( cairo_t *  cairo ) const

overridevirtual

draw icon to context

Reimplemented from minsky::Item.

Definition at line 441 of file godleyIcon.cc.

References border, and minsky::latexToPango().

  {
    positionVariables();
    const float z=zoomFactor()*scaleFactor();
    float w=iWidth()*z+leftMargin(), h=iHeight()*z+bottomMargin(), left=-0.5*w, top=-0.5*h;
    double titley;
    
    if (m_editorMode)
      {
        const CairoSave cs(cairo);
        cairo_rectangle(cairo, left, top, w, h);
        cairo_rectangle(cairo, left-border*z, top-border*z, w+2*border*z, h+2*border*z);
        cairo_stroke_preserve(cairo);
        if (onBorder)
          { // shadow the border when mouse is over it
            const cairo::CairoSave cs(cairo);
            cairo_set_source_rgba(cairo,0.5,0.5,0.5,0.5);
            cairo_set_fill_rule(cairo,CAIRO_FILL_RULE_EVEN_ODD);
            cairo_fill(cairo);
          }
        cairo_new_path(cairo);
        cairo_rectangle(cairo, left, top, w, h);
        cairo_clip(cairo);
        cairo_translate(cairo,left+border*z+leftMargin(),top+border*z+titleOffs()/* space for title*/);
        // render to a recording surface to determine size of editor table
        // TODO - maybe move this stuff into update()
        const Surface surf(cairo_recording_surface_create(CAIRO_CONTENT_COLOR, nullptr));
        const_cast<GodleyTableEditor&>(editor).zoomFactor=1;
        const_cast<GodleyTableEditor&>(editor).draw(surf.cairo());
        const_cast<GodleyTableEditor&>(editor).zoomFactor=min((w-leftMargin()-2*border*z)/surf.width(),(h-bottomMargin()-2*border*z-titleOffs())/surf.height());
        const_cast<GodleyTableEditor&>(editor).draw(cairo);
        titley=-0.5*h;
        w+=2*border*z;
        h+=2*border*z;
        left-=border*z;
        top-=border*z;
      }
    else
      {
        const CairoSave cs(cairo);
        cairo_translate(cairo,left+leftMargin(),top);
        cairo_scale(cairo, (w-leftMargin())/svgRenderer.width(), (h-bottomMargin())/svgRenderer.height());
        svgRenderer.render(cairo);
        titley=top+0.1*(h-bottomMargin());
      }
    
    if (!table.title.empty())
      {
        const CairoSave cs(cairo);
        Pango pango(cairo);
        pango.setMarkup("<b>"+latexToPango(table.title)+"</b>");
        pango.setFontSize(titleOffs());
        cairo_move_to(cairo,-0.5*(pango.width()-leftMargin()), titley);
        pango.show();
      }
      
          

    if (m_variableDisplay && (!m_editorMode || wiresAttached()))
      {
        // render the variables
        const DrawVars drawVars(cairo,x(),y());
        drawVars(m_flowVars); 
        drawVars(m_stockVars); 
      }
    
    if (mouseFocus)
      {
        drawPorts(cairo);
        displayTooltip(cairo,tooltip());
        drawResizeHandles(cairo);
      }
      
    cairo_rectangle(cairo, left,top, w, h);    
    cairo_clip(cairo);
    if (selected)
      {
        drawSelected(cairo);
      }
  }

Here is the call graph for this function:

editorMode()

bool minsky::GodleyIcon::editorMode ( ) const

inlineoverridevirtual

indicate whether icon is in editor mode or icon mode

Reimplemented from minsky::Item.

Definition at line 69 of file godleyIcon.h.

References m_editorMode.

{return m_editorMode;}

flowSignature()

map< string, double > minsky::GodleyIcon::flowSignature

(

unsigned

col

)

const

flows, along with multipliers, appearing in col

Definition at line 258 of file godleyIcon.cc.

Referenced by minsky::Minsky::balanceColumns().

  {
    map<string,double> r;
    for (size_t row=1; row<table.rows() && col<table.cols(); ++row)
      if (!table.initialConditionRow(row))
        {
          const FlowCoef fc(table.cell(row,col));
          if (!fc.name.empty())
            r[fc.name]+=fc.coef;
        }
    return r;
  }

Here is the caller graph for this function:

flowVars()

const Variables& minsky::GodleyIcon::flowVars ( ) const

inline

Definition at line 112 of file godleyIcon.h.

References m_flowVars.

{return m_flowVars;}

godleyIconCast() [1/2]

const GodleyIcon* minsky::GodleyIcon::godleyIconCast ( ) const

inlineoverride

Definition at line 167 of file godleyIcon.h.

{return this;}

godleyIconCast() [2/2]

GodleyIcon* minsky::GodleyIcon::godleyIconCast ( )

inlineoverride

Definition at line 168 of file godleyIcon.h.

{return this;}

inItem()

bool minsky::GodleyIcon::inItem ( float  x, float  y  ) const

overridevirtual

Returns

true if item internally responds to the mouse, and (x,y) is within editable area

Reimplemented from minsky::Item.

Definition at line 89 of file godleyIcon.cc.

References border.

  {
    return abs(xx-x())<0.5*width()-border && abs(yy-y())<0.5*height()-border;
  }

insertControlled()

void minsky::GodleyIcon::insertControlled ( Selection &  selection )

override

Definition at line 581 of file godleyIcon.cc.

References minsky::Selection::ensureItemInserted().

  {
    for (const auto& i: flowVars())
      selection.ensureItemInserted(i);
    for (const auto& i: stockVars())
      selection.ensureItemInserted(i);
  }

Here is the call graph for this function:

leftMargin()

float minsky::GodleyIcon::leftMargin ( ) const

inline

left margin of bank icon with Godley icon

Definition at line 91 of file godleyIcon.h.

References flowMargin, minsky::Item::scaleFactor(), variableDisplay(), and minsky::Item::zoomFactor().

{return variableDisplay()? flowMargin*scaleFactor()*zoomFactor(): 0;}

Here is the call graph for this function:

moveCell()

void minsky::GodleyIcon::moveCell

(

const GodleyIcon::MoveCellArgs &

args

)

Definition at line 238 of file godleyIcon.cc.

References minsky::GodleyIcon::MoveCellArgs::destCol, minsky::GodleyIcon::MoveCellArgs::destRow, minsky::GodleyIcon::MoveCellArgs::srcCol, and minsky::GodleyIcon::MoveCellArgs::srcRow.

  {
    if (!table.cellInTable(args.srcRow, args.srcCol) || !table.cellInTable(args.destRow, args.destCol)) return;
    if (args.srcCol!=args.destCol) // if moving between columns, we can delete and
      // add, which ensures any linked columns are
      // correctly updated
      {
        // create a copy here, as setCell may resize the array, changing 
        // what the reference referred to.
        const string oldVal=table.cell(args.srcRow, args.srcCol);
        setCell(args.destRow, args.destCol, oldVal);
        setCell(args.srcRow, args.srcCol, "");
      }
    else // within a column, just move the data without affecting any linked column
      {
        table.cell(args.destRow, args.destCol)=table.cell(args.srcRow, args.srcCol);
        table.cell(args.srcRow, args.srcCol)="";
      }
  }

onKeyPress()

bool minsky::GodleyIcon::onKeyPress ( int  keySym, const std::string &  utf8, int  state  )

overridevirtual

respond to key press events

Returns

true if it needs to be rerendered

Reimplemented from minsky::Item.

Definition at line 639 of file godleyIcon.cc.

  {
    if (m_editorMode) editor.keyPress(keySym, utf8);
    return m_editorMode;
  }

onMouseDown()

void minsky::GodleyIcon::onMouseDown ( float  x, float  y  )

overridevirtual

respond to mouse down events

Reimplemented from minsky::Item.

Definition at line 609 of file godleyIcon.cc.

  {if (m_editorMode) editor.mouseDown(toEditorX(x),toEditorY(y));}

onMouseLeave()

void minsky::GodleyIcon::onMouseLeave ( )

overridevirtual

respond to mouse leave events (when mouse leaves item)

Reimplemented from minsky::Item.

Definition at line 627 of file godleyIcon.cc.

  {
    if (m_editorMode)
      {
        editor.mouseMove(-1,-1);
        // May be a bit overzealous, but it solves bug 1273, which is caused by a flow which has not yet fully come into existence....
        editor.selectedCol=-1;
        editor.selectedRow=-1;
        editor.update();
      }
  }

onMouseMotion()

bool minsky::GodleyIcon::onMouseMotion ( float  x, float  y  )

overridevirtual

respond to mouse motion events with button pressed

Returns

true if it needs to be rerendered

Reimplemented from minsky::Item.

Definition at line 615 of file godleyIcon.cc.

  {
    if (m_editorMode) editor.mouseMoveB1(toEditorX(x),toEditorY(y));
    return false;
  }

onMouseOver()

bool minsky::GodleyIcon::onMouseOver ( float  x, float  y  )

overridevirtual

respond to mouse motion events (hover) without button pressed

Returns

true if it needs to be rerendered

Reimplemented from minsky::Item.

Definition at line 621 of file godleyIcon.cc.

  {
    if (m_editorMode) editor.mouseMove(toEditorX(x),toEditorY(y));
    return false;
  }

onMouseUp()

void minsky::GodleyIcon::onMouseUp ( float  x, float  y  )

overridevirtual

respond to mouse up events

Reimplemented from minsky::Item.

Definition at line 612 of file godleyIcon.cc.

  {if (m_editorMode) editor.mouseUp(toEditorX(x),toEditorY(y));}

positionVariables()

void minsky::GodleyIcon::positionVariables ( ) const

private

move contained variables to correct locations within icon

Definition at line 389 of file godleyIcon.cc.

  {
    // position of margin in absolute canvas coordinate
    const float z=this->zoomFactor()*scaleFactor();
    float x= this->x() - 0.5*iWidth()*z+0.5*leftMargin();
    float y= this->y() - 0.5*bottomMargin()-0.15*iHeight()*z;
    for (const auto& v: m_flowVars)
      {
        // right justification if displayed, left otherwisw
        v->rotation(0);
        v->moveTo(x+v->x() - (m_variableDisplay? v->right(): v->left()), y);
        y+=v->height();
      }
    x= this->x() + 0.55*leftMargin()-0.45*iWidth()*z;
    y= this->y() + 0.5*iHeight()*z-0.5*bottomMargin();

    for (const auto& v: m_stockVars)
      {
        // top justification at bottom of icon if displayed, bottom justified otherwise
        v->rotation(90);
        v->moveTo(x, y + v->y() - (m_variableDisplay? v->top(): v->bottom()));
        x+=v->width();
      }
  }

removeControlledItems()

void minsky::GodleyIcon::removeControlledItems ( GroupItems &  g )

override

Definition at line 189 of file godleyIcon.cc.

References minsky::GroupItems::removeItem().

  {
    for (auto& i: m_flowVars)
      {
        assert(i);
        i->deleteAttachedWires();
        auto item=g.removeItem(*i);
        assert(item.use_count()!=1);
      }
    m_flowVars.clear();
    for (auto& i: m_stockVars)
      {
        assert(i);
        i->deleteAttachedWires();
        auto item=g.removeItem(*i);
        assert(item.use_count()!=1);
      }
    m_stockVars.clear();
  }

Here is the call graph for this function:

resize()

void minsky::GodleyIcon::resize ( const LassoBox &  b )

overridevirtual

resize this item on the canvas

Reimplemented from minsky::Item.

Definition at line 177 of file godleyIcon.cc.

References minsky::LassoBox::x0, minsky::LassoBox::x1, minsky::LassoBox::y0, and minsky::LassoBox::y1.

  {
    const float invZ=1.0/(this->zoomFactor());
    auto bw=abs(b.x0-b.x1), bh=abs(b.y0-b.y1);
    if (bw<=leftMargin() || bh<=bottomMargin()) return;
    moveTo(0.5*(b.x0+b.x1), 0.5*(b.y0+b.y1));
    iWidth((bw-leftMargin())*invZ);
    iHeight((bh-bottomMargin())*invZ);  
    scaleIcon(bw,bh);
    updateBoundingBox();
  }

rowSum()

string minsky::GodleyIcon::rowSum

(

int

row

)

const

return the A-L-E row sum for row

Definition at line 522 of file godleyIcon.cc.

References minsky::str(), minsky::trimWS(), and minsky::valueId().

  {
    if (row==0) // A-L-E sum values across stockvars
      {
        map<string,VariablePtr> stockVars;
        for (const auto& i: m_stockVars)
          stockVars[i->valueId()]=i;
        double sum=0, absSum=0;
        for (size_t c=1; c<table.cols(); ++c)
          {
            auto i=stockVars.find(minsky::valueId(group.lock(), trimWS(table.cell(0,c))));
            if (i!=stockVars.end())
              {
                sum+=(table.signConventionReversed(c)? -1: 1)*i->second->value();
                absSum+=abs(i->second->value());
              }
          }
        if (sum<1E-4*absSum) sum=0; // eschew excess precision. For #1328
        return str(sum);
      }
    return table.rowSum(row);
  }

Here is the call graph for this function:

scaleIcon()

void minsky::GodleyIcon::scaleIcon	(	float	w,
		float	h
	)

scale icon until it's height or width matches h or w depending on which is minimum

Definition at line 171 of file godleyIcon.cc.

  {
    update();
    scaleFactor(min(w/(leftMargin()+iWidth()*zoomFactor()),h/(bottomMargin()+iHeight()*zoomFactor())));
  }  

select()

ItemPtr minsky::GodleyIcon::select ( float  x, float  y  ) const

overridevirtual

returns the variable if point (x,y) is within a variable icon, null otherwise, indicating that the Godley table has been selected.

Reimplemented from minsky::Item.

Definition at line 414 of file godleyIcon.cc.

  {
        if (m_variableDisplay)           // Disable selection of stock and flow vars when they are hidden. for tickets 1217 and 1220.
        {   
       for (const auto& v: m_flowVars)
         if (v->contains(x,y)) 
           return v;
       for (const auto& v: m_stockVars)
         if (v->contains(x,y)) 
           return v; 
     }
    return ItemPtr();
  }

setCell()

void minsky::GodleyIcon::setCell	(	int	row,
		int	col,
		const string &	val
	)

set cell(row,col) with contents val

Definition at line 209 of file godleyIcon.cc.

References minsky::Minsky::balanceDuplicateColumns(), minsky::Minsky::importDuplicateColumn(), and pyminsky::minsky.

  {
    if (!table.cellInTable(row,col)) return;
    // if this operation is clearing an initial condition cell, set it to 0
    string& c=table.cell(row,col);
    if (newVal.empty() && !c.empty() && table.initialConditionRow(row))
      c="0";
    else
      c=newVal; 
    if (row==0)
      minsky().importDuplicateColumn(table, col);
    else
      minsky().balanceDuplicateColumns(*this, col);
    table.markEdited();
  }

Here is the call graph for this function:

setCurrency()

void minsky::GodleyIcon::setCurrency ( const std::string &  currency )

inline

Definition at line 148 of file godleyIcon.h.

References currency, and m_stockVars.

    {this->currency=currency; for (auto& i: m_stockVars) i->setUnits(currency);}

stockVars()

const Variables& minsky::GodleyIcon::stockVars ( ) const

inline

Definition at line 113 of file godleyIcon.h.

References m_stockVars.

{return m_stockVars;}

stockVarUnits()

Units minsky::GodleyIcon::stockVarUnits	(	const std::string &	stockName,
		bool	check
	)		const

performs dimensional analysis on stock var column stockName

Parameters

check

indicates whether a consistency check is applied

Definition at line 545 of file godleyIcon.cc.

References minsky::cminsky(), minsky::Units::str(), minsky::Simulation::timeUnit, minsky::valueId(), and minsky::Minsky::variableValues.

  {
    unsigned stockCol=1;
    auto valId=valueId(stockName);
    for (; stockCol<table.cols(); ++stockCol)
      if (valueId(table.cell(0,stockCol))==valId)
        break;

    if (stockCol>=table.cols()) return {};

    bool foundFlow=false;
    Units units;
    for (unsigned row=1; row<table.rows(); ++row)
      {
        if (table.initialConditionRow(row)) continue;
        const FlowCoef fc(table.cell(row,stockCol));
        if (fc.coef!=0)
          {
            auto vid=valueId(fc.name);
            // find variable assciated with this flow
            for (const auto& v: flowVars())
              if (v->valueId()==vid)
                {
                  auto flowUnits=v->units(check);
                  if (check && foundFlow && units!=flowUnits)
                    throw_error("incompatible units: "+flowUnits.str()+"≠"+units.str()+" on stock "+stockName);
                  foundFlow=true;
                  units=flowUnits;
                }
          }
      }
    if (!cminsky().timeUnit.empty())
      units[cminsky().timeUnit]++;
    return foundFlow? units: cminsky().variableValues[valId]->units;
  }

Here is the call graph for this function:

summarise()

vector< Summary > minsky::GodleyIcon::summarise

(

)

const

summary of variables in this godley table

Definition at line 271 of file godleyIcon.cc.

  {
    vector<Summary> r;
    for (auto& i: stockVars())
      if (auto vv=i->vValue())
        {
          r.push_back(vv->summary());
          r.back().godley=table.title.empty()? id(): table.title;
        }
    for (auto& i: flowVars())
      if (auto vv=i->vValue())
        {
          r.push_back(vv->summary());
          r.back().godley=table.title.empty()? id(): table.title;
        }
    return r;
  }

titleOffs()

double minsky::GodleyIcon::titleOffs ( ) const

inlineprivate

Definition at line 59 of file godleyIcon.h.

References table, minsky::GodleyTable::title, and minsky::Item::zoomFactor().

{return !table.title.empty()? 15*zoomFactor(): 0;}

Here is the call graph for this function:

toEditorX()

float minsky::GodleyIcon::toEditorX ( float  xx ) const

private

convert mouse coordinates into editor coords

Definition at line 604 of file godleyIcon.cc.

References border.

  {return xx-x()+0.5f*width()-2*border*zoomFactor()-leftMargin();}

toEditorY()

float minsky::GodleyIcon::toEditorY ( float  yy ) const

private

convert mouse coordinates into editor coords

Definition at line 606 of file godleyIcon.cc.

References border.

  {return yy-y()+0.5f*height()-2*border*zoomFactor()-titleOffs();}

toggleButtons()

void minsky::GodleyIcon::toggleButtons

(

)

Definition at line 162 of file godleyIcon.cc.

  {
    if (editor.drawButtons)
      editor.disableButtons();
    else
      editor.enableButtons();
    updateBoundingBox();
  }

toggleEditorMode()

void minsky::GodleyIcon::toggleEditorMode ( )

overridevirtual

Reimplemented from minsky::Item.

Definition at line 155 of file godleyIcon.cc.

  {
    m_editorMode=!m_editorMode;
    updateBoundingBox();
  }

toggleVariableDisplay()

void minsky::GodleyIcon::toggleVariableDisplay

(

)

Definition at line 149 of file godleyIcon.cc.

  {
    m_variableDisplay=!m_variableDisplay;
    update();
  }

update()

void minsky::GodleyIcon::update

(

)

updates the variable lists with the Godley table

Definition at line 289 of file godleyIcon.cc.

References minsky::anonymous_namespace{godleyIcon.cc}::accumulateWidthHeight(), minsky::FlowCoef::coef, minsky::Minsky::definingVar(), f, minsky::VariableValueData::godleyOverridden, minsky::VariableValue::init(), pyminsky::minsky, minsky::FlowCoef::str(), minsky::trimWS(), minsky::valueId(), and minsky::Minsky::variableValues.

  {
    updateVars(m_stockVars, table.getColumnVariables(), VariableType::stock);
    updateVars(m_flowVars, table.getVariables(), VariableType::flow);

    // retrieve initial conditions, if any
    for (size_t r=1; r<table.rows(); ++r)
      if (table.initialConditionRow(r))
        for (size_t c=1; c<table.cols(); ++c)
          {
            const string name=trimWS(table.cell(0,c));           
            auto vi=minsky().variableValues.find(minsky::valueId(group.lock(),name));
            if (vi==minsky().variableValues.end()) continue;
            VariableValue& v=*vi->second;           
            v.godleyOverridden=false;
            const string::size_type start=table.cell(r,c).find_first_not_of(' ');
            if (start!=string::npos)
              {
                const FlowCoef fc(table.cell(r,c).substr(start));                                      
                v.init(fc.str());              
                // set initial value of stock var to init value of flow that is defined by a parameter or a constant. for ticket 1137
                if (auto initVar=minsky().definingVar(minsky::valueId(group.lock(),fc.str())))
                  if (initVar->inputWired() && initVar->type()==VariableType::flow)
                    if (auto* lhsVar=initVar->ports(1).lock()->wires()[0]->from()->item().variableCast()) {
                      FlowCoef fc1(lhsVar->vValue()->init());
                      fc1.coef*=fc.coef;
                      v.init(fc1.str());        
                    }       
                v.godleyOverridden=true;
              }
            else
              { 
                // populate cell with current variable's initial value
                const FlowCoef fc(v.init());   
                table.cell(r,c)=fc.str();
                v.godleyOverridden=true;
              }

          }

    if (m_variableDisplay)
      {
        // determine height of variables part of icon
        float stockH=0, flowH=0;
        stockMargin=0;
        flowMargin=0;
        accumulateWidthHeight(m_stockVars, stockH, stockMargin);
        accumulateWidthHeight(m_flowVars, flowH, flowMargin);
        // allow for notches on variables
        stockMargin+=4;
        flowMargin+=4;
        const float iw=this->iWidth(), ih=this->iHeight();
        this->iWidth(max(iw, 1.8f*stockH));
        this->iHeight(max(ih, 1.8f*flowH));
      }
    else
      { // if any variables have attached wires, create a copy to carry the wire
        for (auto& v: m_stockVars)
          if (auto p=v->ports(0).lock())
            if (!p->wires().empty())
              {
                if (auto g=group.lock())
                  {
                    auto newVar=g->addItem(v->clone());
                    if (auto w=p->wires().front())
                      if (auto from=newVar->ports(0).lock())
                        {
                          w->moveToPorts(from, w->to());
                          continue;
                        }
                  }
                // in falling through to here, we've failed to create and wire a variable copy
                m_variableDisplay=true;
                throw_error("Cowardly refusing to hide a wired variable");
              }
        
        for (auto& v: m_flowVars)
          if (auto p=v->ports(1).lock())
            if (!p->wires().empty())
              {
                if (auto g=group.lock())
                  {
                    auto newVar=g->addItem(v->clone());
                    if (auto w=p->wires().front())
                      if (auto to=newVar->ports(1).lock())
                        {
                          w->moveToPorts(w->from(), to);
                          continue;
                        }
                  }
                // in falling through to here, we've failed to create and wire a variable copy
                m_variableDisplay=true;
                throw_error("Cowardly refusing to hide a wired variable");
              }
      }
    
    positionVariables();
    updateBB();
  }

Here is the call graph for this function:

updateBB()

void minsky::GodleyIcon::updateBB ( )

inlineprivate

Definition at line 52 of file godleyIcon.h.

References minsky::Item::bb, minsky::NoteBase::selected, and minsky::BoundingBox::update().

                    {
      auto wasSelected=selected;
      selected=true; // ensure bounding box is set to the entire icon
      bb.update(*this); 
      selected=wasSelected;
    }

Here is the call graph for this function:

updateVars()

void minsky::GodleyIcon::updateVars ( GodleyIcon::Variables &  vars, const vector< string > &  varNames, VariableBase::Type  varType  )

private

Definition at line 94 of file godleyIcon.cc.

References minsky::Minsky::convertVarType(), and minsky::minsky().

  {
    // update the map of variables from the Godley table
    set<VariablePtr, OrderByName> oldVars(vars.begin(), vars.end());
    set<string> alreadyAdded;

    vars.clear();
    shared_ptr<GodleyIcon> self;
    if (auto g=group.lock())
      self=dynamic_pointer_cast<GodleyIcon>(g->findItem(*this));
      
    for (vector<string>::const_iterator nm=varNames.begin(); nm!=varNames.end(); ++nm)
      {
        const VariablePtr newVar(varType, *nm);
        auto myGroup=group.lock();
        if (myGroup) myGroup->addItem(newVar); // get scope right
        auto v=oldVars.find(newVar);
          
        if (v==oldVars.end())
          {     
            // allow for the possibility that multiple names map to the same valueId
            if (!alreadyAdded.contains(newVar->valueId()))
              {
                // add new variable
                vars.push_back(newVar);
                alreadyAdded.insert(newVar->valueId());
                if (varType==VariableType::stock) // newly added variables should take the default dimension
                  newVar->setUnits(currency);
              }
            else
              if (myGroup)
                myGroup->removeItem(*newVar);
          }
        else
          {
            // move existing variable
            assert(*v);
            vars.push_back(*v);
            alreadyAdded.insert(newVar->valueId());
            oldVars.erase(v);
            if (myGroup) myGroup->removeItem(*newVar);
          }
        if (myGroup) myGroup->addItem(vars.back(),true);
        vars.back()->controller=self;
        // ensure variable type is consistent
        minsky::minsky().convertVarType(vars.back()->valueId(), varType);
      }
    // remove any previously existing variables
    if (auto g=group.lock())
      for (const auto& v: oldVars)
        g->deleteItem(*v);   
  }

Here is the call graph for this function:

valueId()

std::string minsky::GodleyIcon::valueId ( const std::string &  x ) const

inline

returns valueid for variable reference in table

Definition at line 142 of file godleyIcon.h.

References minsky::valueId(), and minsky::Item::x().

Referenced by minsky::Minsky::balanceColumns(), and minsky::Minsky::balanceDuplicateColumns().

{return minsky::valueId(group.lock(), x);}

Here is the call graph for this function:

Here is the caller graph for this function:

variableDisplay()

bool minsky::GodleyIcon::variableDisplay ( ) const

inline

Definition at line 76 of file godleyIcon.h.

References m_variableDisplay.

Referenced by bottomMargin(), and leftMargin().

{return m_variableDisplay;}

Here is the caller graph for this function:

wiresAttached()

bool minsky::GodleyIcon::wiresAttached

(

)

const

return true if any wires are attached to the variables

Definition at line 428 of file godleyIcon.cc.

  {
    bool r=false;
    for (auto& v: m_flowVars)
      if (auto p=v->ports(1).lock())
        r|=p->wires().size();
    for (auto& v: m_stockVars)
      if (auto p=v->ports(0).lock())
        r|=p->wires().size();
    return r;
  }

Friends And Related Function Documentation

SchemaHelper

friend struct SchemaHelper

friend

Definition at line 49 of file godleyIcon.h.

Member Data Documentation

currency

std::string minsky::GodleyIcon::currency

Definition at line 147 of file godleyIcon.h.

Referenced by setCurrency().

editor

GodleyTableEditor minsky::GodleyIcon::editor {*this}

rendering as a godley table

Definition at line 82 of file godleyIcon.h.

Referenced by GodleyIcon().

flowMargin

float minsky::GodleyIcon::flowMargin =0

private

for placement of bank icon within complex

Definition at line 45 of file godleyIcon.h.

Referenced by leftMargin().

m_editorMode

bool minsky::GodleyIcon::m_editorMode =false

private

Definition at line 46 of file godleyIcon.h.

Referenced by editorMode().

m_flowVars

Variables minsky::GodleyIcon::m_flowVars

private

Definition at line 176 of file godleyIcon.h.

Referenced by flowVars(), and minsky::SchemaHelper::setStockAndFlow().

m_stockVars

Variables minsky::GodleyIcon::m_stockVars

private

Definition at line 176 of file godleyIcon.h.

Referenced by setCurrency(), minsky::SchemaHelper::setStockAndFlow(), and stockVars().

m_variableDisplay

bool minsky::GodleyIcon::m_variableDisplay =false

private

Definition at line 47 of file godleyIcon.h.

Referenced by minsky::SchemaHelper::setVariableDisplay(), and variableDisplay().

popup

GodleyTableWindow minsky::GodleyIcon::popup {*this}

for rendering the popup window

Definition at line 84 of file godleyIcon.h.

Referenced by adjustPopupWidgets(), and destroyFrame().

stockMargin

float minsky::GodleyIcon::stockMargin =0

private

Definition at line 45 of file godleyIcon.h.

Referenced by bottomMargin().

svgRenderer

SVGRenderer minsky::GodleyIcon::svgRenderer

static

SVG icon to display when not in editor mode.

Definition at line 62 of file godleyIcon.h.

Referenced by minsky::Minsky::setGodleyIconResource().

table

GodleyTable minsky::GodleyIcon::table

table data. Must be declared before editor

Definition at line 80 of file godleyIcon.h.

Referenced by minsky::Minsky::balanceColumns(), minsky::Minsky::balanceDuplicateColumns(), schema3::Item::Item(), MathDAG::SystemOfEquations::processGodleyTable(), minsky::SchemaHelper::setPrivates(), and titleOffs().

---

The documentation for this class was generated from the following files:

• model/godleyIcon.h
• model/godleyIcon.cc