XControl:Abilities:Facade Ability VI - Revision history

Tcplomp: Added the run-mode

2010-02-11T18:46:20Z

Added the run-mode

← Older revision		Revision as of 18:46, 11 February 2010
Line 1:		Line 1:
	The Facade VI is the running heart and display of any [[XControl]]. It decides on which events applied to the XControl should be reacted to in which ways.		The Facade VI is the running heart and display of any [[XControl]]. It decides on which events applied to the XControl should be reacted to in which ways. The front panel of the Facade VI is shown in the owning VI as the control look. [[Image:XControl.xctl Facade Empty.png\|thumb\|center\|600px\|Example XControl Facade VI showing the Timeout frame]]
	The front panel of the Facade VI is shown in the owning VI as the control look.
	[[Image:XControl.~~xctl_Facade_Empty~~.png\|center~~\|thumb~~\|600px\|Example XControl Facade VI showing the Timeout frame]]		=== Facade Ability VI Data ===
	===Facade Ability VI Data===
	The Facade Ability VI has several data in- and outputs to fit in the XControl framework. Changing the names (labels) of these data in- and outputs will break the XControl.		The Facade Ability VI has several data in- and outputs to fit in the XControl framework. Changing the names (labels) of these data in- and outputs will break the XControl.

	{\| class="wikitable"		{\| class="wikitable"
	\|+ Facade Ability data in- and outputs		\|+ Facade Ability data in- and outputs
	\|-		\|-
	! Name		! Name
	! Description		! Description
	! Type		! Type
	\|-		\|-
	\| Data In		\| Data In
	\| Returns last saved value of 'Data Out'		\| Returns last saved value of 'Data Out'
	\| Control		\| Control
	\|-		\|-
	\| Data Out		\| Data Out
	\| Outputs the value for use inside the containing VI		\| Outputs the value for use inside the containing VI
	\| Indicator		\| Indicator
	\|-		\|-
	\| Display State In		\| Display State In
	\| Holds internal data of the XControl		\| Holds internal data of the XControl
	\| Control		\| Control
	\|-		\|-
	\| Display State Out		\| Display State Out
	\| Placeholder for internal data		\| Placeholder for internal data
	\| Indicator		\| Indicator
	\|-		\|-
	\| Container State		\| Container State
	\| Holds information about the XControl for use inside the XControl		\| Holds information about the XControl for use inside the XControl
	\| Control		\| Control
	\|-		\|-
	\| Container State.Indicator?		\| Container State.Indicator?
	\| Returns True if the XControl is an indicator		\| Returns True if the XControl is an indicator
	\| NA		\| NA
	\|-		\|-
	\| Container State.Runmode?		\| Container State.Runmode?
	\| Returns True if the VI containing the XControl is in Runmode.		\| Returns True if the VI containing the XControl is in Runmode.
	\| NA		\| NA
	\|-		\|-
	\| Container State.Refnum		\| Container State.Refnum
	\| Reference to the control representing the XControl		\| Reference to the control representing the XControl
	\| NA		\| NA
	\|-		\|-
	\| Action		\| Action
	\| Contains commands for LabVIEW about the current XControl event session		\| Contains commands for LabVIEW about the current XControl event session
	\| Indicator		\| Indicator
	\|-		\|-
	\| Action.DataChanged?		\| Action.DataChanged?
	\| If this boolean is true LabVIEW will save te 'Data Out' value, if false the value will revert to 'Data In'		\| If this boolean is true LabVIEW will save te 'Data Out' value, if false the value will revert to 'Data In'
	\| NA		\| NA
	\|-		\|-
	\| Action.StateChanged?		\| Action.StateChanged?
	\| If this boolean is true LabVIEW will save te 'Display State Out' value, if false the value will revert to 'Display State In'		\| If this boolean is true LabVIEW will save te 'Display State Out' value, if false the value will revert to 'Display State In'
	\| NA		\| NA
	\|-		\|-
	\| Action.Action Name		\| Action.Action Name
	\| Can be used to track changes made by XControls for undo for instance		\| Can be used to track changes made by XControls for undo for instance
	\| NA		\| NA
	\|}		\|}
	===Facade Ability VI Events===
	The Facade VI contains an event structure inside a while loop. To be useable inside the XControl framework the VI has to be terminated after each event. To enforce this LabVIEW's template XControl has a timeout of 0 ms which finishes the while loop, the XControl can be ended in any of the event cases.		=== Facade Ability VI Events ===

			The Facade VI contains an event structure inside a while loop. To be useable inside the XControl framework the VI has to be terminated after each event. To enforce this LabVIEW's template XControl has a timeout of 0 ms which finishes the while loop, the XControl can be ended in any of the event cases.

	{\| class="wikitable"		{\| class="wikitable"
	\|+ Special Facade Ability VI events		\|+ Special Facade Ability VI events
	\|-		\|-
	! Event Name		! Event Name
	! Function		! Function
	! Called if		! Called if
	\|-		\|-
	\|		\|
	====Data Change====		==== Data Change ====
	\| To keep the representation of the XControl up to date with the data of the XControl
			\| To keep the representation of the XControl up to date with the data of the XControl
	\| On load of the XControl, if a new value to the terminal/local variable/'value' property is written or the 'value (sgl)' property is called		\| On load of the XControl, if a new value to the terminal/local variable/'value' property is written or the 'value (sgl)' property is called
	\|-		\|-
	\|		\|
	====Display State Change====		==== Display State Change ====
	\| To communicate between XControl parts
			\| To communicate between XControl parts
	\| The XControl is loaded into memory, a custom property or method is used		\| The XControl is loaded into memory, a custom property or method is used
	\|-		\|-
	\|		\|
	====Direction Change====		==== Direction Change ====
	\| To inform the XControl of the 'gender' of it's terminal
			\| To inform the XControl of the 'gender' of it's terminal
	\| The terminal of the XControl is converted from Control to indicator and visa versa. On initial drop of the XControl, or load into memory		\| The terminal of the XControl is converted from Control to indicator and visa versa. On initial drop of the XControl, or load into memory
	\|-		\|-
Line 88:		Line 93:
	==== Exec State Change ====		==== Exec State Change ====

	\| To inform the XControl of the mode of it's owning VI \| If the owning VI is started or stopped. If the owning VI is loaded into memory		\| To inform the XControl of the mode of it's owning VI
			\| If the owning VI is started or stopped. If the owning VI is loaded into memory.<br>Remark: If the VI is in run-mode (ctrl-m), this event is not called when the VI starts/stops, but when it enters/leaves the run-mode.
			\|}

			=== Facade VI tricks ===

	~~Remark: If~~ the ~~VI is in run-mode (ctrl-m) this event is not triggered when~~ the ~~VI starts/stops running, but when it enters/leaves the run-mode\|}~~		*To resize an XControl from within the XControl the following code must be used:

	~~===Facade VI tricks===~~		[[Image:XControl.Bounds.PNG]]
	* To resize an XControl from within the XControl the following code must be used:
	[[Image:XControl.Bounds.PNG]]

	* To gain control over the owning VI the property ''Container State.Refnum:Owning VI'' can be used, for instance to change the current cursor icon of the owning VI.		*To gain control over the owning VI the property ''Container State.Refnum:Owning VI'' can be used, for instance to change the current cursor icon of the owning VI.

	* Make a difference between run-time and edit-time. This allows for setting properties via a context menu for the developer while the user can't access these settings.		*Make a difference between run-time and edit-time. This allows for setting properties via a context menu for the developer while the user can't access these settings.

	* Remember to update the Action control to store changes in the ''Data'' or ''State'' value		*Remember to update the Action control to store changes in the ''Data'' or ''State'' value

	* XControls will generate user events (mouse/key) when the XControl is disabled in the owning VI so you might need to check for this		*XControls will generate user events (mouse/key) when the XControl is disabled in the owning VI so you might need to check for this

	[[Category:XControl\|Facade]]		[[Category:XControl\|Facade]]

Tcplomp at 18:44, 11 February 2010

2010-02-11T18:44:44Z

← Older revision		Revision as of 18:44, 11 February 2010
Line 86:		Line 86:
	\|-		\|-
	\|		\|
	====Exec State Change====		==== Exec State Change ====
	\| To inform the XControl of the mode of it's owning VI
	\| If the owning VI is started or stopped. If the owning VI is loaded into memory		\| To inform the XControl of the mode of it's owning VI \| If the owning VI is started or stopped. If the owning VI is loaded into memory
	\|}
			Remark: If the VI is in run-mode (ctrl-m) this event is not triggered when the VI starts/stops running, but when it enters/leaves the run-mode\|}

	===Facade VI tricks===		===Facade VI tricks===

Tcplomp at 16:42, 18 February 2008

2008-02-18T16:42:16Z

← Older revision		Revision as of 16:42, 18 February 2008
Line 103:		Line 103:
	* XControls will generate user events (mouse/key) when the XControl is disabled in the owning VI so you might need to check for this		* XControls will generate user events (mouse/key) when the XControl is disabled in the owning VI so you might need to check for this

	[[Category:XControl\|~~Abilities~~]]		[[Category:XControl\|Facade]]

Tcplomp at 16:38, 18 February 2008

2008-02-18T16:38:03Z

← Older revision		Revision as of 16:38, 18 February 2008
Line 103:		Line 103:
	* XControls will generate user events (mouse/key) when the XControl is disabled in the owning VI so you might need to check for this		* XControls will generate user events (mouse/key) when the XControl is disabled in the owning VI so you might need to check for this

	[[Category:XControl]]		[[Category:XControl\|Abilities]]

Michael_Aivaliotis at 07:08, 8 October 2007

2007-10-08T07:08:15Z

← Older revision		Revision as of 07:08, 8 October 2007
Line 1:		Line 1:
	~~__NOTOC__~~
	~~{\| align="right" border="0"~~
	~~\|__TOC__~~
	\|-
	\|}
	~~== Facade Ability VI==~~
	The Facade VI is the running heart and display of any [[XControl]]. It decides on which events applied to the XControl should be reacted to in which ways.		The Facade VI is the running heart and display of any [[XControl]]. It decides on which events applied to the XControl should be reacted to in which ways.
	The front panel of the Facade VI is shown in the owning VI as the control look.		The front panel of the Facade VI is shown in the owning VI as the control look.
Line 109:		Line 103:
	* XControls will generate user events (mouse/key) when the XControl is disabled in the owning VI so you might need to check for this		* XControls will generate user events (mouse/key) when the XControl is disabled in the owning VI so you might need to check for this

	[[Category:~~User Interface~~]]		[[Category:XControl]]

Tcplomp at 19:23, 28 July 2007

2007-07-28T19:23:31Z

← Older revision		Revision as of 19:23, 28 July 2007
Line 1:		Line 1:
			__NOTOC__
			{\| align="right" border="0"
			\|__TOC__
			\|-
			\|}
	== Facade Ability VI==		== Facade Ability VI==
	The Facade VI is the running heart and display of any [[XControl]]. It decides on which events applied to the XControl should be reacted to in which ways.		The Facade VI is the running heart and display of any [[XControl]]. It decides on which events applied to the XControl should be reacted to in which ways.
Line 102:		Line 107:
	* Remember to update the Action control to store changes in the ''Data'' or ''State'' value		* Remember to update the Action control to store changes in the ''Data'' or ''State'' value

	* XControls will generate user events (mouse/key) when the XControl is disabled in the owning VI		* XControls will generate user events (mouse/key) when the XControl is disabled in the owning VI so you might need to check for this

			[[Category:User Interface]]

Tcplomp: New page: == Facade Ability VI== The Facade VI is the running heart and display of any XControl. It decides on which events applied to the XControl should be reacted to in which ways. The front ...

2007-07-28T19:09:26Z

New page: == Facade Ability VI== The Facade VI is the running heart and display of any XControl. It decides on which events applied to the XControl should be reacted to in which ways. The front ...

New page

== Facade Ability VI==
The Facade VI is the running heart and display of any [[XControl]]. It decides on which events applied to the XControl should be reacted to in which ways.
The front panel of the Facade VI is shown in the owning VI as the control look.
[[Image:XControl.xctl_Facade_Empty.png|center|thumb|600px|Example XControl Facade VI showing the Timeout frame]]
===Facade Ability VI Data===
The Facade Ability VI has several data in- and outputs to fit in the XControl framework. Changing the names (labels) of these data in- and outputs will break the XControl.

{| class="wikitable"
|+ Facade Ability data in- and outputs
|-
! Name
! Description
! Type
|-
| Data In
| Returns last saved value of 'Data Out'
| Control
|-
| Data Out
| Outputs the value for use inside the containing VI
| Indicator
|-
| Display State In
| Holds internal data of the XControl
| Control
|-
| Display State Out
| Placeholder for internal data
| Indicator
|-
| Container State
| Holds information about the XControl for use inside the XControl
| Control
|-
| Container State.Indicator?
| Returns True if the XControl is an indicator
| NA
|-
| Container State.Runmode?
| Returns True if the VI containing the XControl is in Runmode.
| NA
|-
| Container State.Refnum
| Reference to the control representing the XControl
| NA
|-
| Action
| Contains commands for LabVIEW about the current XControl event session
| Indicator
|-
| Action.DataChanged?
| If this boolean is true LabVIEW will save te 'Data Out' value, if false the value will revert to 'Data In'
| NA
|-
| Action.StateChanged?
| If this boolean is true LabVIEW will save te 'Display State Out' value, if false the value will revert to 'Display State In'
| NA
|-
| Action.Action Name
| Can be used to track changes made by XControls for undo for instance
| NA
|}
===Facade Ability VI Events===
The Facade VI contains an event structure inside a while loop. To be useable inside the XControl framework the VI has to be terminated after each event. To enforce this LabVIEW's template XControl has a timeout of 0 ms which finishes the while loop, the XControl can be ended in any of the event cases.

{| class="wikitable"
|+ Special Facade Ability VI events
|-
! Event Name
! Function
! Called if
|-
|
====Data Change====
| To keep the representation of the XControl up to date with the data of the XControl
| On load of the XControl, if a new value to the terminal/local variable/'value' property is written or the 'value (sgl)' property is called
|-
|
====Display State Change====
| To communicate between XControl parts
| The XControl is loaded into memory, a custom property or method is used
|-
|
====Direction Change====
| To inform the XControl of the 'gender' of it's terminal
| The terminal of the XControl is converted from Control to indicator and visa versa. On initial drop of the XControl, or load into memory
|-
|
====Exec State Change====
| To inform the XControl of the mode of it's owning VI
| If the owning VI is started or stopped. If the owning VI is loaded into memory
|}

===Facade VI tricks===
* To resize an XControl from within the XControl the following code must be used:
[[Image:XControl.Bounds.PNG]]

* To gain control over the owning VI the property ''Container State.Refnum:Owning VI'' can be used, for instance to change the current cursor icon of the owning VI.

* Make a difference between run-time and edit-time. This allows for setting properties via a context menu for the developer while the user can't access these settings.

* Remember to update the Action control to store changes in the ''Data'' or ''State'' value

* XControls will generate user events (mouse/key) when the XControl is disabled in the owning VI