#include <variable.h>

Inheritance diagram for minsky::Variable< T >:

Collaboration diagram for minsky::Variable< T >:

Public Types
typedef VariableBase::Type	Type

Public Types inherited from minsky::VariableBase
typedef VariableType::Type	Type

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

Public Member Functions
Type	type () const override

std::size_t	numPorts () const override

	Variable (const Variable &x)

Variable &	operator= (const Variable &x)

	Variable (Variable &&x)

Variable &	operator= (Variable &&x)

	Variable (const std::string &name="")

std::string	classType () const override

Variable *	clone () const override

template<>
size_t	numPorts () const

template<>
size_t	numPorts () const

template<>
size_t	numPorts () const

template<>
size_t	numPorts () const

template<>
size_t	numPorts () const

template<>
size_t	numPorts () const

template<>
size_t	numPorts () const

Public Member Functions inherited from minsky::ItemT< Variable< T >, VariableBase >
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::VariableBase
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...

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

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

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

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 &)

Additional Inherited Members
Static Public Member Functions inherited from minsky::VariableBase
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 inherited from minsky::VariableBase
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 inherited from minsky::VariableBase
static int	varsPassed =0
	for caching units calculation factory method More...

Protected Member Functions inherited from minsky::VariableBase
void	addPorts ()

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

template<minsky::VariableType::Type T>
class minsky::Variable< T >

Definition at line 265 of file variable.h.

Member Typedef Documentation

◆ Type

template<minsky::VariableType::Type T>

typedef VariableBase::Type minsky::Variable< T >::Type

Definition at line 269 of file variable.h.

Constructor & Destructor Documentation

◆ Variable() [1/3]

template<minsky::VariableType::Type T>

minsky::Variable< T >::Variable ( const Variable< T > & x )

inline

Definition at line 273 of file variable.h.

273 : ItemT<Variable<T>, VariableBase>(x) {this->addPorts();}

minsky::Item::x

virtual float x() const

Definition: item.cc:107

minsky::VariableBase::addPorts

void addPorts()

Definition: variable.cc:69

◆ Variable() [2/3]

template<minsky::VariableType::Type T>

minsky::Variable< T >::Variable ( Variable< T > && x )

inline

Definition at line 280 of file variable.h.

280 : ItemT<Variable<T>, VariableBase>(x) {this->addPorts();}

minsky::Item::x

virtual float x() const

Definition: item.cc:107

minsky::VariableBase::addPorts

void addPorts()

Definition: variable.cc:69

◆ Variable() [3/3]

template<minsky::VariableType::Type T>

minsky::Variable< T >::Variable ( const std::string & name = "" )

inline

Definition at line 286 of file variable.h.

286 {VariableBase::name(name); this->addPorts();}

minsky::VariableBase::addPorts

void addPorts()

Definition: variable.cc:69

minsky::VariableBase::name

virtual std::string name() const

variable displayed name

Definition: variable.cc:201

Member Function Documentation

◆ classType()

template<minsky::VariableType::Type T>

std::string minsky::Variable< T >::classType ( ) const

inlineoverridevirtual

Reimplemented from minsky::Item.

Definition at line 287 of file variable.h.

288 {return "Variable:"+VariableType::typeName(type());}

minsky::Variable::type

Type type() const override

Definition: variable.h:270

minsky::VariableType::typeName

static std::string typeName(int t)

Definition: variableType.cc:30

◆ clone()

template<minsky::VariableType::Type T>

Variable* minsky::Variable< T >::clone ( ) const

inlineoverridevirtual

Implements minsky::VariableBase.

Definition at line 289 of file variable.h.

Referenced by minsky::Variable< VariableType::constant >::clone().

                                      {
       auto v=ItemT<Variable<T>, VariableBase>::clone();
       v->controller.reset(); // cloned variables are not controlled by this's controller
       // v is a Variable*, but C++ covariant return types rule prevent it being declared as such
       assert(dynamic_cast<Variable*>(v));
       return static_cast<Variable*>(v); 
     }

Here is the caller graph for this function:

◆ numPorts() [1/8]

template<minsky::VariableType::Type T>

std::size_t minsky::Variable< T >::numPorts ( ) const

overridevirtual

Implements minsky::VariableBase.

◆ numPorts() [2/8]

template<>

size_t minsky::Variable< VariableBase::undefined >::numPorts ( ) const

virtual

Implements minsky::VariableBase.

Definition at line 506 of file variable.cc.

506 {return 0;}

◆ numPorts() [3/8]

template<>

size_t minsky::Variable< VariableBase::constant >::numPorts ( ) const

virtual

Implements minsky::VariableBase.

Definition at line 507 of file variable.cc.

507 {return 1;}

◆ numPorts() [4/8]

template<>

size_t minsky::Variable< VariableBase::parameter >::numPorts ( ) const

virtual

Implements minsky::VariableBase.

Definition at line 508 of file variable.cc.

508 {return 1;}

◆ numPorts() [5/8]

template<>

size_t minsky::Variable< VariableBase::flow >::numPorts ( ) const

virtual

Implements minsky::VariableBase.

Definition at line 509 of file variable.cc.

509 {return 2;}

◆ numPorts() [6/8]

template<>

size_t minsky::Variable< VariableBase::stock >::numPorts ( ) const

virtual

Implements minsky::VariableBase.

Definition at line 510 of file variable.cc.

510 {return 1;}

◆ numPorts() [7/8]

template<>

size_t minsky::Variable< VariableBase::tempFlow >::numPorts ( ) const

virtual

Implements minsky::VariableBase.

Definition at line 511 of file variable.cc.

511 {return 2;}

◆ numPorts() [8/8]

template<>

size_t minsky::Variable< VariableBase::integral >::numPorts ( ) const

virtual

Implements minsky::VariableBase.

Definition at line 512 of file variable.cc.

512 {return 2;}

◆ operator=() [1/2]

template<minsky::VariableType::Type T>

Variable& minsky::Variable< T >::operator= ( const Variable< T > & x )

inline

Definition at line 274 of file variable.h.

                                            {
       VariableBase::operator=(x);
       this->controller.reset(); // copy is not controlled by same object
       this->addPorts();
       return *this;
     }

◆ operator=() [2/2]

template<minsky::VariableType::Type T>

Variable& minsky::Variable< T >::operator= ( Variable< T > && x )

inline

Definition at line 281 of file variable.h.

                                       {
       VariableBase::operator=(x);
       this->addPorts();
       return *this;
     }

◆ type()

template<minsky::VariableType::Type T>

Type minsky::Variable< T >::type ( ) const

inlineoverridevirtual

Implements minsky::VariableBase.

Definition at line 270 of file variable.h.

Referenced by minsky::Variable< VariableType::constant >::classType().

270 {return T;}

Here is the caller graph for this function:

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

model/variable.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

template<minsky::VariableType::Type T> class minsky::Variable< T >

Member Typedef Documentation

◆ Type

Constructor & Destructor Documentation

◆ Variable() [1/3]

◆ Variable() [2/3]

◆ Variable() [3/3]

Member Function Documentation

◆ classType()

◆ clone()

◆ numPorts() [1/8]

◆ numPorts() [2/8]

◆ numPorts() [3/8]

◆ numPorts() [4/8]

◆ numPorts() [5/8]

◆ numPorts() [6/8]

◆ numPorts() [7/8]

◆ numPorts() [8/8]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ type()

template<minsky::VariableType::Type T>
class minsky::Variable< T >