#include <variable.h>

Inheritance diagram for minsky::VariableBase:

Collaboration diagram for minsky::VariableBase:

Public Types
typedef VariableType::Type	Type

Public Types inherited from minsky::VariableType
enum	Type { undefined, constant, parameter, flow, integral, stock, tempFlow, numVarTypes }

Public Member Functions
virtual std::size_t	numPorts () const =0

virtual Type	type () const =0

void	retype (VariableType::Type type)
	attempt to replace this variable with variable of type. More...

bool	visible () const override
	whether this item is visible on the canvas. More...

const VariableBase *	variableCast () const override

VariableBase *	variableCast () override

float	zoomFactor () const override

bool	local () const

void	toggleLocal ()
	toggle local status More...

const std::string &	rawName () const
	accessor for the name member (may differ from name() with top level variables) More...

bool	ioVar () const override
	indicates this is a group I/O variable More...

void	ensureValueExists (VariableValue *vv, const std::string &name) const
	ensure an associated variableValue exists More...

virtual std::string	valueId () const
	string used to link to the VariableValue associated with this More...

std::string	valueIdInCurrentScope (const std::string &nm) const
	returns valueId for nm. If nm is not qualified, this variable's scope is used More...

std::shared_ptr< VariableValue >	vValue () const
	variableValue associated with this. nullptr if not associated with a variableValue More...

std::vector< unsigned >	dims () const
	variable's tensor shape More...

std::vector< std::string >	dimLabels () const
	labels along each axis More...

std::pair< std::string, std::string >	getDimLabelsPicked () const

std::pair< std::string, std::string >	setDimLabelsPicked (const std::string &dimLabel1, const std::string &dimLabel2)

const std::string &	detailedText () const override

const std::string &	detailedText (const std::string &x) override

const std::string &	tooltip () const override

const std::string &	tooltip (const std::string &x) override

bool	sliderVisible () const
	returns true if slider is to be drawn More...

Units	units (bool check) const override
	sets/gets the units associated with this type More...

Units	units () const

void	setUnits (const std::string &) const

std::string	unitsStr () const

bool	onKeyPress (int, const std::string &, int) override
	respond to key press events More...

bool	lhs () const
	variable is on left hand side of flow calculation More...

bool	temp () const
	variable is temporary More...

virtual VariableBase *	clone () const override=0

bool	isStock () const

std::string	definition () const
	formula defining this variable More...

void	draw (cairo_t *) const override

void	resize (const LassoBox &b) override
	resize this item on the canvas More...

ClickType::Type	clickType (float x, float y) const override
	returns the clicktype given a mouse click at x, y. More...

bool	defined () const

bool	inputWired () const

std::vector< std::string >	accessibleVars () const
	return a list of existing variables this could be connected to More...

EngNotation	engExp () const
	return formatted mantissa and exponent in engineering format More...

std::string	mantissa (const EngNotation &e, int digits=3) const

void	exportAsCSV (const std::string &filename, bool tabular) const
	export this variable as a CSV file More...

void	importFromCSV (const std::vector< std::string > &filenames, const DataSpecSchema &spec) const
	import CSV files, using spec More...

void	destroyFrame () override
	clean up popup window structures on window close More...

bool	miniPlotEnabled () const

bool	miniPlotEnabled (bool)

void	resetMiniPlot ()

bool	onMouseMotion (float x, float y) override
	respond to mouse motion events with button pressed More...

void	adjustSliderBounds ()


virtual std::string	name () const
	variable displayed name More...

virtual std::string	name (const std::string &nm)
	variable displayed name More...

const std::string &	canonicalName () const
	variable displayed name More...


std::string	init () const
	the initial value of this variable More...

std::string	init (const std::string &)
	< return initial value for this variable More...


virtual double	value (const double &)
	< set the initial value for this variable More...

virtual double	value () const override
	< set the initial value for this variable More...


double	sliderMin () const
	slider parameters More...

double	sliderMin (double) const
	slider parameters More...

double	sliderMax () const
	slider parameters More...

double	sliderMax (double) const
	slider parameters More...

double	sliderStep () const
	slider parameters More...

double	sliderStep (double) const
	slider parameters More...

bool	sliderStepRel () const
	slider parameters More...

bool	sliderStepRel (bool) const
	slider parameters More...

bool	enableSlider () const
	slider parameters More...

bool	enableSlider (bool)
	slider parameters More...

Public Member Functions inherited from minsky::BottomRightResizerItem
bool	onResizeHandle (float x, float y) const override

void	drawResizeHandles (cairo_t *cairo) const override

virtual Point	resizeHandleCoords () const
	returns coordinates of the resizer handle More...

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...

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...

virtual std::string	classType () const

std::string	id () const
	return an id uniquely identifying this item More...

virtual float	x () const

virtual float	y () 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	inItem (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	onMouseDown (float x, float y)
	respond to mouse down events More...

virtual void	onMouseUp (float x, float y)
	respond to mouse up events More...

virtual bool	onMouseOver (float x, float y)
	respond to mouse motion events (hover) without button pressed More...

virtual void	onMouseLeave ()
	respond to mouse leave events (when mouse leaves item) More...

virtual void	deleteAttachedWires ()
	delete all attached wires 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 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

virtual std::shared_ptr< Item >	select (float x, float y) const
	returns the variable if point (x,y) is within a visible variable icon, null otherwise. More...

virtual void	TCL_obj (classdesc::TCL_obj_t &t, const std::string &d)
	runs the TCL_obj descriptor suitable for this type More...

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	json_pack (classdesc::json_pack_t &j) const

virtual void	displayDelayedTooltip (float x, float y)
	enable extended tooltip help message appropriate for mouse at (x,y) More...

virtual void	disableDelayedTooltip ()

virtual bool	editorMode () const
	some items have an editor mode attribute More...

virtual void	toggleEditorMode ()

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	~NoteBase ()=default

Public Member Functions inherited from minsky::VarAccessors::NameAccessor
	NameAccessor ()

Public Member Functions inherited from minsky::VarAccessors::InitAccessor
	InitAccessor ()

Public Member Functions inherited from minsky::VarAccessors::ValueAccessor
	ValueAccessor ()

Public Member Functions inherited from minsky::VariableCaches
	VariableCaches ()=default

	VariableCaches (const VariableCaches &)

VariableCaches &	operator= (const VariableCaches &)

Static Public Member Functions
static VariableBase *	create (Type type)

Static Public Member Functions inherited from minsky::Item
static void	drawSelected (cairo_t *cairo)

Static Public Member Functions inherited from minsky::VariableType
static std::string	typeName (int t)

Public Attributes
classdesc::Exclude< std::weak_ptr< Item > >	controller
	reference to a controlling item - eg GodleyIcon, IntOp or a Group if an IOVar. More...

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 int	varsPassed =0
	for caching units calculation factory method More...

Protected Member Functions
void	addPorts ()

Private Member Functions
	CLASSDESC_ACCESS (VariableBase)

void	insertControlled (Selection &selection) override

Private Attributes
std::string	m_name

std::string	m_canonicalName
	latex processed and active stripped version of name More...

std::pair< std::string, std::string >	m_dimLabelsPicked

int	unitsCtr =0
	for detecting reentrancy in units() More...

classdesc::Exclude< std::shared_ptr< ecolab::Plot > >	miniPlot
	miniature plot feature More...

Static Private Attributes
static int	stockVarsPassed =0
	for detecting reentrancy in units() More...

Friends
struct	minsky::SchemaHelper

Additional Inherited Members
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

Protected Attributes inherited from minsky::VariableCaches
classdesc::Exclude< std::shared_ptr< RenderVariable > >	cachedNameRender
	cached Pango objects More...

classdesc::Exclude< std::shared_ptr< ecolab::Pango > >	cachedMantissa

classdesc::Exclude< std::shared_ptr< ecolab::Pango > >	cachedExponent

double	cachedValue

double	cachedTime

Detailed Description

Definition at line 87 of file variable.h.

Member Typedef Documentation

◆ Type

typedef VariableType::Type minsky::VariableBase::Type

Definition at line 96 of file variable.h.

Member Function Documentation

◆ accessibleVars()

std::vector< std::string > VariableBase::accessibleVars ( ) const

return a list of existing variables this could be connected to

Definition at line 89 of file variable.cc.

 {
   if (auto g=group.lock())
     return g->accessibleVars();
   return {};
 }

◆ addPorts()

void VariableBase::addPorts ( )

protected

Definition at line 69 of file variable.cc.

References minsky::Item::m_ports, and numPorts().

Referenced by minsky::Variable< VariableType::constant >::operator=(), minsky::PhillipsStock::PhillipsStock(), and minsky::Variable< VariableType::constant >::Variable().

 {
 #ifndef NDEBUG
   for (auto& i: m_ports)
     assert(i.use_count()==1);
 #endif
   m_ports.clear();
   if (numPorts()>0)
     m_ports.emplace_back(make_shared<Port>(*this));
   for (size_t i=1; i<numPorts(); ++i)
     m_ports.emplace_back(make_shared<InputPort>(*this));
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ adjustSliderBounds()

void VariableBase::adjustSliderBounds ( )

Definition at line 555 of file variable.cc.

References vValue().

 {
   if (auto vv=vValue())
     vv->adjustSliderBounds();
 }

Here is the call graph for this function:

◆ canonicalName()

const std::string& minsky::VariableBase::canonicalName ( ) const

inline

variable displayed name

Definition at line 145 of file variable.h.

References m_canonicalName.

145 {return m_canonicalName;}

minsky::VariableBase::m_canonicalName

std::string m_canonicalName

latex processed and active stripped version of name

Definition: variable.h:102

◆ CLASSDESC_ACCESS()

minsky::VariableBase::CLASSDESC_ACCESS ( VariableBase )

private

◆ clickType()

ClickType::Type VariableBase::clickType	(	float	x,
		float	y
	)		const

overridevirtual

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

Reimplemented from minsky::Item.

Definition at line 97 of file variable.cc.

References minsky::Item::clickType(), minsky::VariableType::constant, minsky::flipped(), minsky::RenderVariable::handlePos(), minsky::RenderVariable::height(), minsky::Item::iHeight(), minsky::ClickType::inItem, minsky::Item::rotation(), type(), minsky::Rotate::x(), minsky::Item::x(), minsky::Rotate::y(), minsky::Item::y(), and zoomFactor().

 {
   const Rotate r(rotation()+(flipped(rotation())? 180: 0),0,0); // rotate into variable's frame of reference
   const RenderVariable rv(*this);
   const double z=zoomFactor();
   try
     {
       const double hpx=z*rv.handlePos();
       double hpy=-z*rv.height();
       if (rv.height()<0.5*iHeight()) hpy=-z*0.5*iHeight(); 
       const double dx=xx-x(), dy=yy-y();         
       if (type()!=constant && hypot(dx - r.x(hpx,hpy), dy-r.y(hpx,hpy)) < 5)
         return ClickType::inItem;
     }
   catch (...) {}
   return Item::clickType(xx,yy);
 }

Here is the call graph for this function:

◆ clone()

virtual VariableBase* minsky::VariableBase::clone ( ) const

overridepure virtual

Reimplemented from minsky::Item.

Implemented in minsky::VarConstant, minsky::Variable< T >, minsky::Variable< VariableType::constant >, and minsky::ItemT< Variable< T >, VariableBase >.

◆ create()

VariableBase * VariableBase::create ( VariableType::Type type )

static

Definition at line 116 of file variable.cc.

References minsky::VariableType::constant, minsky::VariableType::flow, minsky::VariableType::integral, minsky::VariableType::parameter, minsky::VariableType::stock, minsky::VariableType::tempFlow, type(), minsky::VariableType::typeName(), and minsky::VariableType::undefined.

Referenced by schema3::MinskyItemFactory::create(), and minsky::VariablePtr::retype().

 {
   switch (type)
     {
     case undefined: return new Variable<undefined>; break;
     case constant: return new VarConstant; break;
     case parameter: return new Variable<parameter>; break;
     case flow: return new Variable<flow>; break;
     case stock: return new Variable<stock>; break;
     case tempFlow: return new Variable<tempFlow>; break;
     case integral: return new Variable<integral>; break;
     default: 
       throw error("unknown variable type %s", typeName(type).c_str());
     }
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ defined()

bool minsky::VariableBase::defined ( ) const

inline

Returns: true if variable is defined (inputWired() || isStock() && controlled)

Definition at line 219 of file variable.h.

References controller, inputWired(), and isStock().

219 {return inputWired() || (isStock() && controller.lock());}

minsky::VariableBase::inputWired

bool inputWired() const

Definition: variable.cc:82

minsky::VariableBase::controller

classdesc::Exclude< std::weak_ptr< Item > > controller

reference to a controlling item - eg GodleyIcon, IntOp or a Group if an IOVar.

Definition: variable.h:129

minsky::VariableBase::isStock

bool isStock() const

Definition: variable.h:206

Here is the call graph for this function:

◆ definition()

std::string VariableBase::definition ( ) const

formula defining this variable

Definition at line 578 of file variable.cc.

References minsky::cminsky(), minsky::VariableType::constant, MathDAG::SystemOfEquations::getDefFromIntVar(), MathDAG::SystemOfEquations::getNodeFromVar(), minsky::VariableType::integral, minsky::VariableType::parameter, and type().

 {
   MathDAG::SystemOfEquations system(cminsky());   
   ostringstream o;
         
   auto varDAG=system.getNodeFromVar(*this);
     
   if (type()!=VariableType::parameter)
     {
       if (varDAG && varDAG->rhs && varDAG->type!=VariableType::constant && varDAG->type!=VariableType::integral)
         o << varDAG->rhs->latex();
       else return system.getDefFromIntVar(*this).str();
     }
           
   return o.str();         
 }

Here is the call graph for this function:

◆ destroyFrame()

void VariableBase::destroyFrame ( )

overridevirtual

clean up popup window structures on window close

Reimplemented from minsky::Item.

Definition at line 492 of file variable.cc.

References vValue().

 {
   if (auto vv=vValue())
     vv->csvDialog.destroyFrame();
 }

Here is the call graph for this function:

◆ detailedText() [1/2]

const std::string & VariableBase::detailedText ( ) const

overridevirtual

Reimplemented from minsky::NoteBase.

Definition at line 353 of file variable.cc.

References emptyString, and vValue().

 {
   if (auto vv=vValue())
     return vv->detailedText;
   return emptyString  ;
 }

Here is the call graph for this function:

◆ detailedText() [2/2]

const std::string & VariableBase::detailedText ( const std::string & x )

overridevirtual

Reimplemented from minsky::NoteBase.

Definition at line 360 of file variable.cc.

References emptyString, vValue(), and minsky::Item::x().

 {
     if (auto vv=vValue())
     return vv->detailedText=x;
   return emptyString  ;
 }

Here is the call graph for this function:

◆ dimLabels()

vector< string > VariableBase::dimLabels ( ) const

labels along each axis

Definition at line 179 of file variable.cc.

References vValue().

 {
   if (auto v=vValue()) return v->hypercube().dimLabels();
   return {};
 }    

Here is the call graph for this function:

◆ dims()

vector< unsigned > VariableBase::dims ( ) const

variable's tensor shape

Definition at line 169 of file variable.cc.

References vValue().

 {
   try
     {
       if (auto v=vValue()) return v->hypercube().dims();
     }
   catch (...) {} // ignore any exceptions caused by evaluating RHS.
   return {};
 }

Here is the call graph for this function:

◆ draw()

void VariableBase::draw ( cairo_t * cairo ) const

overridevirtual

draws the icon onto the given cairo context

Returns: cairo path of icon outline

Reimplemented from minsky::Item.

Definition at line 704 of file variable.cc.

References minsky::VariableCaches::cachedExponent, minsky::VariableCaches::cachedMantissa, minsky::VariableCaches::cachedNameRender, minsky::VariableCaches::cachedTime, minsky::VariableCaches::cachedValue, minsky::cminsky(), minsky::VariableType::constant, MathDAG::cos(), minsky::Item::displayTooltip(), minsky::Item::drawPorts(), minsky::BottomRightResizerItem::drawResizeHandles(), minsky::Item::drawSelected(), engExp(), minsky::expMultiplier(), minsky::flipped(), minsky::Item::iHeight(), ioVar(), minsky::anonymous_namespace{userFunction.cc}::isinf(), minsky::anonymous_namespace{userFunction.cc}::isnan(), minsky::Item::iWidth(), lhs(), local(), M_PI, minsky::Item::m_ports, mantissa(), miniPlot, minsky::NoteBase::mouseFocus, minsky::Item::moveTo(), minsky::Item::onResizeHandles, minsky::VariableType::parameter, minsky::Item::rotation(), minsky::Item::rotationAsRadians(), minsky::NoteBase::selected, MathDAG::sin(), minsky::sliderHandleRadius, sliderVisible(), minsky::RungeKutta::t, tooltip(), type(), value(), vValue(), minsky::Rotate::x(), minsky::Item::x(), minsky::Rotate::y(), minsky::Item::y(), and zoomFactor().

Referenced by minsky::RenderVariable::draw(), minsky::PhillipsStock::draw(), and minsky::anonymous_namespace{godleyIcon.cc}::DrawVars::operator()().

 {       
   auto [angle,flipped]=rotationAsRadians();
   const float z=zoomFactor();
 
   // grab a thread local copy of the renderer caches, as MacOSX does
   // rendering on a different thread, and this avoids a race condition
   // when the cache is invalidated
   auto l_cachedNameRender=cachedNameRender;
   if (!l_cachedNameRender || cairo!=cachedNameRender->cairoContext())
     {
       l_cachedNameRender=cachedNameRender=std::make_shared<RenderVariable>(*this,cairo);
       l_cachedNameRender->setFontSize(12.0);
     }
     
   // if rotation is in 1st or 3rd quadrant, rotate as
   // normal, otherwise flip the text so it reads L->R
   const Rotate r(rotation() + (flipped? 180:0),0,0);
   l_cachedNameRender->angle=angle+(flipped? M_PI:0);
 
   // parameters of icon in userspace (unscaled) coordinates
   const double w=std::max(l_cachedNameRender->width(), 0.5f*iWidth()); 
   const double h=std::max(l_cachedNameRender->height(), 0.5f*iHeight());
   const double hoffs=l_cachedNameRender->top();
   
   unique_ptr<cairo::Path> clipPath;
   {
     const CairoSave cs(cairo);
     cairo_scale(cairo, z,z);
     cairo_move_to(cairo,r.x(-w+1,-h-hoffs+2), r.y(-w+1,-h-hoffs+2));
     {
       const CairoSave cs(cairo);
       if (local())
         cairo_set_source_rgb(cairo,0,0,1);
       l_cachedNameRender->show();
     }
 
     auto vv=vValue();
     if (miniPlot && vv && vv->size()==1)
       try
         {
           if (cachedTime!=cminsky().t)
             {
               cachedTime=cminsky().t;
               miniPlot->addPt(0,cachedTime,vv->value());
               miniPlot->setMinMax();
             }
           const CairoSave cs(cairo);
           cairo_translate(cairo,-w,-h);
           miniPlot->draw(cairo,2*w,2*h);
         }
       catch (...) {} // ignore errors in obtaining values
 
     // For feature 47
     try
       {
         if (type()!=constant && !ioVar() && vv && vv->size()==1 && vv->idxInRange())
           {
             auto l_cachedMantissa=cachedMantissa;
             auto l_cachedExponent=cachedExponent;
             if (!l_cachedMantissa || l_cachedMantissa->cairoContext()!=cairo)
               {
                 l_cachedMantissa=cachedMantissa=make_shared<Pango>(cairo);
                 l_cachedMantissa->setFontSize(6.0);
                 l_cachedExponent=cachedExponent=make_shared<Pango>(cairo);
                 l_cachedExponent->setFontSize(6.0);
                 cachedValue=nan("");
               }
           
             auto val=engExp();    
             if (value()!=cachedValue)
               {
                 cachedValue=value();
                 if (!isnan(value())) {
                   if (sliderVisible())
                     l_cachedMantissa->setMarkup
                       (mantissa(val,
                                 int(1+
                                     (vv->sliderStepRel?
                                      -log10(vv->maxSliderSteps()):
                                      log10(vv->value()/vv->maxSliderSteps())
                                      ))));
                   else
                     l_cachedMantissa->setMarkup(mantissa(val));
                 }
                 else if (isinf(value())) { // Display non-zero divide by zero as infinity. For ticket 1155
                   if (signbit(value())) l_cachedMantissa->setMarkup("-∞");
                   else l_cachedMantissa->setMarkup("∞");
                 }
                 else // Display all other NaN cases as ???. For ticket 1155
                   l_cachedMantissa->setMarkup("???");
                 l_cachedExponent->setMarkup(expMultiplier(val.engExp));
               }
             l_cachedMantissa->angle=angle+(flipped? M_PI:0);
             
             cairo_move_to(cairo,r.x(w-l_cachedMantissa->width()-2,-h-hoffs+2),
                           r.y(w-l_cachedMantissa->width()-2,-h-hoffs+2));
             l_cachedMantissa->show();
 
             if (val.engExp!=0 && !isnan(value())) // Avoid large exponential number in variable value display. For ticket 1155
               {
                 cairo_move_to(cairo,r.x(w-l_cachedExponent->width()-2,0),r.y(w-l_cachedExponent->width()-2,0));
                 l_cachedExponent->show();
               }
           }
       }
     catch (...) {} // ignore errors in obtaining values
 
     {
       const cairo::CairoSave cs(cairo);
       cairo_rotate(cairo, angle);
       // constants and parameters should be rendered in blue, all others in red
       switch (type())
         {
         case constant: case parameter:
           cairo_set_source_rgb(cairo,0,0,1);
           break;
         default:
           cairo_set_source_rgb(cairo,1,0,0);
           break;
         }
       cairo_move_to(cairo,-w,-h);
       if (lhs())
         cairo_line_to(cairo,-w+2,0);
       cairo_line_to(cairo,-w,h);
       cairo_line_to(cairo,w,h);
       cairo_line_to(cairo,w+2,0);
       cairo_line_to(cairo,w,-h);
       cairo_close_path(cairo);
       clipPath.reset(new cairo::Path(cairo));
       cairo_stroke(cairo);
       if (sliderVisible())
         {
           // draw slider
           const CairoSave cs(cairo);
           cairo_set_source_rgb(cairo,0,0,0);
           try
             {
               cairo_arc(cairo,(flipped?-1.0:1.0)*l_cachedNameRender->handlePos(), (flipped? h: -h), sliderHandleRadius, 0, 2*M_PI);
             }
           catch (const error&) {} // handlePos() may throw.
           cairo_fill(cairo);
         }
     }// undo rotation
 
     const double x0=z*w, y0=0, x1=-z*w+2, y1=0;
     const double sa=sin(angle), ca=cos(angle);
     if (!m_ports.empty())
       m_ports[0]->moveTo(x()+(x0*ca-y0*sa), 
                          y()+(y0*ca+x0*sa));
     if (m_ports.size()>1)
       m_ports[1]->moveTo(x()+(x1*ca-y1*sa), 
                          y()+(y1*ca+x1*sa));
   }
     
   auto g=group.lock();
   if (mouseFocus || (ioVar() && g && g->mouseFocus))
     {
       const cairo::CairoSave cs(cairo);
       drawPorts(cairo);
       displayTooltip(cairo,tooltip());
       if (onResizeHandles) drawResizeHandles(cairo);
     }  
 
   cairo_new_path(cairo);
   clipPath->appendToCurrent(cairo);
   // Rescale size of variable attached to intop. For ticket 94
   cairo_clip(cairo);
   if (selected) drawSelected(cairo);
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ enableSlider() [1/2]

bool VariableBase::enableSlider ( ) const

slider parameters

Definition at line 689 of file variable.cc.

References vValue().

Referenced by schema3::Item::Item(), and sliderVisible().

 {
   if (auto vv=vValue())
     return vv->enableSlider;
   return false;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ enableSlider() [2/2]

bool VariableBase::enableSlider ( bool x )

slider parameters

Definition at line 696 of file variable.cc.

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

 {
   if (auto vv=vValue())
     return vv->enableSlider=x;
   return false;
 }

Here is the call graph for this function:

◆ engExp()

EngNotation minsky::VariableBase::engExp ( ) const

inline

return formatted mantissa and exponent in engineering format

Definition at line 227 of file variable.h.

References minsky::engExp(), and value().

Referenced by draw(), and minsky::RenderVariable::RenderVariable().

228 {return minsky::engExp(value());}

minsky::engExp

EngNotation engExp(double value)

return formatted mantissa and exponent in engineering format

Definition: variableValue.cc:383

minsky::VariableBase::value

virtual double value() const override

< set the initial value for this variable

Definition: variable.cc:332

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ensureValueExists()

void VariableBase::ensureValueExists	(	VariableValue *	vv,
		const std::string &	name
	)		const

ensure an associated variableValue exists

Definition at line 262 of file variable.cc.

References minsky::isValueId(), m_name, minsky::minsky(), minsky::scope(), type(), valueId(), and minsky::Minsky::variableValues.

Referenced by init(), MathDAG::SystemOfEquations::makeDAG(), name(), minsky::VarConstant::name(), and minsky::VarConstant::VarConstant().

 {       
   string valueId=this->valueId();
   // disallow blank names
   if (valueId.length()>1 && valueId.substr(valueId.length()-2)!=":_" && 
       minsky().variableValues.count(valueId)==0)
     {
       assert(isValueId(valueId));
       // Ensure value of variable is preserved after rename.          
       if (vv==nullptr)
         minsky().variableValues.emplace(valueId,VariableValuePtr(type(), m_name)).
           first->second->m_scope=minsky::scope(group.lock(),m_name);
       // Ensure variable names are updated correctly everywhere they appear. 
       else
         {
           auto iter=minsky().variableValues.emplace(valueId,VariableValuePtr(type(),*vv)).first->second;
           iter->name=m_name;
           iter->m_scope=minsky::scope(group.lock(),m_name);
         }
           
     }
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exportAsCSV()

void VariableBase::exportAsCSV	(	const std::string &	filename,
		bool	tabular
	)		const

export this variable as a CSV file

Parameters

tabular - if true, the longest dimension is split across columns as a horizontal dimension

Definition at line 472 of file variable.cc.

References minsky::minsky(), name(), value(), valueId(), and minsky::Minsky::variableValues.

 {
   auto value=minsky().variableValues.find(valueId());
   if (value!=minsky().variableValues.end())
     value->second->exportAsCSV(filename, name(), tabular);
 }

Here is the call graph for this function:

◆ getDimLabelsPicked()

std::pair<std::string,std::string> minsky::VariableBase::getDimLabelsPicked ( ) const

inline

Definition at line 169 of file variable.h.

References m_dimLabelsPicked.

169 {return m_dimLabelsPicked;}

minsky::VariableBase::m_dimLabelsPicked

std::pair< std::string, std::string > m_dimLabelsPicked

Definition: variable.h:103

◆ importFromCSV()

void VariableBase::importFromCSV	(	const std::vector< std::string > &	filenames,
		const DataSpecSchema &	spec
	)		const

import CSV files, using spec

Definition at line 479 of file variable.cc.

References minsky::loadValueFromCSVFile(), minsky::minsky(), minsky::Minsky::populateMissingDimensionsFromVariable(), minsky::Item::throw_error(), and vValue().

 {
   if (auto v=vValue()) {
     v->csvDialog.spec=spec;
     if (!filenames.empty())
       v->csvDialog.url=filenames[0];
     loadValueFromCSVFile(*v, filenames, v->csvDialog.spec);
     minsky().populateMissingDimensionsFromVariable(*v);
     if (!v->hypercube().dimsAreDistinct())
       throw_error("Axes of imported data should all have distinct names");
   }
 }

Here is the call graph for this function:

◆ init() [1/2]

string VariableBase::init ( ) const

the initial value of this variable

Definition at line 285 of file variable.cc.

References controller, minsky::VariableType::integral, minsky::Item::m_ports, minsky::minsky(), type(), value(), valueId(), minsky::Minsky::variableValues, and vValue().

Referenced by minsky::VarConstant::name(), units(), and minsky::VarConstant::value().

 {
   auto value=minsky().variableValues.find(valueId());
   if (value!=minsky().variableValues.end()) {           
     // set initial value of int var to init value of input to second port. for ticket 1137
     if (type()==integral)
       {
         // find attached integral
         auto i=dynamic_cast<IntOp*>(controller.lock().get());
         if (!i && !m_ports[1]->wires().empty())
           i=dynamic_cast<IntOp*>(&(m_ports[1]->wires()[0]->from()->item()));
         if (i && i->portsSize()>2 && !i->ports(2).lock()->wires().empty())
           if (auto lhsVar=i->ports(2).lock()->wires()[0]->from()->item().variableCast())
             if (auto vv=vValue())
               if (auto lhsVv=lhsVar->vValue())
                 // Since integral takes initial value from second port, the intVar should have the same intial value.
                 if (vv->init()!=lhsVv->init()) vv->init(lhsVv->init());
       }
     return value->second->init();
   }
   return "0";
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ init() [2/2]

string VariableBase::init ( const std::string & x )

< return initial value for this variable

Definition at line 308 of file variable.cc.

References minsky::VariableCaches::cachedNameRender, minsky::cminsky(), minsky::VariableType::constant, ensureValueExists(), minsky::VariableType::flow, minsky::VariableValue::init(), minsky::isValueId(), minsky::minsky(), minsky::VariableType::parameter, minsky::VariableValues::resetValue(), type(), minsky::Item::updateBoundingBox(), valueId(), minsky::Minsky::variableValues, and minsky::Item::x().

 {
   ensureValueExists(nullptr,""); 
   if (isValueId(valueId()))
     {
       VariableValue& val=*minsky().variableValues[valueId()];
       val.init(x);     
       // for constant types, we may as well set the current value. See ticket #433. Also ignore errors (for now), as they will reappear at reset time.
       try
         {
           if (type()==constant || type()==parameter ||
               (type()==flow && !cminsky().definingVar(valueId())))
             {
               minsky().variableValues.resetValue(val);
               cachedNameRender.reset(); // for constants
             }
         }
       catch (...)
         {}
       updateBoundingBox();
     }
   return x;
 }

Here is the call graph for this function:

◆ inputWired()

bool VariableBase::inputWired ( ) const

Definition at line 82 of file variable.cc.

References minsky::Item::ports().

Referenced by defined(), and sliderVisible().

 {
   if (auto p=ports(1).lock())
     return !p->wires().empty();
   return false;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ insertControlled()

void VariableBase::insertControlled ( Selection & selection )

overrideprivate

Definition at line 498 of file variable.cc.

References controller, and minsky::Selection::ensureItemInserted().

 {
   selection.ensureItemInserted(controller.lock());
 }

Here is the call graph for this function:

◆ ioVar()

bool VariableBase::ioVar ( ) const

overridevirtual

indicates this is a group I/O variable

Reimplemented from minsky::Item.

Definition at line 258 of file variable.cc.

References controller.

Referenced by draw(), minsky::RenderVariable::RenderVariable(), and zoomFactor().

259 {return dynamic_cast<Group*>(controller.lock().get());}

minsky::VariableBase::controller

classdesc::Exclude< std::weak_ptr< Item > > controller

reference to a controlling item - eg GodleyIcon, IntOp or a Group if an IOVar.

Definition: variable.h:129

minsky::Group

Definition: group.h:220

Here is the caller graph for this function:

◆ isStock()

bool minsky::VariableBase::isStock ( ) const

inline

Definition at line 206 of file variable.h.

References minsky::VariableType::integral, minsky::VariableType::stock, and type().

Referenced by defined(), and units().

206 {return type()==stock || type()==integral;}

minsky::VariableType::stock

Definition: variableType.h:28

minsky::VariableBase::type

virtual Type type() const =0

minsky::VariableType::integral

Definition: variableType.h:28

Here is the call graph for this function:

Here is the caller graph for this function:

◆ lhs()

bool minsky::VariableBase::lhs ( ) const

inline

variable is on left hand side of flow calculation

Definition at line 202 of file variable.h.

References minsky::VariableType::flow, minsky::VariableType::tempFlow, and type().

Referenced by draw().

202 {return type()==flow || type()==tempFlow;}

minsky::VariableBase::type

virtual Type type() const =0

minsky::VariableType::tempFlow

Definition: variableType.h:28

minsky::VariableType::flow

Definition: variableType.h:28

Here is the call graph for this function:

Here is the caller graph for this function:

◆ local()

bool VariableBase::local ( ) const

Returns: true if variable is local to its group

Definition at line 196 of file variable.cc.

References minsky::Minsky::canvas, minsky::cminsky(), m_name, and minsky::Canvas::model.

Referenced by draw().

 {
   return m_name[0]!=':' && group.lock()!=cminsky().canvas.model;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mantissa()

std::string minsky::VariableBase::mantissa	(	const EngNotation &	e,
		int	digits = `3`
	)		const

inline

Definition at line 229 of file variable.h.

References minsky::mantissa(), and value().

Referenced by draw(), and minsky::RenderVariable::RenderVariable().

230 {return minsky::mantissa(value(),e, digits);}

minsky::VariableBase::value

virtual double value() const override

< set the initial value for this variable

Definition: variable.cc:332

minsky::mantissa

std::string mantissa(double value, const EngNotation &, int digits=3)

Definition: variableValue.cc:394

Here is the call graph for this function:

Here is the caller graph for this function:

◆ miniPlotEnabled() [1/2]

bool minsky::VariableBase::miniPlotEnabled ( ) const

inline

Definition at line 242 of file variable.h.

References miniPlot.

Referenced by resetMiniPlot().

242 {return bool(miniPlot);}

minsky::VariableBase::miniPlot

classdesc::Exclude< std::shared_ptr< ecolab::Plot > > miniPlot

miniature plot feature

Definition: variable.h:110

Here is the caller graph for this function:

◆ miniPlotEnabled() [2/2]

bool VariableBase::miniPlotEnabled ( bool enabled )

Definition at line 595 of file variable.cc.

References miniPlot.

 {
   if (enabled)
     {
       miniPlot=make_shared<ecolab::Plot>();
       miniPlot->plotType=ecolab::Plot::PlotType::bar;
     }
   else
     miniPlot=nullptr;
   return enabled;
 }

◆ name() [1/2]

string VariableBase::name ( ) const

virtual

variable displayed name

Reimplemented in minsky::VarConstant.

Definition at line 201 of file variable.cc.

References m_name.

Referenced by exportAsCSV(), MathDAG::SystemOfEquations::makeDAG(), name(), minsky::GroupItems::renameVar(), minsky::RenderVariable::RenderVariable(), toggleLocal(), units(), and minsky::Variable< VariableType::constant >::Variable().

 {
   if (m_name==":_") return "";
   // hide any leading ':' in upper level
   if (m_name[0]==':')
     {
         return m_name.substr(1);
     }
   return utf_to_utf<char>(m_name);
 }

Here is the caller graph for this function:

◆ name() [2/2]

string VariableBase::name ( const std::string & nm )

virtual

variable displayed name

Reimplemented in minsky::VarConstant.

Definition at line 233 of file variable.cc.

References minsky::Item::bb, minsky::VariableCaches::cachedNameRender, minsky::canonicalName(), controller, ensureValueExists(), m_canonicalName, m_name, name(), anonymous_namespace{variable.cc}::quoteLaTeX(), anonymous_namespace{variable.cc}::specialLatex, minsky::BoundingBox::update(), valueId(), and vValue().

 {
   // cowardly refuse to set a blank name
   if (name.empty() || name==":") return name;
 
   // check if we need to quote certain characters that have meaning in LaTeX 
   for (auto p=name.find_first_of(specialLatex); p!=string::npos;
        p=name.find_first_of(specialLatex,p+1))
     if (p==0||name[p-1]!='\\')
       return this->name(quoteLaTeX(name));
   
   // Ensure value of variable is preserved after rename. For ticket 1106.       
   auto tmpVV=vValue();
   m_name=name;
   m_canonicalName=minsky::canonicalName(name);
   ensureValueExists(tmpVV.get(),name);
   assert(vValue()->valueId()==valueId());
   cachedNameRender.reset();
   bb.update(*this); // adjust bounding box for new name - see ticket #704
   if (auto controllingItem=controller.lock())
     // integrals in particular may have had their size changed with intVar changing name
     controllingItem->updateBoundingBox();
   return this->name();
 }

Here is the call graph for this function:

◆ numPorts()

virtual std::size_t minsky::VariableBase::numPorts ( ) const

pure virtual

Referenced by addPorts().

Here is the caller graph for this function:

◆ onKeyPress()

bool VariableBase::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 561 of file variable.cc.

References minsky::minsky(), minsky::Minsky::requestReset(), and vValue().

 {
   switch (keySym)
     {
     case 0xff52: case 0xff53: //Right, Up
       if (auto vv=vValue()) vv->incrSlider(1);
       if (!minsky().running) minsky().requestReset();
       return true;
     case 0xff51: case 0xff54: //Left, Down
       if (auto vv=vValue()) vv->incrSlider(-1);
       if (!minsky().running) minsky().requestReset();
       return true;
     default:
       return false;
     }
 }

Here is the call graph for this function:

◆ onMouseMotion()

bool VariableBase::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 613 of file variable.cc.

References MathDAG::cos(), minsky::RungeKutta::evalEquations(), minsky::Item::iWidth(), M_PI, minsky::minsky(), minsky::Minsky::pushHistory(), minsky::Minsky::requestReset(), minsky::Item::rotation(), vValue(), minsky::RenderVariable::width(), minsky::Item::x(), and zoomFactor().

 {
   if (auto vv=vValue())
     {
       const RenderVariable rv(*this);
       const double rw=fabs(zoomFactor()*(rv.width()<iWidth()? 0.5*iWidth() : rv.width())*cos(rotation()*M_PI/180));
       const double sliderPos=(x-this->x())* (vv->sliderMax-vv->sliderMin)/rw+0.5*(vv->sliderMin+vv->sliderMax);
       const double sliderHatch=sliderPos-fmod(sliderPos,vv->sliderStep);   // matches slider's hatch marks to sliderStep value. for ticket 1258
       vv->sliderSet(sliderHatch);
     }
   // push History to prevent an unnecessary reset when
   // adjusting the slider whilst paused. See ticket #812
   minsky().pushHistory();
   if (minsky().reset_flag())
     minsky().requestReset();
   minsky().evalEquations();
   return true;
 }

Here is the call graph for this function:

◆ rawName()

const std::string& minsky::VariableBase::rawName ( ) const

inline

accessor for the name member (may differ from name() with top level variables)

Definition at line 150 of file variable.h.

References m_name.

Referenced by schema3::Item::Item(), and minsky::GroupItems::renameVar().

150 {return m_name;}

minsky::VariableBase::m_name

std::string m_name

Definition: variable.h:101

Here is the caller graph for this function:

◆ resetMiniPlot()

void VariableBase::resetMiniPlot ( )

Definition at line 607 of file variable.cc.

References miniPlot, and miniPlotEnabled().

 {
   if (miniPlotEnabled())
     miniPlot->clear();
 }

Here is the call graph for this function:

◆ resize()

void VariableBase::resize ( const LassoBox & b )

overridevirtual

resize this item on the canvas

Reimplemented from minsky::Item.

Definition at line 875 of file variable.cc.

References minsky::Item::iHeight(), minsky::Item::iWidth(), minsky::Item::moveTo(), minsky::LassoBox::x0, minsky::LassoBox::x1, minsky::LassoBox::y0, minsky::LassoBox::y1, and zoomFactor().

 {
   const float invZ=1/zoomFactor();
   moveTo(0.5*(b.x0+b.x1), 0.5*(b.y0+b.y1));  
   iWidth(abs(b.x1-b.x0)*invZ);
   iHeight(abs(b.y1-b.y0)*invZ);   
 }

Here is the call graph for this function:

◆ retype()

void VariableBase::retype ( VariableType::Type type )

attempt to replace this variable with variable of type.

Exceptions

if	not possible

Definition at line 132 of file variable.cc.

References minsky::Minsky::convertVarType(), minsky::minsky(), minsky::VariablePtr::retype(), type(), valueId(), and vValue().

 {
   if (type==this->type()) return; // nothing to do
   if (auto vv=vValue())
     if (type==vv->type())
       if (auto g=group.lock())
         for (auto& i: g->items)
           if (i.get()==this)
             {
               VariablePtr vp{i};
               vp.retype(type);
               i=vp;
               return;
             }
   minsky().convertVarType(valueId(), type);
 }

Here is the call graph for this function:

◆ setDimLabelsPicked()

std::pair<std::string,std::string> minsky::VariableBase::setDimLabelsPicked	(	const std::string &	dimLabel1,
		const std::string &	dimLabel2
	)

inline

Definition at line 170 of file variable.h.

References m_dimLabelsPicked.

                                                                                                             {
       m_dimLabelsPicked=std::make_pair(dimLabel1,dimLabel2);
       return m_dimLabelsPicked;
     }         

◆ setUnits()

void VariableBase::setUnits ( const std::string & x ) const

Definition at line 464 of file variable.cc.

References minsky::isValueId(), minsky::minsky(), valueId(), minsky::Minsky::variableValues, and minsky::Item::x().

 {
   if (isValueId(valueId()))
     minsky().variableValues[valueId()]->units=Units(x);
 }

Here is the call graph for this function:

◆ sliderMax() [1/2]

double VariableBase::sliderMax ( ) const

slider parameters

Definition at line 647 of file variable.cc.

References vValue().

Referenced by schema3::Item::Item().

 {
   if (auto vv=vValue())
     return vv->sliderMax;
   return 0;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sliderMax() [2/2]

double VariableBase::sliderMax ( double x ) const

slider parameters

Definition at line 654 of file variable.cc.

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

 {
   if (auto vv=vValue())
     return vv->sliderMax=x;
   return 0;
 }

Here is the call graph for this function:

◆ sliderMin() [1/2]

double VariableBase::sliderMin ( ) const

slider parameters

Definition at line 632 of file variable.cc.

References vValue().

Referenced by schema3::Item::Item().

 {
   if (auto vv=vValue())
     return vv->sliderMin;
   return 0;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sliderMin() [2/2]

double VariableBase::sliderMin ( double x ) const

slider parameters

Definition at line 640 of file variable.cc.

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

 {
   if (auto vv=vValue())
     return vv->sliderMin=x;
   return 0;
 }

Here is the call graph for this function:

◆ sliderStep() [1/2]

double VariableBase::sliderStep ( ) const

slider parameters

Definition at line 661 of file variable.cc.

References vValue().

Referenced by schema3::Item::Item().

 {
   if (auto vv=vValue())
     return vv->sliderStep;
   return 0;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sliderStep() [2/2]

double VariableBase::sliderStep ( double x ) const

slider parameters

Definition at line 668 of file variable.cc.

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

 {
   if (auto vv=vValue())
     return vv->sliderStep=x;
   return 0;
 }

Here is the call graph for this function:

◆ sliderStepRel() [1/2]

bool VariableBase::sliderStepRel ( ) const

slider parameters

Definition at line 675 of file variable.cc.

References vValue().

Referenced by schema3::Item::Item().

 {
   if (auto vv=vValue())
     return vv->sliderStepRel;
   return false;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sliderStepRel() [2/2]

bool VariableBase::sliderStepRel ( bool x ) const

slider parameters

Definition at line 682 of file variable.cc.

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

  {
   if (auto vv=vValue())
     return vv->sliderStepRel=x;
   return false;
 }

Here is the call graph for this function:

◆ sliderVisible()

bool VariableBase::sliderVisible ( ) const

returns true if slider is to be drawn

Definition at line 544 of file variable.cc.

References minsky::cminsky(), minsky::Minsky::definingVar(), enableSlider(), minsky::VariableType::flow, inputWired(), minsky::VariableType::parameter, type(), valueId(), and vValue().

Referenced by draw().

 {
   auto vv=vValue();
   return enableSlider() &&
     ((!vv && type()==parameter) ||
      (vv && vv->size()==1 &&
       (type()==parameter ||
        // !inputWired() short circuits the more expensive definingVar operation.
        (type()==flow && !inputWired() && !cminsky().definingVar(valueId())))));
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ temp()

bool minsky::VariableBase::temp ( ) const

inline

variable is temporary

Definition at line 204 of file variable.h.

References minsky::VariableType::tempFlow, type(), and minsky::VariableType::undefined.

204 {return type()==tempFlow || type()==undefined;}

minsky::VariableType::undefined

Definition: variableType.h:28

minsky::VariableBase::type

virtual Type type() const =0

minsky::VariableType::tempFlow

Definition: variableType.h:28

Here is the call graph for this function:

◆ toggleLocal()

void minsky::VariableBase::toggleLocal ( )

inline

toggle local status

Definition at line 140 of file variable.h.

References m_name, and name().

140 {name(m_name[0]==':'? m_name.substr(1): ':'+m_name);}

minsky::VariableBase::name

virtual std::string name() const

variable displayed name

Definition: variable.cc:201

minsky::VariableBase::m_name

std::string m_name

Definition: variable.h:101

Here is the call graph for this function:

◆ tooltip() [1/2]

const std::string & VariableBase::tooltip ( ) const

overridevirtual

Reimplemented from minsky::NoteBase.

Definition at line 367 of file variable.cc.

References emptyString, and vValue().

Referenced by draw().

 {
   if (auto vv=vValue())
     return vv->tooltip;
   return emptyString  ;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ tooltip() [2/2]

const std::string & VariableBase::tooltip ( const std::string & x )

overridevirtual

Reimplemented from minsky::NoteBase.

Definition at line 374 of file variable.cc.

References emptyString, vValue(), and minsky::Item::x().

 {
     if (auto vv=vValue())
     return vv->tooltip=x;
   return emptyString  ;
 }

Here is the call graph for this function:

◆ type()

virtual Type minsky::VariableBase::type ( ) const

pure virtual

Implemented in minsky::Variable< T >, and minsky::Variable< VariableType::constant >.

Referenced by clickType(), create(), definition(), draw(), ensureValueExists(), init(), isStock(), lhs(), MathDAG::SystemOfEquations::makeDAG(), minsky::RenderVariable::RenderVariable(), retype(), sliderVisible(), temp(), and value().

Here is the caller graph for this function:

◆ units() [1/2]

Units VariableBase::units ( bool check ) const

overridevirtual

sets/gets the units associated with this type

Reimplemented from minsky::Item.

Definition at line 384 of file variable.cc.

References minsky::cminsky(), controller, init(), isStock(), minsky::GroupItems::items, minsky::Item::m_ports, minsky::minsky(), minsky::Minsky::model, minsky::FlowCoef::name, name(), minsky::VariableValues::resetUnitsCache(), stockVarsPassed, minsky::Units::str(), minsky::Item::throw_error(), units(), unitsCtr, minsky::valueId(), valueId(), minsky::Minsky::variableValues, and varsPassed.

 {
   if (varsPassed==0) minsky().variableValues.resetUnitsCache(); 
   // we allow possible traversing twice, to allow
   // stock variable to break the cycle
   if (unitsCtr-stockVarsPassed>=1)
     {
       if (check)
         throw_error("Cycle detected on wiring network");
       else
         return {};
     }
 
   auto it=minsky().variableValues.find(valueId());
   if (it!=minsky().variableValues.end())
     {
       auto& vv=it->second;
       if (vv->unitsCached) return vv->units;
 
       
       const IncrDecrCounter ucIdc(unitsCtr);
       const IncrDecrCounter vpIdc(varsPassed);
       // use a unique ptr here to only increment counter inside a stockVar
       unique_ptr<IncrDecrCounter> svp;
 
       if (isStock()) // we use user defined units
         {
           if (unitsCtr==1)
             {
               svp.reset(new IncrDecrCounter(stockVarsPassed));
               // check that input units match output units
               Units units;
               if (auto i=dynamic_cast<IntOp*>(controller.lock().get()))
                 units=i->units(check);
               else if (auto g=dynamic_cast<GodleyIcon*>(controller.lock().get()))
                 units=g->stockVarUnits(name(),check);
               else // I/O variable
                 units=vv->units;
               if (check && units.str()!=vv->units.str())
                 {
                   if (auto i=controller.lock())
                     i->throw_error("Inconsistent units "+units.str()+"≠"+vv->units.str());
                 }
 
               if (check && controller.lock())
                 {
                   const FlowCoef fc(init());
                   if (!fc.name.empty())
                     {
                       // extract the valueid corresponding to the initialisation variable
                       auto vid=minsky::valueId(vv->m_scope.lock(), fc.name);
                       // find the first variable matching vid, and check that the units match
                       if (auto initVar=cminsky().model->findAny
                           (&GroupItems::items, [&vid](const ItemPtr& i){
                                                  if (auto v=i->variableCast())
                                                    return v->valueId()==vid;
                                                  return false;}))
                         if (units!=initVar->units(check))
                           throw_error("Inconsistent units in initial conditions");
                     }
                 }
             }
         }
       else
         // updates units in the process
         if (m_ports.size()>1 && !m_ports[1]->wires().empty())
           {
             assert(m_ports[1]->wires()[0]->from());
             vv->units=m_ports[1]->wires()[0]->from()->item().units(check);
           }
         else if (auto v=cminsky().definingVar(valueId()))
           vv->units=v->units(check);
 
       vv->units.normalise();
       vv->unitsCached=true;
       return vv->units;
     }
   return Units();
 }

Here is the call graph for this function:

◆ units() [2/2]

Units minsky::VariableBase::units ( ) const

inline

Definition at line 195 of file variable.h.

References units().

Referenced by minsky::PhillipsStock::draw(), units(), and unitsStr().

195 {return units(false);}

minsky::VariableBase::units

Units units() const

Definition: variable.h:195

Here is the call graph for this function:

Here is the caller graph for this function:

◆ unitsStr()

std::string minsky::VariableBase::unitsStr ( ) const

inline

Definition at line 197 of file variable.h.

References minsky::Units::str(), and units().

197 {return units().str();}

minsky::VariableBase::units

Units units() const

Definition: variable.h:195

minsky::Units::str

std::string str() const

Definition: variableType.cc:33

Here is the call graph for this function:

◆ value() [1/2]

double VariableBase::value ( const double & x )

virtual

< set the initial value for this variable

current value associated with this variable

Reimplemented in minsky::VarConstant.

Definition at line 340 of file variable.cc.

References minsky::VariableCaches::cachedNameRender, minsky::VariableType::constant, minsky::isValueId(), m_name, minsky::minsky(), type(), valueId(), minsky::Minsky::variableValues, and minsky::Item::x().

 {
   if (!m_name.empty() && isValueId(valueId()))
     {
       (*minsky().variableValues[valueId()])[0]=x;
       if (type()==constant)
         cachedNameRender.reset();
     }
   return x;
 }

Here is the call graph for this function:

◆ value() [2/2]

double VariableBase::value ( ) const

overridevirtual

< set the initial value for this variable

current value associated with this variable

Reimplemented from minsky::Item.

Definition at line 332 of file variable.cc.

References minsky::cminsky(), valueId(), and minsky::Minsky::variableValues.

Referenced by minsky::PhillipsStock::draw(), draw(), engExp(), exportAsCSV(), init(), and mantissa().

 {
   auto& vvs=minsky::cminsky().variableValues;
   auto v=vvs.find(valueId());
   if (v==vvs.end() || !v->second) return 0;
   return v->second->value();
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ valueId()

string VariableBase::valueId ( ) const

virtual

string used to link to the VariableValue associated with this

Reimplemented in minsky::VarConstant.

Definition at line 186 of file variable.cc.

References m_name, and minsky::valueId().

Referenced by ensureValueExists(), exportAsCSV(), MathDAG::SystemOfEquations::getDefFromIntVar(), init(), MathDAG::SubexpressionCache::key(), MathDAG::SystemOfEquations::makeDAG(), name(), schema3::PhillipsDiagram::populatePhillipsDiagram(), retype(), setUnits(), sliderVisible(), units(), value(), and vValue().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ valueIdInCurrentScope()

std::string VariableBase::valueIdInCurrentScope ( const std::string & nm ) const

returns valueId for nm. If nm is not qualified, this variable's scope is used

Definition at line 191 of file variable.cc.

References minsky::valueId().

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

Here is the call graph for this function:

◆ variableCast() [1/2]

const VariableBase* minsky::VariableBase::variableCast ( ) const

inlineoverride

Definition at line 132 of file variable.h.

132 {return this;}

◆ variableCast() [2/2]

VariableBase* minsky::VariableBase::variableCast ( )

inlineoverride

Definition at line 133 of file variable.h.

133 {return this;}

◆ visible()

bool VariableBase::visible ( ) const

overridevirtual

whether this item is visible on the canvas.

Reimplemented from minsky::Item.

Definition at line 535 of file variable.cc.

References controller, and minsky::Item::visible().

 {
   auto g=group.lock();
   //toplevel i/o items always visible
   if ((!g || !g->group.lock()) && g==controller.lock()) return true;
   if (controller.lock()) return false;
   return Item::visible();
 }

Here is the call graph for this function:

◆ vValue()

shared_ptr< VariableValue > VariableBase::vValue ( ) const

variableValue associated with this. nullptr if not associated with a variableValue

Definition at line 161 of file variable.cc.

References minsky::cminsky(), minsky::minsky(), valueId(), and minsky::Minsky::variableValues.

Referenced by adjustSliderBounds(), destroyFrame(), detailedText(), dimLabels(), dims(), draw(), enableSlider(), minsky::RenderVariable::handlePos(), importFromCSV(), init(), schema3::Item::Item(), MathDAG::SystemOfEquations::makeDAG(), name(), onKeyPress(), onMouseMotion(), schema3::Item::packTensorInit(), retype(), sliderMax(), sliderMin(), sliderStep(), sliderStepRel(), sliderVisible(), and tooltip().

 {
   auto vv=cminsky().variableValues.find(valueId());
   if (vv!=minsky().variableValues.end())
     return vv->second;
   return {};
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ zoomFactor()

float VariableBase::zoomFactor ( ) const

overridevirtual

Reimplemented from minsky::Item.

Definition at line 150 of file variable.cc.

References controller, ioVar(), and minsky::Item::zoomFactor().

Referenced by clickType(), minsky::PhillipsStock::draw(), draw(), onMouseMotion(), and resize().

 {
   if (ioVar())
     if (auto g=group.lock())
       return g->edgeScale();
   // scale by GodleyIcon::scaleFactor if part of an Godley icon
   if (auto g=dynamic_cast<GodleyIcon*>(controller.lock().get()))
     return g->scaleFactor() * Item::zoomFactor();
   return Item::zoomFactor();
 }

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ minsky::SchemaHelper

friend struct minsky::SchemaHelper

friend

Definition at line 97 of file variable.h.

Member Data Documentation

◆ controller

classdesc::Exclude<std::weak_ptr<Item> > minsky::VariableBase::controller

reference to a controlling item - eg GodleyIcon, IntOp or a Group if an IOVar.

Definition at line 129 of file variable.h.

Referenced by defined(), init(), insertControlled(), ioVar(), name(), minsky::Variable< VariableType::constant >::operator=(), minsky::GroupItems::removeItem(), units(), visible(), and zoomFactor().

◆ m_canonicalName

std::string minsky::VariableBase::m_canonicalName

private

latex processed and active stripped version of name

Definition at line 102 of file variable.h.

Referenced by canonicalName(), and name().

◆ m_dimLabelsPicked

std::pair<std::string,std::string> minsky::VariableBase::m_dimLabelsPicked

private

Definition at line 103 of file variable.h.

Referenced by getDimLabelsPicked(), and setDimLabelsPicked().

◆ m_name

std::string minsky::VariableBase::m_name

private

Definition at line 101 of file variable.h.

Referenced by ensureValueExists(), local(), name(), rawName(), toggleLocal(), value(), and valueId().

◆ miniPlot

classdesc::Exclude<std::shared_ptr<ecolab::Plot> > minsky::VariableBase::miniPlot

private

miniature plot feature

Definition at line 110 of file variable.h.

Referenced by draw(), miniPlotEnabled(), and resetMiniPlot().

◆ stockVarsPassed

int VariableBase::stockVarsPassed =0

staticprivate

for detecting reentrancy in units()

Definition at line 105 of file variable.h.

Referenced by units().

◆ unitsCtr

int minsky::VariableBase::unitsCtr =0

mutableprivate

for detecting reentrancy in units()

Definition at line 104 of file variable.h.

Referenced by units().

◆ varsPassed

int VariableBase::varsPassed =0

static

for caching units calculation factory method

Definition at line 116 of file variable.h.

Referenced by units().

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

model/variable.h
model/variable.cc

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Type

Member Function Documentation

◆ accessibleVars()

◆ addPorts()

◆ adjustSliderBounds()

◆ canonicalName()

◆ CLASSDESC_ACCESS()

◆ clickType()

◆ clone()

◆ create()

◆ defined()

◆ definition()

◆ destroyFrame()

◆ detailedText() [1/2]

◆ detailedText() [2/2]

◆ dimLabels()

◆ dims()

◆ draw()

◆ enableSlider() [1/2]

◆ enableSlider() [2/2]

◆ engExp()

◆ ensureValueExists()

◆ exportAsCSV()

◆ getDimLabelsPicked()

◆ importFromCSV()

◆ init() [1/2]

◆ init() [2/2]

◆ inputWired()

◆ insertControlled()

◆ ioVar()

◆ isStock()

◆ lhs()

◆ local()

◆ mantissa()

◆ miniPlotEnabled() [1/2]

◆ miniPlotEnabled() [2/2]

◆ name() [1/2]

◆ name() [2/2]

◆ numPorts()

◆ onKeyPress()

◆ onMouseMotion()

◆ rawName()

◆ resetMiniPlot()

◆ resize()

◆ retype()

◆ setDimLabelsPicked()

◆ setUnits()

◆ sliderMax() [1/2]

◆ sliderMax() [2/2]

◆ sliderMin() [1/2]

◆ sliderMin() [2/2]

◆ sliderStep() [1/2]

◆ sliderStep() [2/2]

◆ sliderStepRel() [1/2]

◆ sliderStepRel() [2/2]

◆ sliderVisible()

◆ temp()

◆ toggleLocal()

◆ tooltip() [1/2]

◆ tooltip() [2/2]

◆ type()

◆ units() [1/2]

◆ units() [2/2]

◆ unitsStr()

◆ value() [1/2]

◆ value() [2/2]

◆ valueId()