#include <lock.h>

Inheritance diagram for minsky::Lock:

Collaboration diagram for minsky::Lock:

Public Member Functions
	Lock ()

	Lock (const Lock &x)

Lock &	operator= (const Lock &x)=default

void	addPorts ()

bool	locked () const

void	toggleLocked ()

void	draw (cairo_t *cairo) const override
	draw this item into a cairo context More...

Units	units (bool) const override
	compute the dimensional units More...

Ravel *	ravelInput () const
	Ravel this is connected to. nullptr if not connected to a Ravel. More...

void	applyLockedStateToRavel () const

Public Member Functions inherited from minsky::ItemT< Lock >
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	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	onMouseMotion (float x, float y)
	respond to mouse motion events with button pressed 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 bool	onKeyPress (int keySym, const std::string &utf8, int state)
	respond to key press events 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 void	resize (const LassoBox &b)
	resize this item on the canvas More...

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 ClickType::Type	clickType (float x, float y) const
	returns the clicktype given a mouse click at x, y. More...

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

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

virtual void	destroyFrame ()
	destroy any popup windows associated with 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
ravel::RavelState	lockedState

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	lockedIcon

static SVGRenderer	unlockedIcon

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 30 of file lock.h.

Constructor & Destructor Documentation

◆ Lock() [1/2]

minsky::Lock::Lock ( )

Definition at line 38 of file lock.cc.

   {
     tooltip("Double click to lock/unlock");
     iWidth(30);
     iHeight(30);
     addPorts();
   }

◆ Lock() [2/2]

minsky::Lock::Lock ( const Lock & x )

inline

Definition at line 34 of file lock.h.

References addPorts().

34 : ItemT<Lock>(x) {addPorts();}

minsky::Item::x

virtual float x() const

Definition: item.cc:107

minsky::Lock::addPorts

void addPorts()

Definition: lock.cc:46

Here is the call graph for this function:

Member Function Documentation

◆ addPorts()

void minsky::Lock::addPorts ( )

Definition at line 46 of file lock.cc.

Referenced by Lock().

   {
     m_ports.clear();
     m_ports.emplace_back(make_shared<Port>(*this));
     m_ports[0]->moveTo(x()+15,y());
     m_ports.emplace_back(make_shared<InputPort>(*this));
     m_ports[1]->moveTo(x()-15,y());
   }

Here is the caller graph for this function:

◆ applyLockedStateToRavel()

void minsky::Lock::applyLockedStateToRavel ( ) const

Definition at line 142 of file lock.cc.

   {
     if (auto ravel=ravelInput())
       ravel->applyState(lockedState);
   }

◆ draw()

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

overridevirtual

draw this item into a cairo context

Reimplemented from minsky::Item.

Definition at line 81 of file lock.cc.

References minsky::SVGRenderer::height(), minsky::SVGRenderer::render(), and minsky::SVGRenderer::width().

   {
     const float z=zoomFactor()*scaleFactor();
     const float w=iWidth()*z, h=iHeight()*z;
 
     {
       const ecolab::cairo::CairoSave cs(cairo);
       cairo_translate(cairo,-0.5*w,-0.5*h);
       SVGRenderer* icon=locked()? &lockedIcon: &unlockedIcon;
       cairo_scale(cairo, w/icon->width(), h/icon->height());
       icon->render(cairo);
     }
     
     if (mouseFocus)
       {                   
         drawPorts(cairo);
         displayTooltip(cairo,tooltip());
         if (onResizeHandles) drawResizeHandles(cairo);
       }        
 
     // add 8 pt margin to allow for ports
     cairo_rectangle(cairo,-0.5*w-8,-0.5*h-8,w+16,h+8);
     cairo_clip(cairo);
     if (selected) drawSelected(cairo);
   }

Here is the call graph for this function:

◆ locked()

bool minsky::Lock::locked ( ) const

inline

Definition at line 39 of file lock.h.

References lockedState.

Referenced by MathDAG::LockDAG::addEvalOps(), and MathDAG::SystemOfEquations::makeDAG().

39 {return !lockedState.empty();}

minsky::Lock::lockedState

ravel::RavelState lockedState

Definition: lock.h:37

Here is the caller graph for this function:

◆ operator=()

Lock& minsky::Lock::operator= ( const Lock & x )

default

◆ ravelInput()

Ravel * minsky::Lock::ravelInput ( ) const

Ravel this is connected to. nullptr if not connected to a Ravel.

Definition at line 55 of file lock.cc.

Referenced by MathDAG::SystemOfEquations::makeDAG().

   {
     if (auto inputPort=ports(1).lock())
       if (!inputPort->wires().empty())
         if (auto fromPort=inputPort->wires()[0]->from())
           return dynamic_cast<Ravel*>(&fromPort->item());
     return nullptr;
   }

Here is the caller graph for this function:

◆ toggleLocked()

void minsky::Lock::toggleLocked ( )

Definition at line 65 of file lock.cc.

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

   {
     if (locked())
       lockedState.clear();
     else
       if (auto* r=ravelInput())
         {
           // need to a full reset at this point, not delayed
           minsky::minsky().reset();
           lockedState=r->getState();
           tooltip(ravel::Ravel::description(lockedState));
         }
       else
         throw_error("Locks can only be applied to Ravels");
   }

Here is the call graph for this function:

◆ units()

Units minsky::Lock::units ( bool check ) const

overridevirtual

compute the dimensional units

Parameters

check - if true, then perform consistency checks

Exceptions

if	check=true and dimensions inconsistent

Reimplemented from minsky::Item.

Definition at line 107 of file lock.cc.

   {
     if (locked())
       {
         if (auto* r=ravelInput())
           if (auto p=r->ports(1).lock())
             {
               Units inputUnits=p->units(check);
               if (inputUnits.empty()) return inputUnits;
               size_t multiplier=1;
               // at this stage, gross up exponents by the handle size of each
               // reduced by product handles
               for (const auto& h: lockedState.handleStates)
                 if (h.collapsed && h.reductionOp==ravel::Op::prod)
                   {
                     // find which handle number this is
                     // TODO - is there a way of avoiding this second loop?
                     size_t i=0;
                     for (; i<r->maxRank(); ++i)
                       if (r->handleDescription(i)==h.description)
                         {
                           multiplier*=r->numSliceLabels(i);
                           break;
                         }
                   }
               if (multiplier>1)
                 for (auto& u: inputUnits)
                   u.second*=multiplier;
               return inputUnits;
             }
         return {};
       }
     return m_ports[1]->units(check);
   }

Member Data Documentation

◆ lockedIcon

SVGRenderer minsky::Lock::lockedIcon

static

Definition at line 42 of file lock.h.

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

◆ lockedState

ravel::RavelState minsky::Lock::lockedState

Definition at line 37 of file lock.h.

Referenced by MathDAG::LockDAG::addEvalOps(), and locked().

◆ unlockedIcon

SVGRenderer minsky::Lock::unlockedIcon

static

Definition at line 43 of file lock.h.

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

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

model/lock.h
model/lock.cc

Public Member Functions

Public Attributes

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Lock() [1/2]

◆ Lock() [2/2]

Member Function Documentation

◆ addPorts()

◆ applyLockedStateToRavel()

◆ draw()

◆ locked()

◆ operator=()

◆ ravelInput()

◆ toggleLocked()

◆ units()

Member Data Documentation

◆ lockedIcon

◆ lockedState

◆ unlockedIcon