LabVIEW Wiki - User contributions [en]

Code Capture Tool

2013-02-19T13:02:08Z

Tcplomp:

{{TOCright}}

 

== Introduction ==

[[Image:CCT GUI.png|300px|Code Capture Tool user interface]]The Code Capture Tool (or CCT) is a [[LabVIEW]] development tool targeted at LabVIEW users to capture images of their code and make it easier to share those images in online forums. 

=== Main Features ===

*Captures of Front Panel
*Captures of Block Diagram
*Comment an Annotate your caputre
*Creation of LabVIEW Snippets in any LabVIEW version
*Save the snippet as anoter (older) version
*Upload the capture to [http://www.imgur.com Imgur.com] and copy the URL to he clipboard (LabVIEW 2010 and later)
*[http://tononlabview.blogspot.nl/2013/02/code-capture-tools-plugins-introduction.html Plugins] for altering the image or text returned to clipboard

=== History ===

The CCT is based on an idea and earlier versions originally released by [http://forums.ni.com/ni/profile?user.id=34024 Chilly Charly] on the [[NI Forums]] as [http://forums.ni.com/ni/board/message?board.id=BreakPoint&thread.id=1020 starware]. Later, it evolved to a multiple OS and LabVIEW versions tool for creating code-shots and documentation shots. A collaboration between [http://forums.lavag.org/Yair-m1431.html Yair Neeman] and [[User:Tcplomp|Ton Plomp]] resulted in the 1.0 version of the CCT that is currently available through the [[LAVA CR]] at [http://forums.lavag.org/downloads-file121.html this site].

Version 2.0 added the possibility to add text and drawings to the captured image, while version 2.1 added an altered GUI, a border around the snippet and better key-handling. Version 2.1.2 added the option upload the image to Imgur.com and save the snippet in an older version of LabVIEW. 
Version 3.2 added a plugin architecture and a new GUI layout.

== Instruction ==

A series of videos is available at [http://www.screencast.com/t/ZmQ1YjIxNj Screencast].

A short how to is in the [http://www.screencast.com/t/2aWPdibJ9Sk here available]

An extensive discussion and demo of the CCT is [http://www.screencast.com/t/Yhb9IAOc here]. 

Version 2.0 introduces a new option to create annotations with text and graphics and the possibility to create [[Snippet|snippets]]. There is a demo-video available at [http://www.screencast.com/t/YTY4MjllZmIt Screencast].

== Download ==



Click [vipm://lava_lib_code_capture_tool here] to download the tool using VIPM.

To check the source you can explore your ''<user.lib>\_Code Capture Too''l folder or download it from [https://sourceforge.net/p/lv-cct-tool/code/ci/tip/tree/Trunk/ Sourceforge.net]. 

= Interface =

The CCT offers two interfaces to make and distribute images of LabVIEW code - a [[Code Capture Tool#GUI|user interface]] and an [[Code Capture Tool#API|API]].

== GUI ==

The user interface of the CCT allows the user to select which parts of a [[Front Panel]] or [[Block Diagram]] should be captured. The resulting image will be stored on disc and optionally the image or the path can be copied to the OS clipboard.

[[Image:CCT GUI.png|thumb|center|400px|Code Capture Tool user interface]]

=== Front panel settings ===

The Front Panel listbox supplies the following options:

{| class="wikitable"
|-
! Listbox
! Item
! Captured parts
|-
| rowspan="4" | [[Image:CCT FP.png]]
| None
| Nothing
|-
| Selected
| All selected parts and items in between
|-
| Visible
| Everything visible in the current panel view
|-
| All
| Everything on the front panel
|}

=== Block diagram settings ===

The Block Diagram listbox supplies the following options:

{| class="wikitable"
|-
! Listbox
! Item
! Captured parts
|-
| rowspan="4" | [[Image:CCT BD.png]]
| None
| Nothing
|-
| Selected
| All selected parts and items in between
|-
| Visible
| Everything visible in the current block diagram view
|-
| All
| Everything on the block diagram
|}

==== Snippet Creation ====

The creation of a [[Snippet|snippet]] can only be done when the '''Block Diagram''' is set to '''selected'''. 

[[Image:CCTSnippetButtons.png]]

The header-text of the snippet is dynamically and has the following options which are accessible with the config button: 

{| class="wikitable"
|-
! scope="col" | Token 
! scope="col" | Meaning 
|-
| $VERSION$ 
| Inserts the saved [[Labview|LabVIEW]] version 
|-
| $NAME$ 
| Name of the captured VI, retrieved from the VI.VI Name property 
|-
| $TITLE$ 
| Title of the front panel of the captured VI 
|-
| $IMAGENAME$ 
| Name of image on disk without the PNG extension 
|-
| $IMAGE$ 
| Name of image on disk without the PNG extension (a duplicate of $IMAGENAME$ 
|-
| $DATE:xxx$ 
| Date/Time formatter, <tt>xxx</tt> must be replaced by a valid [http://zone.ni.com/reference/en-XX/help/371361F-01/glang/codes_for_time_format_str/ timestring formatter] 
|}

Per default the header string is <tt>LV: $VERSION$ $DATE:%c$</tt>, %c inserts the localized date. 

 

=== Clipboard settings ===

The clipboard listbox supplies the following options:

{| class="wikitable"
|-
! Listbox
! Item
! Copied item
! Remarks
|-
| rowspan="4" | [[Image:CCT ClipBoard.png]]
| None
| Nothing
| 
|-
| Path
| Path of the captured image
| Not on all platforms
|-
| Image
| The captured image
| Only on Windows
|-
| Imgur
| The URL of the Imgur image
| Selecting this will upload the image to Imgur.com
|}
Additional plugins are listed here as well.

=== Layout settings ===

The Layout picture ring supplies the following layout options:

{| class="wikitable"
|-
! Menu Ring
! Item
! Description
|-
| rowspan="4" | [[Image:CCT Layout.png]]
| [[Image:CCT Layout1.png]]
| Front panel in top, block diagram below
|-
| [[Image:CCT Layout2.png]]
| Block diagram in top, front panel below
|-
| [[Image:CCT Layout3.png]]
| Front panel in left, block diagram on the right
|-
| [[Image:CCT Layout4.png]]
| Block diagram in left, front panel on the right
|}

=== File settings ===

[[Image:CCT FileSettings.png]]

The file settings consists of two controls, the string control to name the file (a .png extension is added to the name automatically) and a browse button to set the folder where the file should be stored. To detect which folder is currently used hover over one of the two controls and the tip-strip will show the folder.

==== Resetting the folder ====

By default the storage folder is the LabVIEW temp folder (which by default is the same as the OS temp folder), and can be changed with the browse for folder button. To revert to the temp folder use this button [[Image:CCT Reset.png]].

=== Zoom function ===

[[Image:CCT Zoom.png]]

The zoom slider allows the user to zoom in and out on the captured image and inspect it in detail. This only affects the preview image and will not change the stored image.

=== Annotation/Sketch toolbars ===

[[Image:CCTAnnotationOptions.png]]

The annotation/sketch toolbars are used to add annotations and sketches/drawings to the capture. 

==== Drawing tools ====

{| cellspacing="10" cellpadding="2" border="0" align="left" width="407" style=""
|-
| [[Image:AnnotationOptionsRotated.png|left|18x98px]]
|
'''Rectangle:''' Use shift to draw a square 

'''Oval:''' Use shift to draw a circle '''Line:''' Use shift to limit drawing to one axis (X or Y) 

'''Arrow:''' Use shift to limit drawing to one axis (X or Y) '''Free: ''' Use this to draw irregular shapes 

|}

 

 

 

 

 

 

 

==== Drawing Styles ====

[[Image:CCTStylesDetail.png]] The style of the line can be one of 5 styles: 

*Continious
*Dash
*Dot
*Dash-Dot
*Dash-Dot-Dot

 

==== Line width ====

The linewidth of the sketch/drawing line can be alterd as well [[Image:CCT Linewidth.png]] 

==== Line/Text color ====

It's possible to alter the color of the annotation (sketch or text), when editing text changing the line coler takes effect immediatly.

==== Text size ====

The font of the annotation text cannot be altered and is fixed on <tt>Arial </tt>, the size however can be altered easily.

==== Editing tools ====

{| width="50%" cellspacing="2" cellpadding="1" border="0" align="left"
|-
| [[Image:CCT Text.png]] 
| Starts editing text Use shift-enter to add anew-line Use arrow keys to move the positioning of the text around 
|-
| [[Image:CCT Pan.png]] 
| Use this to move the preview window around, this is the default tool of the Annotation Sketch toolbar. It does not change the captured image. 
|-
| [[Image:CCT Undo.png]] 
| Use this to undo the last edit on the annotation/sketch (4 steps possible), use <ctrl-z> on [[Image:Logo.Windows.png]] and [[Image:Logo.Linux.png]] and <cmd-z> on [[Image:Logo.Mac.png]]. 
|-
| [[Image:CCT Clear.png]]
| Clear the annotation layer. 
|}

 

 

 

 

 

 

=== Help ===

The help button [[Image:CCT Help.png]] calls the about window of the CCT including a short description of the main functions, a link to the webpage, a list of know issues and licensing info.

=== Capture ===

The capture button [[Image:CCT Capture.png]] will capture the image, save it, copy to the clipboard, save the currently selected options for the next time and close the window. This can also be done by pressing Enter.

=== Clean up ===

The clean up button [[Image:CCTCleanUp.png]] will clean up the whole BD (if 'whole' is set as BD option) or the current selection (if 'Selections' is set as BD option). This button is only visible if this option is active (correct LabVIEW version).

=== Key navigation ===

The CCT has several key shortcuts for easier access:

{| class="wikitable"
|-
! Key
! Function
|-
| Enter
| Applies the current settings and does a [[Code Capture Tool#Capture|capture]] or finishes a current text edit 
|-
| F1
| Loads the about window centered on the help tab
|-
| F5
| Refreshes the current image
|-
| Escape
| Closes the CCT without performing a capture or finishes a current text/graph edit 
|}

== API ==

The API provides an interface to the various functions of the CCT. Its palette is accessible under [[User.lib]]\Code Capture Tool.

[[Image:CCT palette.PNG]]

{| class="wikitable"
|-
! [[#Methods|Methods]]
| <linkedimage>
img_src=Image:CCT_GetSessions.png
wikipage=Code_Capture_Tool#Create_CCT_Instance
</linkedimage>
| <linkedimage>
img_src=Image:CCT_Capture_icon.png
wikipage=Code_Capture_Tool#Capture_Image
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SaveImage.png
wikipage=Code_Capture_Tool#Save_Image
</linkedimage>
| <linkedimage>
img_src=Image:CCT_CopyToClipboard.png
wikipage=Code_Capture_Tool#Copy_to_Clipboard
</linkedimage>
| 
| <linkedimage>
img_src=Image:CCT_CloseSession.png
wikipage=Code_Capture_Tool#Destroy_CCT_Instance
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GenerateFileName.png
wikipage=Code_Capture_Tool#Generate_File_Name
</linkedimage>
|-
! [[#Set_properties|Set properties]]
| <linkedimage>
img_src=Image:CCT_SetFP.png
wikipage=Code_Capture_Tool#Set_Front_Panel_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SetBD.png
wikipage=Code_Capture_Tool#Set_Block_Diagram_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SetLayout.png
wikipage=Code_Capture_Tool#Set_Layout_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SetClipboard.png
wikipage=Code_Capture_Tool#Set_Clipboard_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SetVI.png
wikipage=Code_Capture_Tool#Set_VI_Ref
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SetFolder.png
wikipage=Code_Capture_Tool#Set_Folder
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SetFileName.png
wikipage=Code_Capture_Tool#Set_Filename
</linkedimage>
|-
! [[#Get_properties|Get properties]]
| <linkedimage>
img_src=Image:CCT_GetFP.png
wikipage=Code_Capture_Tool#Get_Front_Panel_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GetBD.png
wikipage=Code_Capture_Tool#Get_Block_Diagram_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GetLayout.png
wikipage=Code_Capture_Tool#Get_Layout_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GetClipboard.png
wikipage=Code_Capture_Tool#Get_Clipboard_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GetVI.png
wikipage=Code_Capture_Tool#Get_VI_Ref
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GetFolder.png
wikipage=Code_Capture_Tool#Get_Folder
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GetFileName.png
wikipage=Code_Capture_Tool#Get_Filename
</linkedimage>
|-
! [[#Support|Support]]
| <linkedimage>
img_src=Image:CCT_Support.png
wikipage=Code_Capture_Tool#Support
</linkedimage>
| 
| <linkedimage>
img_src=Image:CCT_CaptureFP.png
wikipage=Code_Capture_Tool#Capture_Front_panel
</linkedimage>
| <linkedimage>
img_src=Image:CCT_CaptureBD.png
wikipage=Code_Capture_Tool#Capture_Block_diagram
</linkedimage>
| <linkedimage>
img_src=Image:CCT_ShowGUI.png
wikipage=Code_Capture_Tool#Show_CCT_GUI
</linkedimage>
| <linkedimage>
img_src=Image:CCT_70Container.png
wikipage=Code_Capture_Tool#7.0_container_VI
</linkedimage>
| <linkedimage>
img_src=Image:CCT_80_Container.png
wikipage=Code_Capture_Tool#8.0_container_VI
</linkedimage>
|}

=== Methods ===

{| class="wikitable"
|-
! [[#Methods|Methods]]
| <linkedimage>
img_src=Image:CCT_GetSessions.png
wikipage=Code_Capture_Tool#Create_CCT_Instance
</linkedimage>
| <linkedimage>
img_src=Image:CCT_Capture_icon.png
wikipage=Code_Capture_Tool#Capture_Image
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SaveImage.png
wikipage=Code_Capture_Tool#Save_Image
</linkedimage>
| <linkedimage>
img_src=Image:CCT_CopyToClipboard.png
wikipage=Code_Capture_Tool#Copy_to_Clipboard
</linkedimage>
| <linkedimage>
img_src=Image:CCT_CloseSession.png
wikipage=Code_Capture_Tool#Destroy_CCT_Instance
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GenerateFileName.png
wikipage=Code_Capture_Tool#Generate_File_Name
</linkedimage>
|}

These VIs are used to activate methods for the CCT.

==== Create CCT Instance ====

[[Image:CCT Create CCT.png|Creat CCT Instance]]

This VI must be called for every instance of the CCT, it creates a GOOP dataspace that will contain the data of the instance. Calling this VI must be done with a valid VI reference.

==== Capture Image ====

[[Image:CCT Capture VI Images CCT.png|Capture Images]]

This VI will apply the current settings and store the captured image in the CCT instance, additionally it returns the image itself.

==== Save Image ====

[[Image:CCT Save Captured Image CCT.png|Save Image]]

This VI will save the image to the path specified by a folder and filename stored in the CCT instance.

==== Copy to Clipboard ====

[[Image:CCT Copy Data to Clipboard CCT.png|Copy to Clipboard]]

This VI will store the data specified by the clipboard settings to the clipboard.

==== Destroy CCT Instance ====

[[Image:CCT Destroy CCT.png|Destroy CCT Instance]]

This VI must be called to close the CCT Instance and will free up used memory resources.

==== Generate File Name ====

[[Image:CCT Generate File Name CCT.png|Generate filename]]

This VI will generate a default filename based on the captured parts and VI name. This filename will not be stored inside the CCT session.

=== Set properties ===

{| class="wikitable"
|-
! [[#Set_properties|Set properties]]
| <linkedimage>
img_src=Image:CCT_SetFP.png
wikipage=Code_Capture_Tool#Set_Front_Panel_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SetBD.png
wikipage=Code_Capture_Tool#Set_Block_Diagram_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SetLayout.png
wikipage=Code_Capture_Tool#Set_Layout_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SetClipboard.png
wikipage=Code_Capture_Tool#Set_Clipboard_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SetVI.png
wikipage=Code_Capture_Tool#Set_VI_Ref
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SetFolder.png
wikipage=Code_Capture_Tool#Set_Folder
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SetFileName.png
wikipage=Code_Capture_Tool#Set_Filename
</linkedimage>
|}

These VIs are used to change properties for the CCT instance.

==== Set Front Panel Mode ====

[[Image:CCT Set FP Mode CCT.png|Set FP mode]]

This VI will change the current front panel capture mode.

==== Set Block Diagram Mode ====

[[Image:CCT Set BD Mode CCT.png|Set BD mode]]

This VI will change the current block diagram capture mode.

==== Set Layout Mode ====

[[Image:CCT Set Layout Mode CCT.png|Set Layout mode]]

This VI will change the current layout orientation.

==== Set Clipboard Mode ====

[[Image:CCT Set Clipboard Mode CCT.png|Set Clipboard mode]]

This VI will change the current clipboard mode.

==== Set VI Ref ====

[[Image:CCT Set VI Ref CCT.png|Set Clipboard mode]]

This VI sets the reference of the VI that needs to be captured

==== Set Folder ====

[[Image:CCT Set Folder CCT.png|Set Folder]]

This VI will change the folder where the images will be saved.

==== Set Filename ====

[[Image:CCT Set File CCT.png|Set Filename]]

This VI will change the filename of the stored image.

=== Get properties ===

{| class="wikitable"
|-
! [[#Get_properties|Get properties]]
| <linkedimage>
img_src=Image:CCT_GetFP.png
wikipage=Code_Capture_Tool#Get_Front_Panel_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GetBD.png
wikipage=Code_Capture_Tool#Get_Block_Diagram_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GetLayout.png
wikipage=Code_Capture_Tool#Get_Layout_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GetClipboard.png
wikipage=Code_Capture_Tool#Get_Clipboard_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GetVI.png
wikipage=Code_Capture_Tool#Get_VI_Ref
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GetFolder.png
wikipage=Code_Capture_Tool#Get_Folder
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GetFileName.png
wikipage=Code_Capture_Tool#Get_Filename
</linkedimage>
|}

These VIs are used to retrieve properties from the CCT instance.

==== Get Front Panel Mode ====

[[Image:CCT Get FP Setting CCT.png|Get FP mode]]

This VI will read the current front panel capture mode.

==== Get Block Diagram Mode ====

[[Image:CCT Get BD Mode CCT.png|Get BD mode]]

This VI will read the current block diagram capture mode.

==== Get Layout Mode ====

[[Image:CCT Get Layout Mode CCT.png|Get Layout mode]]

This VI will read the current layout orientation.

==== Get Clipboard Mode ====

[[Image:CCT Get Clipboard Mode CCT.png|Get Clipboard mode]]

This VI will read the current clipboard mode.

==== Get VI Ref ====

[[Image:CCT Get VI Ref CCT.png|Get VI Reference]]

This VI returns a reference to the that is currently captured in this isntance

==== Get Folder ====

[[Image:CCT Get Folder CCT.png|Get Folder]]

This VI will read the folder where the images will be saved.

==== Get Filename ====

[[Image:CCT Get File CCT.png|Get Filename]]

This VI will read the filename of the stored image.

=== Support ===

{| class="wikitable"
|-
! [[#Support|Support]]
| <linkedimage>
img_src=Image:CCT_CaptureFP.png
wikipage=Code_Capture_Tool#Capture_Front_panel
</linkedimage>
| <linkedimage>
img_src=Image:CCT_CaptureBD.png
wikipage=Code_Capture_Tool#Capture_Block_diagram
</linkedimage>
| <linkedimage>
img_src=Image:CCT_ShowGUI.png
wikipage=Code_Capture_Tool#Show_CCT_GUI
</linkedimage>
| <linkedimage>
img_src=Image:CCT_70Container.png
wikipage=Code_Capture_Tool#7.0_container_VI
</linkedimage>
| <linkedimage>
img_src=Image:CCT_80_Container.png
wikipage=Code_Capture_Tool#8.0_container_VI
</linkedimage>
|}

This submenu shows additional low level functions of the CCT.

==== Capture Front panel ====

[[Image:CCT Capture Panel Picture CCT.png|Capture front panel]]

Use this VI to have direct access to the capturing of a front panel.

==== Capture Block diagram ====

[[Image:CCT Capture Diagram Picture CCT.png|Capture block diagram]]

Use this VI to have direct access to the capturing of a block diagram.

==== Show CCT GUI ====

[[Image:Code Capture Tool GUI CCT.png|Show CCT GUI]]

Use this VI to show the user interface of the CCT.

==== 7.0 container VI ====

[[Image:Container 70 CCT.png|7.0 container]]

Use this VI if you want to build a source distribution or an executable and need to make sure all dynamic VIs are included. For LabVIEW 7.0 and up.

==== 8.0 container VI (deprecated in version 2.0) ====

[[Image:Container 80 CCT.png|8.0 container]]

Use this VI if you want to build a source distribution or an executable and need to make sure all dynamic VIs are included. For LabVIEW 8.0 and up, don't forget to include the 7.0 container.

Version 2.0 of the Code Capture Tool installer will automatically select the correct container VI, so an additional 8.x container isn't needed anymore.

= Known issues =

{| class="wikitable"
|-
! Description
! Status
|-
| After using a non-default path and resetting it to the default, the new setting (temp) is not used
| Solved in version 1.0
|-
| Installing on Linux fails due to case sensitivity
| Solved in version 1.0
|-
| Capturing a non-visible part on a multi-pane front panel fails
| A limitation due to the LabVIEW implementation of panes, most-likely not fixable
|-
| Saving an empty image returns an error
| Solved in version 1.0
|-
| Opening the CCT from the Getting Started Window locks up LabVIEW
| Solved in version 1.0
|-
| Possible High use of memory
| Investigating
|-
| Impossible to capture FP of locked VI
| Investigating
|}

= Version History =

== Version 3.2 ==

Release date 1 februari 2013

*Altered GUI
*Added resizable User interface
*Added scroll wheel control of the image
*Added plugin feature

== Version 2.1.4 ==

Release date 2 december 2010 

*Fixed bug [http://sourceforge.net/tracker/index.php?func=detail&aid=3121172&group_id=206229&atid=996819 #3121172]  for locked VIs (without password protection) 
*Added a message dialogue after the Capture button was activated 

== Version 2.1.3 ==

Release date 29 September 2010

*Fixed a bug that didn't show the images properly on initialization

== Version 2.1.2 ==

Release date 20 September 2010

*Added Imgur.com upload
*Added 'Save for Previous Version' snippet function

== Version 2.1.0 ==

Release date 15 February 2010

*Added a border around a snippet
*Altered GUI (Preview window is bigger)
*Better key handling with text annotation, support for HOME and END.
*Movement of text annotation with ctrl-left, ctrl-right, up and down
*Movement in a text annotation with left and right

== Version 2.0.5 ==

Release date 28 November 2009

*Bugfix release for bug [https://sourceforge.net/tracker/?func=detail&atid=996819&aid=2905411&group_id=206229 2905411].

== Version 2.0.0 ==

Release date 24 November 2009

*Support for VI snippet creation
*Support for adding comments and drawings

== Version 1.0.0 ==

Release date 27 February 2008

*Bug-fixes
*Support for panning of the preview

== Version 0.9.1 ==

Release date 7 November 2007

*Support for LabVIEW 7.x and up
*Support for all OS'es
*Support for orientation
*Support for selection
*Support for customized naming
*Support for customized folder

 

= Licensing =

The CCT is licensed under the BSD license

[[Category:Third party LabVIEW tools]]

[[Category:Third party LabVIEW tools]]

File:CCT GUI.png

2013-02-19T12:26:53Z

Tcplomp: uploaded a new version of "File:CCT GUI.png": Version 3.2 GUI layour

Snippet

2012-11-24T07:36:37Z

Tcplomp: /* Creation */

{{TOCright}} 

A snippet is in the [[LabVIEW|LabVIEW]] context an image of LabVIEW code. 

[http://zone.ni.com/devzone/cda/tut/p/id/9330 LabVIEW 2009 introduced] the embedding of the actual code inside a [http://en.wikipedia.org/wiki/Portable_Network_Graphics PNG] image. 

With this functionality it is possible to expose your code on a website, and with the same file import the code into a LabVIEW [[VI|VI]]. 

= Creation =
==Native==
LabVIEW 2009 has native support to create a snippet, in the 'Edit' menu select '[http://zone.ni.com/reference/en-XX/help/371361G-01/lvhowto/create_visnippet/ Create Snippet from selection]'.

==Advanced==
With the [[Code Capture Tool|Code Capture Tool]] version 2.0 it's possible to create a snippet in any LabVIEW version from 7.0 and up. 

= Importing =

== LabVIEW 2009 ==

To import the actual code into a VI, just drag and drop the image onto the block diagram of a VI. With [http://www.microsoft.com/Windows/internet-explorer/ Internet Explorer] it's possible to drag and drop the image for a web-page into a VI directly. 

For [http://www.mozilla.com/firefox/ Firefox] and [http://www.google.com/chrome Google Chrome] it's necessary to drop the image in an OS folder or use a plugin [http://addons.mozilla.org/firefox/addon/1419 IETab] (for Firefox). 

== LabVIEW 8.2, 8.5 and 8.6 ==

To import a snippet into LabVIEW 8.2 it's possible if the snippet is created with the [[Code Capture Tool|Code Capture Tool]] in the same (or an older) version of LabVIEW. Second you need a special tool developed by [http://lavag.org/user/7534-jcarmody/ JCarmody]. This tool is available for [http://lavag.org/index.php?app=downloads&showfile=118 download] in the LAVA Uncertified Code Repository. 

= Technique =

The code of a LabVIEW snippet is stored inside a [http://en.wikipedia.org/wiki/Portable_Network_Graphics#.22Chunks.22_within_the_file PNG Chunk] named 'niVI'. The capitalization of this chunkname makes sure the code is removed if someone alters the image, thus preventing the creation of malicious snippets. 

Inside this chunk a filestream representing a VI is stored. LabVIEW interprets this as a normal VI to be embedded. 

== Code integrity ==

Technically it's possible to have a different codeset embedded than represented by the PNG image chunk. This is proven by [http://forums.ni.com/ni/view_profile?user.id=134255 Darin.K] on the [[NI Forums|NI Forum]] with the following snippet: 

[[Image:MerrimanSnippet.png]] 

[http://forums.ni.com/ni/board/message?board.id=BreakPoint&view=by_date_ascending&message.id=8610#M8610 Source ] 

Upon dropping this image on a LabVIEW diagram another image was placed.

The name of the Snippet Chunk (niVI), describes this chunk as [http://www.w3.org/TR/2003/REC-PNG-20031110/#5Chunk-naming-conventions unsave to copy], tests with Paint.net shows that indeed the chunk is removed when the image is altered. However usage of Microsoft Paint show that the snippet is not removed upon editing of the image.

How to do Menu Launch VIs

2012-10-18T19:09:51Z

Tcplomp:

==Customizing LabVIEW Menus==

LabVIEW provides a mechanism, which allows the user to open VIs and help files by selecting them from the Tools and Help pull-down menus. This is a very powerful feature for development tools creation, so I will describe how this works. When LabVIEW starts up it does several things, which include initializing the menus. This is a process where LabVIEW looks for files within specific directories for inclusion in the menus.

==Menu Launch Folders==

* .\wizard - File menu-launch
* .\project - Tools menu-launch
* .\help - Help menu-launch

The .\wizard, .\project, and .\help folders are intrinsically related to the "File", "Tools", and "Help" menus, respectively. When you install a LabVIEW add-on, you will notice that new menu items are usually added to these two menus. This was achieved by adding files to the .\project and .\help folders. Through a little experimentation the nature of this process has been determined to be the following:

==Technical details==
First, LabVIEW looks in the .\wizard, .\project, and .\help folders for standalone VIs and top-level VIs within LLBs. In the .\help folder, it also looks for .hlp and .chm compiled help files. These files are then opened when selected from the menu. LabVIEW will look recursively through all subfolders and LLBs looking for these files of interest. However, the search will ignore any VIs, folders, or LLBs whose name begins with an underscore ("_") character. When the search finds a file of interest it will create a menu item at a location, which reflects where it found it in the directory structure inside the project or help folder. For Example, if it finds the file .\project\Goop Tools\Rename Goop Class.vi, it will create the menu item Tools/GOOP Tools/Rename GOOP Class.

==Menu Naming method==
Here is where a twist is thrown into the naming rules. You can override the names of the VIs, .chm and .hlp files, folders and LLBs so that they are named differently in the menu structure from their names on disk. For VIs, LabVIEW will use the "Window Title" as the menu name (this is also the VI Server VI:Front Panel Window:Title property). But, by placing a text file with the identical root name (RootName.vi, RootName.txt) in the same location as the folder or file, you can specify the name LabVIEW should use in the menus. The name you wish to use in the menu should be placed in the text file. For example, if you have a VI called MyBuggyCode.vi, you can make the menu item show up as Elegant Solution by creating a text file called MyBuggyCode.txt that contains the contents "Elegant Solution" and placing it in the same directory as MyBuggyCode.vi.

Note that this override method works for LLBs, folders, .hlp, and .chm files, but for .hlp and .chm files you must also add the characters ".hlp" or ".chm" after the menu item name in the overriding text file. The file MyCHM.chm should have an override text file called MyCHM.txt that contains the contents "All The Help You Need.chm" This will cause its menu name to be "All The Help You Need".

==Autorun==
How does the developer use this feature, whereby they can open VIs and help files from the menu? VIs placed in the Tools menu (.\project folder) should always be set to "Run When Opened". This will cause them to look and feel like a functional dialog or tool once they are opened after being selected from the menu.

==Notes==
The .\wizard (Files) VIs don't show up in Project windows.

==Get calling VI==
{|class="wikitable" style="margin: 1em auto 1em auto" border="1" cellpadding="0" cellspacing="0"
|+
! Private Feature Exposed
|-
| There is a private VI server method called Application:Menu Launch VI may be found exposed on the diagram of the "Web Publishing Tool" (.\project\webdoc.llb\_Web Document Tool.vi) this property returns the last VI to call a "Tools" menu VI (it doesn't work for "Help" menu), but returns it only once then returns a null string until another "Tools" menu VI is selected from the menu. Use this feature to create a tool that operates on the VI that the user launched it from, like "Check into Source Code Control", or something similar. Unfortunately this does not work for the File (.\wizard) or Help (.\help) menus.
|}


[[Category:Development environment]]

How to do Menu Launch VIs

2012-10-18T19:06:25Z

Tcplomp: /* Notes */

LabVIEW provides a mechanism, which allows the user to open VIs and help files by selecting them from the Tools and Help pull-down menus. This is a very powerful feature for development tools creation, so I will describe how this works. When LabVIEW starts up it does several things, which include initializing the menus. This is a process where LabVIEW looks for files within specific directories for inclusion in the menus.

[u]Menu Launch Folders:[/u]

* .\wizard - File menu-launch
* .\project - Tools menu-launch
* .\help - Help menu-launch

The .\wizard, .\project, and .\help folders are intrinsically related to the "File", "Tools", and "Help" menus, respectively. When you install a LabVIEW add-on, you will notice that new menu items are usually added to these two menus. This was achieved by adding files to the .\project and .\help folders. Through a little experimentation the nature of this process has been determined to be the following:

==Technical details==
First, LabVIEW looks in the .\wizard, .\project, and .\help folders for standalone VIs and top-level VIs within LLBs. In the .\help folder, it also looks for .hlp and .chm compiled help files. These files are then opened when selected from the menu. LabVIEW will look recursively through all subfolders and LLBs looking for these files of interest. However, the search will ignore any VIs, folders, or LLBs whose name begins with an underscore ("_") character. When the search finds a file of interest it will create a menu item at a location, which reflects where it found it in the directory structure inside the project or help folder. For Example, if it finds the file .\project\Goop Tools\Rename Goop Class.vi, it will create the menu item Tools/GOOP Tools/Rename GOOP Class.

==Menu Naming method==
Here is where a twist is thrown into the naming rules. You can override the names of the VIs, .chm and .hlp files, folders and LLBs so that they are named differently in the menu structure from their names on disk. For VIs, LabVIEW will use the "Window Title" as the menu name (this is also the VI Server VI:Front Panel Window:Title property). But, by placing a text file with the identical root name (RootName.vi, RootName.txt) in the same location as the folder or file, you can specify the name LabVIEW should use in the menus. The name you wish to use in the menu should be placed in the text file. For example, if you have a VI called MyBuggyCode.vi, you can make the menu item show up as Elegant Solution by creating a text file called MyBuggyCode.txt that contains the contents "Elegant Solution" and placing it in the same directory as MyBuggyCode.vi.

Note that this override method works for LLBs, folders, .hlp, and .chm files, but for .hlp and .chm files you must also add the characters ".hlp" or ".chm" after the menu item name in the overriding text file. The file MyCHM.chm should have an override text file called MyCHM.txt that contains the contents "All The Help You Need.chm" This will cause its menu name to be "All The Help You Need".

==Autorun==
How does the developer use this feature, whereby they can open VIs and help files from the menu? VIs placed in the Tools menu (.\project folder) should always be set to "Run When Opened". This will cause them to look and feel like a functional dialog or tool once they are opened after being selected from the menu.

==Notes==
The .\wizard (Files) VIs don't show up in Project windows.

==Get calling VI==
{|class="wikitable" style="margin: 1em auto 1em auto" border="1" cellpadding="0" cellspacing="0"
|+
! Private Feature Exposed
|-
| There is a private VI server method called Application:Menu Launch VI may be found exposed on the diagram of the "Web Publishing Tool" (.\project\webdoc.llb\_Web Document Tool.vi) this property returns the last VI to call a "Tools" menu VI (it doesn't work for "Help" menu), but returns it only once then returns a null string until another "Tools" menu VI is selected from the menu. Use this feature to create a tool that operates on the VI that the user launched it from, like "Check into Source Code Control", or something similar. Unfortunately this does not work for the File (.\wizard) or Help (.\help) menus.
|}


[[Category:Development environment]]

How to do Menu Launch VIs

2012-10-18T19:06:01Z

Tcplomp:

LabVIEW provides a mechanism, which allows the user to open VIs and help files by selecting them from the Tools and Help pull-down menus. This is a very powerful feature for development tools creation, so I will describe how this works. When LabVIEW starts up it does several things, which include initializing the menus. This is a process where LabVIEW looks for files within specific directories for inclusion in the menus.

[u]Menu Launch Folders:[/u]

* .\wizard - File menu-launch
* .\project - Tools menu-launch
* .\help - Help menu-launch

The .\wizard, .\project, and .\help folders are intrinsically related to the "File", "Tools", and "Help" menus, respectively. When you install a LabVIEW add-on, you will notice that new menu items are usually added to these two menus. This was achieved by adding files to the .\project and .\help folders. Through a little experimentation the nature of this process has been determined to be the following:

==Technical details==
First, LabVIEW looks in the .\wizard, .\project, and .\help folders for standalone VIs and top-level VIs within LLBs. In the .\help folder, it also looks for .hlp and .chm compiled help files. These files are then opened when selected from the menu. LabVIEW will look recursively through all subfolders and LLBs looking for these files of interest. However, the search will ignore any VIs, folders, or LLBs whose name begins with an underscore ("_") character. When the search finds a file of interest it will create a menu item at a location, which reflects where it found it in the directory structure inside the project or help folder. For Example, if it finds the file .\project\Goop Tools\Rename Goop Class.vi, it will create the menu item Tools/GOOP Tools/Rename GOOP Class.

==Menu Naming method==
Here is where a twist is thrown into the naming rules. You can override the names of the VIs, .chm and .hlp files, folders and LLBs so that they are named differently in the menu structure from their names on disk. For VIs, LabVIEW will use the "Window Title" as the menu name (this is also the VI Server VI:Front Panel Window:Title property). But, by placing a text file with the identical root name (RootName.vi, RootName.txt) in the same location as the folder or file, you can specify the name LabVIEW should use in the menus. The name you wish to use in the menu should be placed in the text file. For example, if you have a VI called MyBuggyCode.vi, you can make the menu item show up as Elegant Solution by creating a text file called MyBuggyCode.txt that contains the contents "Elegant Solution" and placing it in the same directory as MyBuggyCode.vi.

Note that this override method works for LLBs, folders, .hlp, and .chm files, but for .hlp and .chm files you must also add the characters ".hlp" or ".chm" after the menu item name in the overriding text file. The file MyCHM.chm should have an override text file called MyCHM.txt that contains the contents "All The Help You Need.chm" This will cause its menu name to be "All The Help You Need".

==Autorun==
How does the developer use this feature, whereby they can open VIs and help files from the menu? VIs placed in the Tools menu (.\project folder) should always be set to "Run When Opened". This will cause them to look and feel like a functional dialog or tool once they are opened after being selected from the menu.

==Notes==
The /wizard (Files) VIs don't show up in Project windows.

==Get calling VI==
{|class="wikitable" style="margin: 1em auto 1em auto" border="1" cellpadding="0" cellspacing="0"
|+
! Private Feature Exposed
|-
| There is a private VI server method called Application:Menu Launch VI may be found exposed on the diagram of the "Web Publishing Tool" (.\project\webdoc.llb\_Web Document Tool.vi) this property returns the last VI to call a "Tools" menu VI (it doesn't work for "Help" menu), but returns it only once then returns a null string until another "Tools" menu VI is selected from the menu. Use this feature to create a tool that operates on the VI that the user launched it from, like "Check into Source Code Control", or something similar. Unfortunately this does not work for the File (.\wizard) or Help (.\help) menus.
|}


[[Category:Development environment]]

Associate your own file type with Windows Explorer

2012-10-10T07:28:46Z

Tcplomp: Added 2012 info

{{TOCright}}

== Note about custom file type handing in LabVIEW 8.2 and up ==

In LabVIEW 8.2 an Application event called "OS Open Document" exists, which provides a LabVIEW native way to handle custom file types.

LabVIEW 2009 and 2012 have this event working as well. Other versions needs further testing.

Here is a [[Snippet|snippet]] of code in LabVIEW 2009 that works:

[[Image:OpenDocumentEvent.png]]

 

See [http://lavag.org/topic/4851-associating-my-exe-with-a-specific-file-extension-type/ this LAVA posting] for information.

 

== Guidelines to open your own file type from Windows Explorer ==

When the user double-clicks on a document, the Registration Database is checked for an entry that associates the file extension with a particular application. If an entry does not specify Dynamic Data Exchange (DDE) command, the application specified in the registry is launched. If the registry specifies to use DDE commands, an attemp is made to establish a DDE communication with that application using the application topic. If an application responds to the DDE connection, a DDE Execute command is sent to the application, as specified in the registry. However, if attempts to establish the DDE conversation fail, the specified application is launched and the DDE connection is tried again.

== File associations and LabVIEW ==

LabVIEW registers the file extensions *.vi, *.vit, *.ctl, *.ctt and *.llb in order to open these files when the user double-clicks on them. A LabVIEW standalone application registers file extensions *.vi and *.llb when its configuration file (.ini) contains the line RegisterExtensions? = True. However this allows LabVIEW to open its own files and does not provide a mechanism for your application to open its custom files using registered extensions.

For example, your application reads and writes custom data files to which you consistently give the extension ".myx". One thing you can do is to associate the file extension (no DDE command) to your application. When your application is not running, double-clicking on a .myx file launches your application and you can make a system call to read the command line from which you extract the file name to act upon. Remember that, whatever its extension, LabVIEW first tries to open the command line file to figure out if it is a LabVIEW file that it can open (VI, control or LLB).

Once your application is running, double-clicks on your custom file starts a second instance of your application. This instance detects that there is already an instance running so it sends the command line information to the first instance through a DDE Execute command and terminates. The first instance receives the command line; if there is no VI or LLB paths to open, the command is discarded. Currently, there is no way to recover this command line because you have no access to the application built-in DDE Server. Therefore user double-clicks have no effects when your application is running.

In order to receive DDE Execute commands, you would have to, after having properly registered DDE commands in the registry, implement in your application a DDE Server that responds to the DDE Execute commands sent by the system. Unfortunately, altough LabVIEW DDE Client palette offers a DDE Execute.vi that can be used to send commands to other application to open files, the DDE Execute server function is not supported. Such a function would allow to receive the commands sent from the system on user double-clicks (or other applications DDE clients).

DDE being a legacy from Windows 16 bits OS, it is a fading out inter-application communication mechanism. In the latest version of LabVIEW, DDE VIs are still supported but have disappeared from the default palette. Therefore it is very unlikely that DDE VIs will ever be enhanced to support DDE Execute function. One could write a DLL that fully supports DDE, but given the obsolescence of the mechanism, it would be a waste of time.

There are alternatives that we can use to emulate in part the file opening from the file system. The workaround to DDE is to have another executable intercept the command line each time your files are double-clicked on, transmit it to your application and terminate. I will describe three ways below but first let's see how you can register custom file extensions.

== Register a File Extension ==

You register file extensions in Windows Registration Database running the regedit.exe application with a text file that contains the keys and values to register. For example, if you want to open .myx extensions with the application myx.exe (or myx.bat or other executable files) located in c:\myx directory, you create the file myx.reg with the following lines:

[code]

REGEDIT

HKEY_CLASSES_ROOT\.myx = myxfile

HKEY_CLASSES_ROOT\myxfile = My Custom Data File

HKEY_CLASSES_ROOT\myxfile\shell\open\command = c:\myx\myx.exe "%1"

[/code]

You register the file association from your application using System Exec.vi with the input string

[code]"regedit.exe /s c:\myx\myx.reg"[/code]

Alternatively to the use of regedit.exe, LabVIEW 6 is now distributed with VIs to edit the registry. Registry edition VIs for previous versions of LabVIEW are also available at http://www.mhst.de/support.html, more specifically here: [http://www.mhst.de/downloads/winregistry.zip Windows 95/NT Registry VIs].

== Associate the extension to a DOS batch file. ==

A simple way is to associate your file extension to a DOS batch file that writes the command line argument to a text file. The file myx.bat contains the following lines:

[code]

ECHO %1 > c:\myx\myx.txt

START c:\myx\myx.vi

[/code]

On file double-click, the batch file executes. The first line of the batch file writes the DOS 8.3 file path/name to the file myx.txt (previous file content is overwritten). The second line starts the VI myx.vi. Provided that your application is currently associated to .vi extension (RegisterExtensions = True in its ini file), your application will load myx.vi. The VI myx.vi (set to run when opened) should read the myx.txt file to extract the name of the file to open. If your application is already running, it can now be notified by myx.vi that a file has been double-clicked in the file system. If your application was not running, only myx.vi will be loaded and run; the application Top Level VIs are not loaded therefore myx.vi should check for your main Top Level VIs and load/run them if necessary to properly launch your application. The batch files terminates immediately after the start command and is ready for the next double-click. It is preferable to set the batch file properties to run minimized and close when finished. The long Windows path of the file can be obtained with the VI "GetLongPathName?.vi" included in the sample code below.

You will agree that sending a file name to your application using a DOS batch file and a text file for data tranfer is not state-of-the-art programming, using techniques older than DDE itself. The following methods use the same principle but allows to send the file name to your application using ActiveX, VI Server or TCP/IP.

== Create your LVShellOpen.exe executable. ==

Instead of a batch file, one can use a small LabVIEW executable (let's say LVShellOpen.exe) to be associated with your file extension. Normally, when a LabVIEW executable is launched with a file path on the command line, it attempts to open the file to check if it is a LabVIEW file (VI) it can execute. To prevent this and speed up the process a little, the registry command can be modified to included a command line switch such as

[code]HKEY_CLASSES_ROOT\myxfile\shell\open\command = c:\myx\LVShellOpen.exe - o"%1"[/code]

Since the executable does not recognize a file path or a known switch on the command line, it ignores it. This has also the advantage that if you want to implement other file system commands LVShellOpen can distinguish them if different switches are used. For example, a second command Print could be registered as

[code]HKEY_CLASSES_ROOT\myxfile\shell\print\command = c:\myx\LVShellOpen.exe -p"%1"[/code]

When lauched after a double-click, LVShellOpen launches your application if it is not already running, sends the (Windows Long) file path to open and quits immediatly, ready for the next double-click.

The mode of communication to transmit the file path from LVShellOpen to your application is up to your choice. VI Server or TCP/IP are good options (why not DDE?). When LVShellOpen awakes after a double-click, it attemps to establish a connection with your application (you have enabled the VI Server or run a TCP/IP Listener). If connection succeeds, the file path read from the command line is sent to your application. The connection is closed and LVShellOpen exits. If the connection fails, your application is launched using a System Exec.vi call. LVShellOpen can include the file path on the command line and let the application open the file from its command line or alternatively it can wait for the activation of the VI Server or the TCP/IP Listener to transmit the file path before exiting.

== Visual Basic Script* and LabVIEW ActiveX Server. ==

LabVIEW and executables created with the Application Builder have a built-in ActiveX VI Server. By default, the ActiveX server is not enable in the application builder settings. On the "App Settings" tab of the Application Builder, check the box "Enable ActiveX server" and give an appropriate name to your application server.

It is possible with a simple Visual Basic Script (vbscript) to call LabVIEW VIs using the ActiveX VI Server. Making the file association to the vbscript, this one can easily call one of your VIs to transmit the file path on double-clicks from the user. Opening a connection to ActiveX VI Server automatically starts your application (running Top Level VIs) if it is not already running. The script then makes a call to a VI (included as dynamic VI) that fills a front panel string of the VI with the file path.

This technique does not require to build a separate application and thus can be used with all LabVIEW releases. By making the whole code reentrant it is possible for the user to select multiple files and to open them simultaneously.

This is the technique I recommend the most.

Download Sample Code for VBScript and ActiveX.

"*To run a vbscript, you do not need Visual Basic but the Windows Script Host component which is included in all but the oldest versions of Windows and Internet Explorer."

== Conclusion ==

In conclusion it is possible with some workarounds to manage custom file extensions in a LabVIEW application. However, a built-in LabVIEW feature to implement such interaction with Windows is, to my opinion, highly desirable. If you feel the same way, please add weight to my request for this feature on the LabVIEW Wish List and fill out the LabVIEW Feedback Form

[[Category:Building executables]]

Mercurial

2012-08-23T17:21:16Z

Tcplomp: /* Adjust */

= Introduction =

{{TOCright}}[[Image:Logo.Mercurial.png|right]]

Mercurial is a [[Source Code Control|Source Code Control]] system by Selenic, it's key feature is the distributed nature of the system. This means that changes (commits) are stored in a local repository, which can be sent (pushed) to a central repository and which can be downloaded (pulled) by others.

= Getting started =

Joel Spolsky has written a How-To and Why-To page called [http://Www.hginit.com HG init] (hg is the chemical symbol for Mercury).

= Configuration =

Mercurial stores it's setting in a file called 'hgrc' inside a hidden folder '.hg'

== Setting up LVMerge ==

[http://zone.ni.com/reference/en-XX/help/371361F-01/lvhowto/configmerge_thirdparty/ LVMerge] can be used by Mercurial as a Merge tool. Add the following text to the hgrc file:
<pre>[merge-tools]
LVMerge.args = $base $other $local $output
LVMerge.executable = C:\Program Files\National Instruments\Shared\LabVIEW Merge\LVMerge.exe
LVMerge.gui = True
LVMerge.binary = True
[merge-patterns]
**.vi = LVMerge
**.ctl = LVMerge
**.lvclass = LVMerge
**.xctl = LVMerge
**.lvlib =LVMerge
</pre>

You can now use TortoiseHG to perfrom a merge ([[Merge with TortoiseHG|How-To]])

[[Category:SCC]]

== Setting up LVDiff ==

[http://meta-diff.sourceforge.net/ LVDiff] is a software package that uses the built in diff-functionality from LabVIEW to do command line based LVDiffs.

=== Download ===

First thing is to [http://meta-diff.sourceforge.net/ download] LVDiff, copy the contents of the zip-file to a location where you have writing priviliges (lvdiff uses a local ini file). 
Alternative: Installer from [http://decibel.ni.com/content/groups/mercurial NI Community Mercurial User Group]

=== Adjust ===

Then you need to open up the lvdiff.vi and implement these changes.

[[Image:Lvdiffcopy.png]]

This snippet (the actual code inside lvdiff copy is shown) tests if the filenames are the same and if that's the case it calls a VI called lvdiffcopy, which creates a copy of the file2.
For LabVIEW 2011 (and up) a patch file is available, use this to replace lvdiff.vi in the lvdiff installer folder[[File:Lvdiff_2011_patch.vi|lvdiff 2011 patch]].

=== Configure ===

To be able to select lvdiff as the diff tool you need to add teh follwoing settings to the [merge-tools] section of the hgrc configuration file:
<pre>lvdiff.diffargs = $child $parent
lvdiff.executable =C:\Program Files\lvdiff\lvdiff.exe
lvdiff.gui = True
lvdiff.binary = True
</pre>

If you are using TortoiseHg 1.0 or later, you can add a [diff-patterns] section to your hgrc file, analogous to the merge-patterns section mentioned above. This will enable automatic selection of the visual diff tool (see [http://tortoisehg.bitbucket.org/manual/1.0/common.html#word-diffs]):
<pre>
[diff-patterns]
**.vi = lvdiff
**.ctl = lvdiff
**.lvclass = lvdiff
**.xctl = lvdiff
**.lvlib = lvdiff
</pre>

=== Start LVDiff ===

You can start lvdiff in TorsoiseHg in the 'commit' dialog with right-click and 'Visual Diff':

[[Image:StartVisualDiff.png]]

In the following dialog, select 'LVDiff' and double click on the VI to diff:

[[Image:HG_LVDIffStart.png]]

After this LVdiff will launch LabVIEW and both VI (current and committed) will be compared.

== Ignoring files ==

Mercurial stores general ignore patterns in a file called '.hgignore' in the repository root, so you can add the patterns to the repository. I use the following patterns
<pre>.ogp$
/built*$
/build*$
.lvlps$
.aliases$
</pre>

=== Globally ignoring files ===
If you're using TortoiseHG you can use a global ignore file, by adding the following in your %profile%\mercurial.ini file:
<pre>
[ui]
...
ignore = %userprofile%\.hgignore
...
</pre>
Next to the mercurial.ini file you create the reference .hgignore file with the contents of your choice ([http://programmer.brettveenstra.com/2010/02/27/mercurial-on-windows-tip-global-ignore-file/ source]).

= Performing a merge =

The following conditions needs to be true to be able to perform a merge:

*All local changes needs to be commited (hg st should only show ?)
*A changeset is pushed by another user to the central repository
*The other changeset is not yet pulled

The merge will try to detect the differences and call LVMerge if necesarry, LVmerge will show four VIs:

*Base, the base VI which was present in the changeset that is the same on both repositories
*Mine, local commited VI
*Their, remote VI with edits from the other user

These are not editable.

*Resulting, this is the VI that will be stored to disc after the merge finalizes. This file can be edited by the user

For each diff LVMerge will give options to use either, 'base', 'mine' or 'their' code.

After the merge the code should be committed and pushed.

Most Mercurial Clients will show a graph with the following layout:

[[Image:MergeTrackHG.png|border]]

Here's the same graph from the 'other' user, which actually performed the merge:

[[Image:MergeTrackHG_Other.png|border]]

Here you see the opposite actions, two changesets in the local repo and one in the remote. Only difference is the moment of branching.

= Mercurial clients =

On Windows[[Image:Logo.Windows.png]], Mac[[Image:Logo.Mac.png]] and  Linux [[Image:Logo.Linux.png]], there is a command line client called 'hg'. On windows there is a context menu tool called [http://tortoisehg.bitbucket.org TortoiseHG] based on the popular TortoiseSVN and TortoiseCVS tools

= External Links =

*[http://mercurial.selenic.com Official website]
*[http://www.hginit.com HG Init]
*[http://hgbook.red-bean.com/ Mercurial: The Definitive Guide]
*[http://redline6561.livejournal.com/362393.html Setting Up Mercurial with Apache]
*[http://kiln.stackexchange.com Kiln / Mercurial Knowledge site]
*[http://decibel.ni.com/content/groups/mercurial NI Community Mercurial User Group]

[[Category:SCC]]
[[Category:SCC]]

[[Category:SCC]]
[[Category:SCC]]

Mercurial

2012-08-23T17:19:08Z

Tcplomp: /* Adjust */ Added lvdiff patch

= Introduction =

{{TOCright}}[[Image:Logo.Mercurial.png|right]]

Mercurial is a [[Source Code Control|Source Code Control]] system by Selenic, it's key feature is the distributed nature of the system. This means that changes (commits) are stored in a local repository, which can be sent (pushed) to a central repository and which can be downloaded (pulled) by others.

= Getting started =

Joel Spolsky has written a How-To and Why-To page called [http://Www.hginit.com HG init] (hg is the chemical symbol for Mercury).

= Configuration =

Mercurial stores it's setting in a file called 'hgrc' inside a hidden folder '.hg'

== Setting up LVMerge ==

[http://zone.ni.com/reference/en-XX/help/371361F-01/lvhowto/configmerge_thirdparty/ LVMerge] can be used by Mercurial as a Merge tool. Add the following text to the hgrc file:
<pre>[merge-tools]
LVMerge.args = $base $other $local $output
LVMerge.executable = C:\Program Files\National Instruments\Shared\LabVIEW Merge\LVMerge.exe
LVMerge.gui = True
LVMerge.binary = True
[merge-patterns]
**.vi = LVMerge
**.ctl = LVMerge
**.lvclass = LVMerge
**.xctl = LVMerge
**.lvlib =LVMerge
</pre>

You can now use TortoiseHG to perfrom a merge ([[Merge with TortoiseHG|How-To]])

[[Category:SCC]]

== Setting up LVDiff ==

[http://meta-diff.sourceforge.net/ LVDiff] is a software package that uses the built in diff-functionality from LabVIEW to do command line based LVDiffs.

=== Download ===

First thing is to [http://meta-diff.sourceforge.net/ download] LVDiff, copy the contents of the zip-file to a location where you have writing priviliges (lvdiff uses a local ini file). 
Alternative: Installer from [http://decibel.ni.com/content/groups/mercurial NI Community Mercurial User Group]

=== Adjust ===

Then you need to open up the lvdiff.vi and implement these changes.

[[Image:Lvdiffcopy.png]]

This snippet (the actual code inside lvdiff copy is shown) tests if the filenames are the same and if that's the case it calls a VI called lvdiffcopy, which creates a copy of the file2.
For LabVIEW 2011 (and up) a patch file is available, use this to replace lvdiff.vi in the lvdiff installer folder[[File:Lvdiff_2011_patch.vi]].

=== Configure ===

To be able to select lvdiff as the diff tool you need to add teh follwoing settings to the [merge-tools] section of the hgrc configuration file:
<pre>lvdiff.diffargs = $child $parent
lvdiff.executable =C:\Program Files\lvdiff\lvdiff.exe
lvdiff.gui = True
lvdiff.binary = True
</pre>

If you are using TortoiseHg 1.0 or later, you can add a [diff-patterns] section to your hgrc file, analogous to the merge-patterns section mentioned above. This will enable automatic selection of the visual diff tool (see [http://tortoisehg.bitbucket.org/manual/1.0/common.html#word-diffs]):
<pre>
[diff-patterns]
**.vi = lvdiff
**.ctl = lvdiff
**.lvclass = lvdiff
**.xctl = lvdiff
**.lvlib = lvdiff
</pre>

=== Start LVDiff ===

You can start lvdiff in TorsoiseHg in the 'commit' dialog with right-click and 'Visual Diff':

[[Image:StartVisualDiff.png]]

In the following dialog, select 'LVDiff' and double click on the VI to diff:

[[Image:HG_LVDIffStart.png]]

After this LVdiff will launch LabVIEW and both VI (current and committed) will be compared.

== Ignoring files ==

Mercurial stores general ignore patterns in a file called '.hgignore' in the repository root, so you can add the patterns to the repository. I use the following patterns
<pre>.ogp$
/built*$
/build*$
.lvlps$
.aliases$
</pre>

=== Globally ignoring files ===
If you're using TortoiseHG you can use a global ignore file, by adding the following in your %profile%\mercurial.ini file:
<pre>
[ui]
...
ignore = %userprofile%\.hgignore
...
</pre>
Next to the mercurial.ini file you create the reference .hgignore file with the contents of your choice ([http://programmer.brettveenstra.com/2010/02/27/mercurial-on-windows-tip-global-ignore-file/ source]).

= Performing a merge =

The following conditions needs to be true to be able to perform a merge:

*All local changes needs to be commited (hg st should only show ?)
*A changeset is pushed by another user to the central repository
*The other changeset is not yet pulled

The merge will try to detect the differences and call LVMerge if necesarry, LVmerge will show four VIs:

*Base, the base VI which was present in the changeset that is the same on both repositories
*Mine, local commited VI
*Their, remote VI with edits from the other user

These are not editable.

*Resulting, this is the VI that will be stored to disc after the merge finalizes. This file can be edited by the user

For each diff LVMerge will give options to use either, 'base', 'mine' or 'their' code.

After the merge the code should be committed and pushed.

Most Mercurial Clients will show a graph with the following layout:

[[Image:MergeTrackHG.png|border]]

Here's the same graph from the 'other' user, which actually performed the merge:

[[Image:MergeTrackHG_Other.png|border]]

Here you see the opposite actions, two changesets in the local repo and one in the remote. Only difference is the moment of branching.

= Mercurial clients =

On Windows[[Image:Logo.Windows.png]], Mac[[Image:Logo.Mac.png]] and  Linux [[Image:Logo.Linux.png]], there is a command line client called 'hg'. On windows there is a context menu tool called [http://tortoisehg.bitbucket.org TortoiseHG] based on the popular TortoiseSVN and TortoiseCVS tools

= External Links =

*[http://mercurial.selenic.com Official website]
*[http://www.hginit.com HG Init]
*[http://hgbook.red-bean.com/ Mercurial: The Definitive Guide]
*[http://redline6561.livejournal.com/362393.html Setting Up Mercurial with Apache]
*[http://kiln.stackexchange.com Kiln / Mercurial Knowledge site]
*[http://decibel.ni.com/content/groups/mercurial NI Community Mercurial User Group]

[[Category:SCC]]
[[Category:SCC]]

[[Category:SCC]]
[[Category:SCC]]

File:Lvdiff 2011 patch.vi

2012-08-23T17:16:21Z

Tcplomp: Patch file for lvdiff and LabVIEW 2011

Patch file for lvdiff and LabVIEW 2011

XControl

2012-04-21T08:12:34Z

Tcplomp: Added OptimizeDataUpdate

__NOTOC__

{| border="0" align="right"
|-
| __TOC__
|}

== Introduction ==
XControls are introduced in LabVIEW 8.0 and enhance the power of front panel objects in great ways.

Essentially an XControl is a front panel object with dedicated code linked in to react on certain user events.

An XControl exists of several parts, managed in a .xctl file. The .xctl file is a XML-file like the project-file. Other parts of the XControl are abilities.

== Limitations ==
An XControl functions like a subpanel in the hosting VI. Subpanels (and therefore XControls) ''can not'' be placed inside an array. Note that you ''can'' define your XControl data as an array of any LabVIEW data type, and you ''can'' use array controls in the facade vi.

Using LabVIEW native objects (.lvclass files) inside the state control of an XControl tends to crash LabVIEW for versions less than 8.5.1 when the XControl is used in a different application instance.

== Tricks ==
*If you require a variable number of runtime instances of your XControl, Jarrod Slocum of [[National Instruments]] has created an example [http://community.ni.com/examples/linked-object-list-in-labview-8-0-using-xcontrols Linked Object List] based on a Subpanel ''inside'' an XControl.

*If you want to react to dynamic events (or user events) you need them to register at the XControl Facade '''before''' the event happens.
* If Façade is not executing fast enough to keep up with data updates, it causes the updates to queue up. The updates will happen even after the VI stops running. To reduce data updates:
Thanks to Ram Kudukoli (of NI R&D) for sharing this with us at the recent CLA Summit:

** Open the Xcontrol .xctl file in a text editor like Notepad.
** Add the bolded line shown below:
<Property Name="NI.Lib.Version" Type="Str">1.0.0.0</Property>
<Property Name="NI.XClass.Flags" Type="Int">0</Property>
<Property Name="NI.XCtl.OptimizeDataUpdate" Type="Bool">true</Property>
<Property Name="NI.XItem.DeclaredLeakProof" Type="Bool">false</Property>
** Save the .xctl file.
([http://lavag.org/topic/15680-no-update-on-x-control-value-change/page__view__findpost__p__94838 LAVAG source])

== See also ==
*[[XControl:Properties|Properties]]
*[[XControl:Abilities|Abilities]]
*[[XControl:Methods|Methods]]

[[Category:XControl]]

Merge with TortoiseHG

2012-04-13T12:12:31Z

Tcplomp: Resize

[https://tortoisehg.bitbucket.org TortoiseHG] is a client to [[Mercurial]].

This page will show the steps needed to perfrom a visual merge between two branches of one repository.
Prerequisites:
* Working TortoiseHG
* Configured Merge-Tools
* LabVIEW Professional

We start with a Repository A that has a file 'ToMerge' that contains a string constant with the contents 'Repository A'.This file is committed to Mercurial, we clone the repository to Repository B, and edit the string constant to 'Repository B' and commit the edit.
In repository A we change the constant to 'Repository A edited', save and commit the changes.
In repository B we perform a Pull (since we cloned from repository A we pull per default from repository A).

[[File:HG.MergeBeforeCommit.png]]

This shows the repository B changesets (if you pulled B into A changes 1 and 2 would be switched).
Now the merging begins:
* Rightclick changeset 2 and select 'Merge with local'
The following dialog appears:

[[File:HG.PreparetoMerge.png]]

Click Next>

[[File:HG.Merging.png]]

Click on the underlined word 'Resolved'

[[File:HG.Resolve.png]]

Make sure you do the following things:
# Select the file you want to merge
# Select LVMerge as the MergeTool
# Hit 'Tool Resolve'
This will launch LVMerge, and will show the three versions of the VI together with an editable version of the VI to save the actual Merge Result.
[[File:HG.LVMerge.png|876px|590px]]

Select Close, and LabVIEW will ask if you want to save the edits (you can easily chose yours or theirs versions).

TortoiseHG will return and the file will have moved into the 'Resolved conflichts' list:
[[File:HG.Resolved.png]]

You can edit the resulting file, view the diffferences between the different versions if you want.

Use the close button to finalize the resolve conflicts.
Then you will need to add a comment about the merge, and the merge will be committed to Mercurial.
Make sure you push the merge to Repository A so that is up to date as well.

Here's the result of the merge:

[[File:HG.MergeResult.png]]

[[Category:SCC]]

Merge with TortoiseHG

2012-04-13T12:11:44Z

Tcplomp: Added MergeResult

[https://tortoisehg.bitbucket.org TortoiseHG] is a client to [[Mercurial]].

This page will show the steps needed to perfrom a visual merge between two branches of one repository.
Prerequisites:
* Working TortoiseHG
* Configured Merge-Tools
* LabVIEW Professional

We start with a Repository A that has a file 'ToMerge' that contains a string constant with the contents 'Repository A'.This file is committed to Mercurial, we clone the repository to Repository B, and edit the string constant to 'Repository B' and commit the edit.
In repository A we change the constant to 'Repository A edited', save and commit the changes.
In repository B we perform a Pull (since we cloned from repository A we pull per default from repository A).

[[File:HG.MergeBeforeCommit.png]]

This shows the repository B changesets (if you pulled B into A changes 1 and 2 would be switched).
Now the merging begins:
* Rightclick changeset 2 and select 'Merge with local'
The following dialog appears:

[[File:HG.PreparetoMerge.png]]

Click Next>

[[File:HG.Merging.png]]

Click on the underlined word 'Resolved'

[[File:HG.Resolve.png]]

Make sure you do the following things:
# Select the file you want to merge
# Select LVMerge as the MergeTool
# Hit 'Tool Resolve'
This will launch LVMerge, and will show the three versions of the VI together with an editable version of the VI to save the actual Merge Result.
[[File:HG.LVMerge.png|584px|393px]]

Select Close, and LabVIEW will ask if you want to save the edits (you can easily chose yours or theirs versions).

TortoiseHG will return and the file will have moved into the 'Resolved conflichts' list:
[[File:HG.Resolved.png]]

You can edit the resulting file, view the diffferences between the different versions if you want.

Use the close button to finalize the resolve conflicts.
Then you will need to add a comment about the merge, and the merge will be committed to Mercurial.
Make sure you push the merge to Repository A so that is up to date as well.

Here's the result of the merge:

[[File:HG.MergeResult.png]]

[[Category:SCC]]

File:HG.MergeResult.png

2012-04-13T12:10:50Z

Tcplomp:

[[Category:SCC]]

File:HG.MergeResult.png

2012-04-13T12:10:31Z

Tcplomp:

Mercurial

2012-04-13T12:08:25Z

Tcplomp: Added How To reference

= Introduction =

{{TOCright}}[[Image:Logo.Mercurial.png|right]]

Mercurial is a [[Source Code Control|Source Code Control]] system by Selenic, it's key feature is the distributed nature of the system. This means that changes (commits) are stored in a local repository, which can be sent (pushed) to a central repository and which can be downloaded (pulled) by others.

= Getting started =

Joel Spolsky has written a How-To and Why-To page called [http://Www.hginit.com HG init] (hg is the chemical symbol for Mercury).

= Configuration =

Mercurial stores it's setting in a file called 'hgrc' inside a hidden folder '.hg'

== Setting up LVMerge ==

[http://zone.ni.com/reference/en-XX/help/371361F-01/lvhowto/configmerge_thirdparty/ LVMerge] can be used by Mercurial as a Merge tool. Add the following text to the hgrc file:
<pre>[merge-tools]
LVMerge.args = $base $other $local $output
LVMerge.executable = C:\Program Files\National Instruments\Shared\LabVIEW Merge\LVMerge.exe
LVMerge.gui = True
LVMerge.binary = True
[merge-patterns]
**.vi = LVMerge
**.ctl = LVMerge
**.lvclass = LVMerge
**.xctl = LVMerge
**.lvlib =LVMerge
</pre>

You can now use TortoiseHG to perfrom a merge ([[Merge with TortoiseHG|How-To]])

[[Category:SCC]]

== Setting up LVDiff ==

[http://meta-diff.sourceforge.net/ LVDiff] is a software package that uses the built in diff-functionality from LabVIEW to do command line based LVDiffs.

=== Download ===

First thing is to [http://meta-diff.sourceforge.net/ download] LVDiff, copy the contents of the zip-file to a location where you have writing priviliges (lvdiff uses a local ini file). 
Alternative: Installer from [http://decibel.ni.com/content/groups/mercurial NI Community Mercurial User Group]

=== Adjust ===

Then you need to open up the lvdiff.vi and implement these changes.

[[Image:Lvdiffcopy.png]]

This snippet (the actual code inside lvdiff copy is shown) tests if the filenames are the same and if that's the case it calls a VI called lvdiffcopy, which creates a copy of the file2.

=== Configure ===

To be able to select lvdiff as the diff tool you need to add teh follwoing settings to the [merge-tools] section of the hgrc configuration file:
<pre>lvdiff.diffargs = $child $parent
lvdiff.executable =C:\Program Files\lvdiff\lvdiff.exe
lvdiff.gui = True
lvdiff.binary = True
</pre>

If you are using TortoiseHg 1.0 or later, you can add a [diff-patterns] section to your hgrc file, analogous to the merge-patterns section mentioned above. This will enable automatic selection of the visual diff tool (see [http://tortoisehg.bitbucket.org/manual/1.0/common.html#word-diffs]):
<pre>
[diff-patterns]
**.vi = lvdiff
**.ctl = lvdiff
**.lvclass = lvdiff
**.xctl = lvdiff
**.lvlib = lvdiff
</pre>

=== Start LVDiff ===

You can start lvdiff in TorsoiseHg in the 'commit' dialog with right-click and 'Visual Diff':

[[Image:StartVisualDiff.png]]

In the following dialog, select 'LVDiff' and double click on the VI to diff:

[[Image:HG_LVDIffStart.png]]

After this LVdiff will launch LabVIEW and both VI (current and committed) will be compared.

== Ignoring files ==

Mercurial stores general ignore patterns in a file called '.hgignore' in the repository root, so you can add the patterns to the repository. I use the following patterns
<pre>.ogp$
/built*$
/build*$
.lvlps$
.aliases$
</pre>

=== Globally ignoring files ===
If you're using TortoiseHG you can use a global ignore file, by adding the following in your %profile%\mercurial.ini file:
<pre>
[ui]
...
ignore = %userprofile%\.hgignore
...
</pre>
Next to the mercurial.ini file you create the reference .hgignore file with the contents of your choice ([http://programmer.brettveenstra.com/2010/02/27/mercurial-on-windows-tip-global-ignore-file/ source]).

= Performing a merge =

The following conditions needs to be true to be able to perform a merge:

*All local changes needs to be commited (hg st should only show ?)
*A changeset is pushed by another user to the central repository
*The other changeset is not yet pulled

The merge will try to detect the differences and call LVMerge if necesarry, LVmerge will show four VIs:

*Base, the base VI which was present in the changeset that is the same on both repositories
*Mine, local commited VI
*Their, remote VI with edits from the other user

These are not editable.

*Resulting, this is the VI that will be stored to disc after the merge finalizes. This file can be edited by the user

For each diff LVMerge will give options to use either, 'base', 'mine' or 'their' code.

After the merge the code should be committed and pushed.

Most Mercurial Clients will show a graph with the following layout:

[[Image:MergeTrackHG.png|border]]

Here's the same graph from the 'other' user, which actually performed the merge:

[[Image:MergeTrackHG_Other.png|border]]

Here you see the opposite actions, two changesets in the local repo and one in the remote. Only difference is the moment of branching.

= Mercurial clients =

On Windows[[Image:Logo.Windows.png]], Mac[[Image:Logo.Mac.png]] and  Linux [[Image:Logo.Linux.png]], there is a command line client called 'hg'. On windows there is a context menu tool called [http://tortoisehg.bitbucket.org TortoiseHG] based on the popular TortoiseSVN and TortoiseCVS tools

= External Links =

*[http://mercurial.selenic.com Official website]
*[http://www.hginit.com HG Init]
*[http://hgbook.red-bean.com/ Mercurial: The Definitive Guide]
*[http://redline6561.livejournal.com/362393.html Setting Up Mercurial with Apache]
*[http://kiln.stackexchange.com Kiln / Mercurial Knowledge site]
*[http://decibel.ni.com/content/groups/mercurial NI Community Mercurial User Group]

[[Category:SCC]]
[[Category:SCC]]

[[Category:SCC]]
[[Category:SCC]]

Merge with TortoiseHG

2012-04-13T12:06:22Z

Tcplomp: Redone layout

[https://tortoisehg.bitbucket.org TortoiseHG] is a client to [[Mercurial]].

This page will show the steps needed to perfrom a visual merge between two branches of one repository.
Prerequisites:
* Working TortoiseHG
* Configured Merge-Tools
* LabVIEW Professional

We start with a Repository A that has a file 'ToMerge' that contains a string constant with the contents 'Repository A'.This file is committed to Mercurial, we clone the repository to Repository B, and edit the string constant to 'Repository B' and commit the edit.
In repository A we change the constant to 'Repository A edited', save and commit the changes.
In repository B we perform a Pull (since we cloned from repository A we pull per default from repository A).

[[File:HG.MergeBeforeCommit.png]]

This shows the repository B changesets (if you pulled B into A changes 1 and 2 would be switched).
Now the merging begins:
* Rightclick changeset 2 and select 'Merge with local'
The following dialog appears:

[[File:HG.PreparetoMerge.png]]

Click Next>

[[File:HG.Merging.png]]

Click on the underlined word 'Resolved'

[[File:HG.Resolve.png]]

Make sure you do the following things:
# Select the file you want to merge
# Select LVMerge as the MergeTool
# Hit 'Tool Resolve'
This will launch LVMerge, and will show the three versions of the VI together with an editable version of the VI to save the actual Merge Result.
[[File:HG.LVMerge.png|584px|393px]]

Select Close, and LabVIEW will ask if you want to save the edits (you can easily chose yours or theirs versions).

TortoiseHG will return and the file will have moved into the 'Resolved conflichts' list:
[[File:HG.Resolved.png]]

You can edit the resulting file, view the diffferences between the different versions if you want.

Use the close button to finalize the resolve conflicts.
Then you will need to add a comment about the merge, and the merge will be committed to Mercurial.
Make sure you push the merge to Repository A so that is up to date as well.

[[Category:SCC]]

Merge with TortoiseHG

2012-04-13T11:59:09Z

2010-09-20T19:44:26Z

Tcplomp:

{{TOCright}}

 

== Introduction ==

[[Image:Code Capture Tool GUI FP Halfsize.png|left]]The Code Capture Tool (or CCT) is a [[LabVIEW]] development tool targeted at LabVIEW users to capture images of their code and make it easier to share those images in online forums. 

=== Main Features ===

*Captures of Front Panel
*Captures of Block Diagram
*Comment an Annotate your caputre
*Creation of LabVIEW Snippets in any LabVIEW version
*Save the snippet as anoter (older) version
*Upload the capture to [http://www.imgur.com Imgur.com] and copy the URL to he clipboard

=== History ===

The CCT is based on an idea and earlier versions originally released by [http://forums.ni.com/ni/profile?user.id=34024 Chilly Charly] on the [[NI Forums]] as [http://forums.ni.com/ni/board/message?board.id=BreakPoint&thread.id=1020 starware]. Later, it evolved to a multiple OS and LabVIEW versions tool for creating code-shots and documentation shots. A collaboration between [http://forums.lavag.org/Yair-m1431.html Yair Neeman] and [[User:Tcplomp|Ton Plomp]] resulted in the 1.0 version of the CCT that is currently available through the [[LAVA CR]] at [http://forums.lavag.org/downloads-file121.html this site].

Version 2.0 added the possibility to add text and drawings to the captured image, while version 2.1 added an altered GUI, a border around the snippet and better key-handling. Version 2.1.2 added the option upload the image to Imgur.com and save the snippet in an older version. 

== Instruction ==

A series of videos is available at [http://www.screencast.com/t/ZmQ1YjIxNj Screencast].

A short how to is in the [http://www.screencast.com/t/2aWPdibJ9Sk here available]

An extensive discussion and demo of the CCT is [http://www.screencast.com/t/Yhb9IAOc here]. 

Version 2.0 introduces a new option to create annotations with text and graphics and the possibility to create [[Snippet|snippets]]. There is a demo-video available at [http://www.screencast.com/t/YTY4MjllZmIt Screencast].

== Download ==



Click [http://lavag.org/index.php?app=downloads&showfile=63 here] to download the tool.

To check the source you can explore your ''<user.lib>\_Code Capture Too''l folder or download it from [http://lv-cct-tool.svn.sourceforge.net/viewvc/lv-cct-tool Sourceforge.net]. 

= Interface =

The CCT offers two interfaces to make and distribute images of LabVIEW code - a [[Code Capture Tool#GUI|user interface]] and an [[Code Capture Tool#API|API]].

== GUI ==

The user interface of the CCT allows the user to select which parts of a [[Front Panel]] or [[Block Diagram]] should be captured. The resulting image will be stored on disc and optionally the image or the path can be copied to the OS clipboard.

[[Image:CCT GUI.png|frame|center|Code Capture Tool user interface]]

=== Front panel settings ===

The Front Panel listbox supplies the following options:

{| class="wikitable"
|-
! Listbox
! Item
! Captured parts
|-
| rowspan="4" | [[Image:CCT FP.png]]
| None
| Nothing
|-
| Selected
| All selected parts and items in between
|-
| Visible
| Everything visible in the current panel view
|-
| All
| Everything on the front panel
|}

=== Block diagram settings ===

The Block Diagram listbox supplies the following options:

{| class="wikitable"
|-
! Listbox
! Item
! Captured parts
|-
| rowspan="4" | [[Image:CCT BD.png]]
| None
| Nothing
|-
| Selected
| All selected parts and items in between
|-
| Visible
| Everything visible in the current block diagram view
|-
| All
| Everything on the block diagram
|}

==== Snippet Creation ====

The creation of a snippet can only be done when the '''Block Diagram''' is set to '''selected'''. 

[[Image:CCTSnippetButtons.png]]

The header-text of the snippet is dynamically and has the following options which are accessible with the config button: 

{| class="wikitable"
|-
! scope="col" | Token 
! scope="col" | Meaning 
|-
| $VERSION$ 
| Inserts the current [[Labview|LabVIEW]] version 
|-
| $NAME$ 
| Name of the captured VI, retrieved from the VI.VI Name property 
|-
| $TITLE$ 
| Title of the front panel of the captured VI 
|-
| $IMAGENAME$ 
| Name of image on disk without the PNG extension 
|-
| $DATE:xxx$ 
| Date/Time formatter, <tt>xxx</tt> must be replaced by a valid [http://zone.ni.com/reference/en-XX/help/371361F-01/glang/codes_for_time_format_str/ timestring formatter] 
|}

Per default the header string is <tt>LV: $VERSION$ $DATE:%c$</tt>, %c inserts the localized date. 

 

=== Clipboard settings ===

The clipboard listbox supplies the following options:

{| class="wikitable"
|-
! Listbox
! Item
! Copied item
! Remarks
|-
| rowspan="3" | [[Image:CCT ClipBoard.png|122x301px]]
| None
| Nothing
|
|-
| Path
| Path of the captured image
| Not on all platforms
|-
| Image
| The captured image
| Only on Windows
|-
| URL
| The URL of the Imgur image
| Selecting this will upload the image to Imgur.com
|}

=== Layout settings ===

The Layout picture ring supplies the following layout options:

{| class="wikitable"
|-
! Menu Ring
! Item
! Description
|-
| rowspan="4" | [[Image:CCT Layout.png]]
| [[Image:CCT Layout1.png]]
| Front panel in top, block diagram below
|-
| [[Image:CCT Layout2.png]]
| Block diagram in top, front panel below
|-
| [[Image:CCT Layout3.png]]
| Front panel in left, block diagram on the right
|-
| [[Image:CCT Layout4.png]]
| Block diagram in left, front panel on the right
|}

=== File settings ===

[[Image:CCT FileSettings.png]]

The file settings consists of two controls, the string control to name the file (a .png extension is added to the name automatically) and a browse button to set the folder where the file should be stored. To detect which folder is currently used hover over one of the two controls and the tip-strip will show the folder.

==== Resetting the folder ====

By default the storage folder is the LabVIEW temp folder (which by default is the same as the OS temp folder), and can be changed with the browse for folder button. To revert to the temp folder use this button [[Image:CCT Reset.png]].

=== Zoom function ===

[[Image:CCT Zoom.png]]

The zoom slider allows the user to zoom in and out on the captured image and inspect it in detail. This only affects the preview image and will not change the stored image.

=== Annotation/Sketch toolbars ===

[[Image:CCTAnnotationOptions.png]]

The annotation/sketch toolbars are used to add annotations and sketches/drawings to the capture. 

==== Drawing tools ====

{| cellspacing="10" cellpadding="2" border="0" align="left" width="407" style=""
|-
| [[Image:AnnotationOptionsRotated.png|left|18x98px]]
|
'''Rectangle:''' Use shift to draw a square 

'''Oval:''' Use shift to draw a circle '''Line:''' Use shift to limit drawing to one axis (X or Y) 

'''Arrow:''' Use shift to limit drawing to one axis (X or Y) '''Free: ''' Use this to draw irregular shapes 

|}

 

 

 

 

 

 

 

==== Drawing Styles ====

[[Image:CCTStylesDetail.png]] The style of the line can be one of 5 styles: 

*Continious
*Dash
*Dot
*Dash-Dot
*Dash-Dot-Dot

 

==== Line width ====

The linewidth of the sketch/drawing line can be alterd as well [[Image:CCT Linewidth.png]] 

==== Line/Text color ====

It's possible to alter the color of the annotation (sketch or text), when editing text changing the line coler takes effect immediatly.

==== Text size ====

The font of the annotation text cannot be altered and is fixed on <tt>Arial </tt>, the size however can be altered easily.

==== Editing tools ====

{| width="50%" cellspacing="2" cellpadding="1" border="0" align="left"
|-
| [[Image:CCT Text.png]] 
| Starts editing text Use shift-enter to add anew-line Use arrow keys to move the positioning of the text around 
|-
| [[Image:CCT Pan.png]] 
| Use this to move the preview window around, this is the default tool of the Annotation Sketch toolbar. It does not change the captured image. 
|-
| [[Image:CCT Undo.png]] 
| Use this to undo the last edit on the annotation/sketch (4 steps possible), use <ctrl-z> on [[Image:Logo.Windows.png]] and [[Image:Logo.Linux.png]] and <cmd-z> on [[Image:Logo.Mac.png]]. 
|-
| [[Image:CCT Clear.png]]
| Clear the annotation layer. 
|}

 

 

 

 

 

 

=== Help ===

The help button [[Image:CCT Help.png]] calls the about window of the CCT including a short description of the main functions, a link to the webpage, a list of know issues and licensing info.

=== Capture ===

The capture button [[Image:CCT Capture.png]] will capture the image, save it, copy to the clipboard, save the currently selected options for the next time and close the window. This can also be done by pressing Enter.

=== Clean up ===

The clean up button [[Image:CCTCleanUp.png]] will clean up the whole BD (if 'whole' is set as BD option) or the current selection (if 'Selections' is set as BD option). This button is only visible if this option is active (correct LabVIEW version).

=== Key navigation ===

The CCT has several key shortcuts for easier access:

{| class="wikitable"
|-
! Key
! Function
|-
| Enter
| Applies the current settings and does a [[Code Capture Tool#Capture|capture]] or finishes a current text edit 
|-
| F1
| Loads the about window centered on the help tab
|-
| F5
| Refreshes the current image
|-
| Escape
| Closes the CCT without performing a capture or finishes a current text/graph edit 
|}

== API ==

The API provides an interface to the various functions of the CCT. Its palette is accessible under [[User.lib]]\Code Capture Tool.

[[Image:CCT palette.PNG]]

{| class="wikitable"
|-
! [[#Methods|Methods]]
| <linkedimage>
img_src=Image:CCT_GetSessions.png
wikipage=Code_Capture_Tool#Create_CCT_Instance
</linkedimage>
| <linkedimage>
img_src=Image:CCT_Capture_icon.png
wikipage=Code_Capture_Tool#Capture_Image
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SaveImage.png
wikipage=Code_Capture_Tool#Save_Image
</linkedimage>
| <linkedimage>
img_src=Image:CCT_CopyToClipboard.png
wikipage=Code_Capture_Tool#Copy_to_Clipboard
</linkedimage>
| 
| <linkedimage>
img_src=Image:CCT_CloseSession.png
wikipage=Code_Capture_Tool#Destroy_CCT_Instance
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GenerateFileName.png
wikipage=Code_Capture_Tool#Generate_File_Name
</linkedimage>
|-
! [[#Set_properties|Set properties]]
| <linkedimage>
img_src=Image:CCT_SetFP.png
wikipage=Code_Capture_Tool#Set_Front_Panel_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SetBD.png
wikipage=Code_Capture_Tool#Set_Block_Diagram_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SetLayout.png
wikipage=Code_Capture_Tool#Set_Layout_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SetClipboard.png
wikipage=Code_Capture_Tool#Set_Clipboard_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SetVI.png
wikipage=Code_Capture_Tool#Set_VI_Ref
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SetFolder.png
wikipage=Code_Capture_Tool#Set_Folder
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SetFileName.png
wikipage=Code_Capture_Tool#Set_Filename
</linkedimage>
|-
! [[#Get_properties|Get properties]]
| <linkedimage>
img_src=Image:CCT_GetFP.png
wikipage=Code_Capture_Tool#Get_Front_Panel_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GetBD.png
wikipage=Code_Capture_Tool#Get_Block_Diagram_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GetLayout.png
wikipage=Code_Capture_Tool#Get_Layout_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GetClipboard.png
wikipage=Code_Capture_Tool#Get_Clipboard_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GetVI.png
wikipage=Code_Capture_Tool#Get_VI_Ref
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GetFolder.png
wikipage=Code_Capture_Tool#Get_Folder
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GetFileName.png
wikipage=Code_Capture_Tool#Get_Filename
</linkedimage>
|-
! [[#Support|Support]]
| <linkedimage>
img_src=Image:CCT_Support.png
wikipage=Code_Capture_Tool#Support
</linkedimage>
| 
| <linkedimage>
img_src=Image:CCT_CaptureFP.png
wikipage=Code_Capture_Tool#Capture_Front_panel
</linkedimage>
| <linkedimage>
img_src=Image:CCT_CaptureBD.png
wikipage=Code_Capture_Tool#Capture_Block_diagram
</linkedimage>
| <linkedimage>
img_src=Image:CCT_ShowGUI.png
wikipage=Code_Capture_Tool#Show_CCT_GUI
</linkedimage>
| <linkedimage>
img_src=Image:CCT_70Container.png
wikipage=Code_Capture_Tool#7.0_container_VI
</linkedimage>
| <linkedimage>
img_src=Image:CCT_80_Container.png
wikipage=Code_Capture_Tool#8.0_container_VI
</linkedimage>
|}

=== Methods ===

{| class="wikitable"
|-
! [[#Methods|Methods]]
| <linkedimage>
img_src=Image:CCT_GetSessions.png
wikipage=Code_Capture_Tool#Create_CCT_Instance
</linkedimage>
| <linkedimage>
img_src=Image:CCT_Capture_icon.png
wikipage=Code_Capture_Tool#Capture_Image
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SaveImage.png
wikipage=Code_Capture_Tool#Save_Image
</linkedimage>
| <linkedimage>
img_src=Image:CCT_CopyToClipboard.png
wikipage=Code_Capture_Tool#Copy_to_Clipboard
</linkedimage>
| <linkedimage>
img_src=Image:CCT_CloseSession.png
wikipage=Code_Capture_Tool#Destroy_CCT_Instance
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GenerateFileName.png
wikipage=Code_Capture_Tool#Generate_File_Name
</linkedimage>
|}

These VIs are used to activate methods for the CCT.

==== Create CCT Instance ====

[[Image:CCT Create CCT.png|Creat CCT Instance]]

This VI must be called for every instance of the CCT, it creates a GOOP dataspace that will contain the data of the instance. Calling this VI must be done with a valid VI reference.

==== Capture Image ====

[[Image:CCT Capture VI Images CCT.png|Capture Images]]

This VI will apply the current settings and store the captured image in the CCT instance, additionally it returns the image itself.

==== Save Image ====

[[Image:CCT Save Captured Image CCT.png|Save Image]]

This VI will save the image to the path specified by a folder and filename stored in the CCT instance.

==== Copy to Clipboard ====

[[Image:CCT Copy Data to Clipboard CCT.png|Copy to Clipboard]]

This VI will store the data specified by the clipboard settings to the clipboard.

==== Destroy CCT Instance ====

[[Image:CCT Destroy CCT.png|Destroy CCT Instance]]

This VI must be called to close the CCT Instance and will free up used memory resources.

==== Generate File Name ====

[[Image:CCT Generate File Name CCT.png|Generate filename]]

This VI will generate a default filename based on the captured parts and VI name. This filename will not be stored inside the CCT session.

=== Set properties ===

{| class="wikitable"
|-
! [[#Set_properties|Set properties]]
| <linkedimage>
img_src=Image:CCT_SetFP.png
wikipage=Code_Capture_Tool#Set_Front_Panel_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SetBD.png
wikipage=Code_Capture_Tool#Set_Block_Diagram_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SetLayout.png
wikipage=Code_Capture_Tool#Set_Layout_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SetClipboard.png
wikipage=Code_Capture_Tool#Set_Clipboard_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SetVI.png
wikipage=Code_Capture_Tool#Set_VI_Ref
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SetFolder.png
wikipage=Code_Capture_Tool#Set_Folder
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SetFileName.png
wikipage=Code_Capture_Tool#Set_Filename
</linkedimage>
|}

These VIs are used to change properties for the CCT instance.

==== Set Front Panel Mode ====

[[Image:CCT Set FP Mode CCT.png|Set FP mode]]

This VI will change the current front panel capture mode.

==== Set Block Diagram Mode ====

[[Image:CCT Set BD Mode CCT.png|Set BD mode]]

This VI will change the current block diagram capture mode.

==== Set Layout Mode ====

[[Image:CCT Set Layout Mode CCT.png|Set Layout mode]]

This VI will change the current layout orientation.

==== Set Clipboard Mode ====

[[Image:CCT Set Clipboard Mode CCT.png|Set Clipboard mode]]

This VI will change the current clipboard mode.

==== Set VI Ref ====

[[Image:CCT Set VI Ref CCT.png|Set Clipboard mode]]

This VI sets the reference of the VI that needs to be captured

==== Set Folder ====

[[Image:CCT Set Folder CCT.png|Set Folder]]

This VI will change the folder where the images will be saved.

==== Set Filename ====

[[Image:CCT Set File CCT.png|Set Filename]]

This VI will change the filename of the stored image.

=== Get properties ===

{| class="wikitable"
|-
! [[#Get_properties|Get properties]]
| <linkedimage>
img_src=Image:CCT_GetFP.png
wikipage=Code_Capture_Tool#Get_Front_Panel_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GetBD.png
wikipage=Code_Capture_Tool#Get_Block_Diagram_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GetLayout.png
wikipage=Code_Capture_Tool#Get_Layout_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GetClipboard.png
wikipage=Code_Capture_Tool#Get_Clipboard_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GetVI.png
wikipage=Code_Capture_Tool#Get_VI_Ref
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GetFolder.png
wikipage=Code_Capture_Tool#Get_Folder
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GetFileName.png
wikipage=Code_Capture_Tool#Get_Filename
</linkedimage>
|}

These VIs are used to retrieve properties from the CCT instance.

==== Get Front Panel Mode ====

[[Image:CCT Get FP Setting CCT.png|Get FP mode]]

This VI will read the current front panel capture mode.

==== Get Block Diagram Mode ====

[[Image:CCT Get BD Mode CCT.png|Get BD mode]]

This VI will read the current block diagram capture mode.

==== Get Layout Mode ====

[[Image:CCT Get Layout Mode CCT.png|Get Layout mode]]

This VI will read the current layout orientation.

==== Get Clipboard Mode ====

[[Image:CCT Get Clipboard Mode CCT.png|Get Clipboard mode]]

This VI will read the current clipboard mode.

==== Get VI Ref ====

[[Image:CCT Get VI Ref CCT.png|Get VI Reference]]

This VI returns a reference to the that is currently captured in this isntance

==== Get Folder ====

[[Image:CCT Get Folder CCT.png|Get Folder]]

This VI will read the folder where the images will be saved.

==== Get Filename ====

[[Image:CCT Get File CCT.png|Get Filename]]

This VI will read the filename of the stored image.

=== Support ===

{| class="wikitable"
|-
! [[#Support|Support]]
| <linkedimage>
img_src=Image:CCT_CaptureFP.png
wikipage=Code_Capture_Tool#Capture_Front_panel
</linkedimage>
| <linkedimage>
img_src=Image:CCT_CaptureBD.png
wikipage=Code_Capture_Tool#Capture_Block_diagram
</linkedimage>
| <linkedimage>
img_src=Image:CCT_ShowGUI.png
wikipage=Code_Capture_Tool#Show_CCT_GUI
</linkedimage>
| <linkedimage>
img_src=Image:CCT_70Container.png
wikipage=Code_Capture_Tool#7.0_container_VI
</linkedimage>
| <linkedimage>
img_src=Image:CCT_80_Container.png
wikipage=Code_Capture_Tool#8.0_container_VI
</linkedimage>
|}

This submenu shows additional low level functions of the CCT.

==== Capture Front panel ====

[[Image:CCT Capture Panel Picture CCT.png|Capture front panel]]

Use this VI to have direct access to the capturing of a front panel.

==== Capture Block diagram ====

[[Image:CCT Capture Diagram Picture CCT.png|Capture block diagram]]

Use this VI to have direct access to the capturing of a block diagram.

==== Show CCT GUI ====

[[Image:Code Capture Tool GUI CCT.png|Show CCT GUI]]

Use this VI to show the user interface of the CCT.

==== 7.0 container VI ====

[[Image:Container 70 CCT.png|7.0 container]]

Use this VI if you want to build a source distribution or an executable and need to make sure all dynamic VIs are included. For LabVIEW 7.0 and up.

==== 8.0 container VI (deprecated in version 2.0) ====

[[Image:Container 80 CCT.png|8.0 container]]

Use this VI if you want to build a source distribution or an executable and need to make sure all dynamic VIs are included. For LabVIEW 8.0 and up, don't forget to include the 7.0 container.

Version 2.0 of the Code Capture Tool installer will automatically select the correct container VI, so an additional 8.x container isn't needed anymore.

= Known issues =

{| class="wikitable"
|-
! Description
! Status
|-
| After using a non-default path and resetting it to the default, the new setting (temp) is not used
| Solved in version 1.0
|-
| Installing on Linux fails due to case sensitivity
| Solved in version 1.0
|-
| Capturing a non-visible part on a multi-pane front panel fails
| A limitation due to the LabVIEW implementation of panes, most-likely not fixable
|-
| Saving an empty image returns an error
| Solved in version 1.0
|-
| Opening the CCT from the Getting Started Window locks up LabVIEW
| Solved in version 1.0
|-
| Possible High use of memory
| Investigating
|-
| Impossible to capture FP of locked VI
| Investigating
|}

= Version History =

== Version 2.1.0 ==

Release date 15 February 2010

*Added a border around a snippet
*Altered GUI (Preview window is bigger)
*Better key handling with text annotation, support for HOME and END.
*Movement of text annotation with ctrl-left, ctrl-right, up and down
*Movement in a text annotation with left and right

== Version 2.0.5 ==

Release date 28 November 2009

*Bugfix release for bug [https://sourceforge.net/tracker/?func=detail&atid=996819&aid=2905411&group_id=206229 2905411].

== Version 2.0.0 ==

Release date 24 November 2009

*Support for VI snippet creation
*Support for adding comments and drawings

== Version 1.0.0 ==

Release date 27 February 2008

*Bug-fixes
*Support for panning of the preview

== Version 0.9.1 ==

Release date 7 November 2007

*Support for LabVIEW 7.x and up
*Support for all OS'es
*Support for orientation
*Support for selection
*Support for customized naming
*Support for customized folder

= Licensing =

The CCT is licensed under the BSD license

[[Category:Third_party_LabVIEW_tools]]

File:CCT ClipBoard.png

2010-09-20T19:44:11Z

Tcplomp: uploaded a new version of "Image:CCT ClipBoard.png"

File:CCT ClipBoard.png

2010-09-20T19:35:45Z

Tcplomp: uploaded a new version of "Image:CCT ClipBoard.png"

Code Capture Tool

2010-09-20T19:24:15Z

Tcplomp:

{{TOCright}}

 

== Introduction ==

[[Image:Code Capture Tool GUI FP Halfsize.png|left]]The Code Capture Tool (or CCT) is a [[LabVIEW]] development tool targeted at LabVIEW users to capture images of their code and make it easier to share those images in online forums. 

=== Main Features ===

*Captures of Front Panel
*Captures of Block Diagram
*Comment an Annotate your caputre
*Creation of LabVIEW Snippets in any LabVIEW version
*Save the snippet as anoter (older) version
*Upload the capture to [http://www.imgur.com Imgur.com] and copy the URL to he clipboard

=== History ===

The CCT is based on an idea and earlier versions originally released by [http://forums.ni.com/ni/profile?user.id=34024 Chilly Charly] on the [[NI Forums]] as [http://forums.ni.com/ni/board/message?board.id=BreakPoint&thread.id=1020 starware]. Later, it evolved to a multiple OS and LabVIEW versions tool for creating code-shots and documentation shots. A collaboration between [http://forums.lavag.org/Yair-m1431.html Yair Neeman] and [[User:Tcplomp|Ton Plomp]] resulted in the 1.0 version of the CCT that is currently available through the [[LAVA CR]] at [http://forums.lavag.org/downloads-file121.html this site].

Version 2.0 added the possibility to add text and drawings to the captured image, while version 2.1 added an altered GUI, a border around the snippet and better key-handling. Version 2.1.2 added the option upload the image to Imgur.com and save the snippet in an older version. 

== Instruction ==

A series of videos is available at [http://www.screencast.com/t/ZmQ1YjIxNj Screencast].

A short how to is in the [http://www.screencast.com/t/2aWPdibJ9Sk here available]

An extensive discussion and demo of the CCT is [http://www.screencast.com/t/Yhb9IAOc here]. 

Version 2.0 introduces a new option to create annotations with text and graphics and the possibility to create [[Snippet|snippets]]. There is a demo-video available at [http://www.screencast.com/t/YTY4MjllZmIt Screencast].

== Download ==



Click [http://lavag.org/index.php?app=downloads&showfile=63 here] to download the tool.

To check the source you can explore your ''<user.lib>\_Code Capture Too''l folder or download it from [http://lv-cct-tool.svn.sourceforge.net/viewvc/lv-cct-tool Sourceforge.net]. 

= Interface =

The CCT offers two interfaces to make and distribute images of LabVIEW code - a [[Code Capture Tool#GUI|user interface]] and an [[Code Capture Tool#API|API]].

== GUI ==

The user interface of the CCT allows the user to select which parts of a [[Front Panel]] or [[Block Diagram]] should be captured. The resulting image will be stored on disc and optionally the image or the path can be copied to the OS clipboard.

[[Image:CCT GUI.png|frame|center|Code Capture Tool user interface]]

=== Front panel settings ===

The Front Panel listbox supplies the following options:

{| class="wikitable"
|-
! Listbox
! Item
! Captured parts
|-
| rowspan="4" | [[Image:CCT FP.png]]
| None
| Nothing
|-
| Selected
| All selected parts and items in between
|-
| Visible
| Everything visible in the current panel view
|-
| All
| Everything on the front panel
|}

=== Block diagram settings ===

The Block Diagram listbox supplies the following options:

{| class="wikitable"
|-
! Listbox
! Item
! Captured parts
|-
| rowspan="4" | [[Image:CCT BD.png]]
| None
| Nothing
|-
| Selected
| All selected parts and items in between
|-
| Visible
| Everything visible in the current block diagram view
|-
| All
| Everything on the block diagram
|}

==== Snippet Creation ====

The creation of a snippet can only be done when the '''Block Diagram''' is set to '''selected'''. 

[[Image:CCTSnippetButtons.png]]

The header-text of the snippet is dynamically and has the following options which are accessible with the config button: 

{| class="wikitable"
|-
! scope="col" | Token 
! scope="col" | Meaning 
|-
| $VERSION$ 
| Inserts the current [[Labview|LabVIEW]] version 
|-
| $NAME$ 
| Name of the captured VI, retrieved from the VI.VI Name property 
|-
| $TITLE$ 
| Title of the front panel of the captured VI 
|-
| $IMAGENAME$ 
| Name of image on disk without the PNG extension 
|-
| $DATE:xxx$ 
| Date/Time formatter, <tt>xxx</tt> must be replaced by a valid [http://zone.ni.com/reference/en-XX/help/371361F-01/glang/codes_for_time_format_str/ timestring formatter] 
|}

Per default the header string is <tt>LV: $VERSION$ $DATE:%c$</tt>, %c inserts the localized date. 

 

=== Clipboard settings ===

The clipboard listbox supplies the following options:

{| class="wikitable"
|-
! Listbox
! Item
! Copied item
! Remarks
|-
| rowspan="3" | [[Image:CCT ClipBoard.png]]
| None
| Nothing
|-
| Path
| Path of the captured image
| 
|-
| Image
| The captured image
| Only on Windows
|}

=== Layout settings ===

The Layout picture ring supplies the following layout options:

{| class="wikitable"
|-
! Menu Ring
! Item
! Description
|-
| rowspan="4" | [[Image:CCT Layout.png]]
| [[Image:CCT Layout1.png]]
| Front panel in top, block diagram below
|-
| [[Image:CCT Layout2.png]]
| Block diagram in top, front panel below
|-
| [[Image:CCT Layout3.png]]
| Front panel in left, block diagram on the right
|-
| [[Image:CCT Layout4.png]]
| Block diagram in left, front panel on the right
|}

=== File settings ===

[[Image:CCT FileSettings.png]]

The file settings consists of two controls, the string control to name the file (a .png extension is added to the name automatically) and a browse button to set the folder where the file should be stored. To detect which folder is currently used hover over one of the two controls and the tip-strip will show the folder.

==== Resetting the folder ====

By default the storage folder is the LabVIEW temp folder (which by default is the same as the OS temp folder), and can be changed with the browse for folder button. To revert to the temp folder use this button [[Image:CCT Reset.png]].

=== Zoom function ===

[[Image:CCT Zoom.png]]

The zoom slider allows the user to zoom in and out on the captured image and inspect it in detail. This only affects the preview image and will not change the stored image.

=== Annotation/Sketch toolbars ===

[[Image:CCTAnnotationOptions.png]]

The annotation/sketch toolbars are used to add annotations and sketches/drawings to the capture. 

==== Drawing tools ====

{| cellspacing="10" cellpadding="2" border="0" align="left" width="407" style=""
|-
| [[Image:AnnotationOptionsRotated.png|left|18x98px]]
|
'''Rectangle:''' Use shift to draw a square 

'''Oval:''' Use shift to draw a circle '''Line:''' Use shift to limit drawing to one axis (X or Y) 

'''Arrow:''' Use shift to limit drawing to one axis (X or Y) '''Free: ''' Use this to draw irregular shapes 

|}

 

 

 

 

 

 

 

==== Drawing Styles ====

[[Image:CCTStylesDetail.png]] The style of the line can be one of 5 styles: 

*Continious
*Dash
*Dot
*Dash-Dot
*Dash-Dot-Dot

 

==== Line width ====

The linewidth of the sketch/drawing line can be alterd as well [[Image:CCT Linewidth.png]] 

==== Line/Text color ====

It's possible to alter the color of the annotation (sketch or text), when editing text changing the line coler takes effect immediatly.

==== Text size ====

The font of the annotation text cannot be altered and is fixed on <tt>Arial </tt>, the size however can be altered easily.

==== Editing tools ====

{| width="50%" cellspacing="2" cellpadding="1" border="0" align="left"
|-
| [[Image:CCT Text.png]] 
| Starts editing text Use shift-enter to add anew-line Use arrow keys to move the positioning of the text around 
|-
| [[Image:CCT Pan.png]] 
| Use this to move the preview window around, this is the default tool of the Annotation Sketch toolbar. It does not change the captured image. 
|-
| [[Image:CCT Undo.png]] 
| Use this to undo the last edit on the annotation/sketch (4 steps possible), use <ctrl-z> on [[Image:Logo.Windows.png]] and [[Image:Logo.Linux.png]] and <cmd-z> on [[Image:Logo.Mac.png]]. 
|-
| [[Image:CCT Clear.png]]
| Clear the annotation layer. 
|}

 

 

 

 

 

 

=== Help ===

The help button [[Image:CCT Help.png]] calls the about window of the CCT including a short description of the main functions, a link to the webpage, a list of know issues and licensing info.

=== Capture ===

The capture button [[Image:CCT Capture.png]] will capture the image, save it, copy to the clipboard, save the currently selected options for the next time and close the window. This can also be done by pressing Enter.

=== Clean up ===

The clean up button [[Image:CCTCleanUp.png]] will clean up the whole BD (if 'whole' is set as BD option) or the current selection (if 'Selections' is set as BD option). This button is only visible if this option is active (correct LabVIEW version).

=== Key navigation ===

The CCT has several key shortcuts for easier access:

{| class="wikitable"
|-
! Key
! Function
|-
| Enter
| Applies the current settings and does a [[Code Capture Tool#Capture|capture]] or finishes a current text edit 
|-
| F1
| Loads the about window centered on the help tab
|-
| F5
| Refreshes the current image
|-
| Escape
| Closes the CCT without performing a capture or finishes a current text/graph edit 
|}

== API ==

The API provides an interface to the various functions of the CCT. Its palette is accessible under [[User.lib]]\Code Capture Tool.

[[Image:CCT palette.PNG]]

{| class="wikitable"
|-
! [[#Methods|Methods]]
| <linkedimage>
img_src=Image:CCT_GetSessions.png
wikipage=Code_Capture_Tool#Create_CCT_Instance
</linkedimage>
| <linkedimage>
img_src=Image:CCT_Capture_icon.png
wikipage=Code_Capture_Tool#Capture_Image
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SaveImage.png
wikipage=Code_Capture_Tool#Save_Image
</linkedimage>
| <linkedimage>
img_src=Image:CCT_CopyToClipboard.png
wikipage=Code_Capture_Tool#Copy_to_Clipboard
</linkedimage>
| 
| <linkedimage>
img_src=Image:CCT_CloseSession.png
wikipage=Code_Capture_Tool#Destroy_CCT_Instance
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GenerateFileName.png
wikipage=Code_Capture_Tool#Generate_File_Name
</linkedimage>
|-
! [[#Set_properties|Set properties]]
| <linkedimage>
img_src=Image:CCT_SetFP.png
wikipage=Code_Capture_Tool#Set_Front_Panel_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SetBD.png
wikipage=Code_Capture_Tool#Set_Block_Diagram_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SetLayout.png
wikipage=Code_Capture_Tool#Set_Layout_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SetClipboard.png
wikipage=Code_Capture_Tool#Set_Clipboard_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SetVI.png
wikipage=Code_Capture_Tool#Set_VI_Ref
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SetFolder.png
wikipage=Code_Capture_Tool#Set_Folder
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SetFileName.png
wikipage=Code_Capture_Tool#Set_Filename
</linkedimage>
|-
! [[#Get_properties|Get properties]]
| <linkedimage>
img_src=Image:CCT_GetFP.png
wikipage=Code_Capture_Tool#Get_Front_Panel_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GetBD.png
wikipage=Code_Capture_Tool#Get_Block_Diagram_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GetLayout.png
wikipage=Code_Capture_Tool#Get_Layout_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GetClipboard.png
wikipage=Code_Capture_Tool#Get_Clipboard_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GetVI.png
wikipage=Code_Capture_Tool#Get_VI_Ref
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GetFolder.png
wikipage=Code_Capture_Tool#Get_Folder
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GetFileName.png
wikipage=Code_Capture_Tool#Get_Filename
</linkedimage>
|-
! [[#Support|Support]]
| <linkedimage>
img_src=Image:CCT_Support.png
wikipage=Code_Capture_Tool#Support
</linkedimage>
| 
| <linkedimage>
img_src=Image:CCT_CaptureFP.png
wikipage=Code_Capture_Tool#Capture_Front_panel
</linkedimage>
| <linkedimage>
img_src=Image:CCT_CaptureBD.png
wikipage=Code_Capture_Tool#Capture_Block_diagram
</linkedimage>
| <linkedimage>
img_src=Image:CCT_ShowGUI.png
wikipage=Code_Capture_Tool#Show_CCT_GUI
</linkedimage>
| <linkedimage>
img_src=Image:CCT_70Container.png
wikipage=Code_Capture_Tool#7.0_container_VI
</linkedimage>
| <linkedimage>
img_src=Image:CCT_80_Container.png
wikipage=Code_Capture_Tool#8.0_container_VI
</linkedimage>
|}

=== Methods ===

{| class="wikitable"
|-
! [[#Methods|Methods]]
| <linkedimage>
img_src=Image:CCT_GetSessions.png
wikipage=Code_Capture_Tool#Create_CCT_Instance
</linkedimage>
| <linkedimage>
img_src=Image:CCT_Capture_icon.png
wikipage=Code_Capture_Tool#Capture_Image
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SaveImage.png
wikipage=Code_Capture_Tool#Save_Image
</linkedimage>
| <linkedimage>
img_src=Image:CCT_CopyToClipboard.png
wikipage=Code_Capture_Tool#Copy_to_Clipboard
</linkedimage>
| <linkedimage>
img_src=Image:CCT_CloseSession.png
wikipage=Code_Capture_Tool#Destroy_CCT_Instance
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GenerateFileName.png
wikipage=Code_Capture_Tool#Generate_File_Name
</linkedimage>
|}

These VIs are used to activate methods for the CCT.

==== Create CCT Instance ====

[[Image:CCT Create CCT.png|Creat CCT Instance]]

This VI must be called for every instance of the CCT, it creates a GOOP dataspace that will contain the data of the instance. Calling this VI must be done with a valid VI reference.

==== Capture Image ====

[[Image:CCT Capture VI Images CCT.png|Capture Images]]

This VI will apply the current settings and store the captured image in the CCT instance, additionally it returns the image itself.

==== Save Image ====

[[Image:CCT Save Captured Image CCT.png|Save Image]]

This VI will save the image to the path specified by a folder and filename stored in the CCT instance.

==== Copy to Clipboard ====

[[Image:CCT Copy Data to Clipboard CCT.png|Copy to Clipboard]]

This VI will store the data specified by the clipboard settings to the clipboard.

==== Destroy CCT Instance ====

[[Image:CCT Destroy CCT.png|Destroy CCT Instance]]

This VI must be called to close the CCT Instance and will free up used memory resources.

==== Generate File Name ====

[[Image:CCT Generate File Name CCT.png|Generate filename]]

This VI will generate a default filename based on the captured parts and VI name. This filename will not be stored inside the CCT session.

=== Set properties ===

{| class="wikitable"
|-
! [[#Set_properties|Set properties]]
| <linkedimage>
img_src=Image:CCT_SetFP.png
wikipage=Code_Capture_Tool#Set_Front_Panel_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SetBD.png
wikipage=Code_Capture_Tool#Set_Block_Diagram_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SetLayout.png
wikipage=Code_Capture_Tool#Set_Layout_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SetClipboard.png
wikipage=Code_Capture_Tool#Set_Clipboard_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SetVI.png
wikipage=Code_Capture_Tool#Set_VI_Ref
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SetFolder.png
wikipage=Code_Capture_Tool#Set_Folder
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SetFileName.png
wikipage=Code_Capture_Tool#Set_Filename
</linkedimage>
|}

These VIs are used to change properties for the CCT instance.

==== Set Front Panel Mode ====

[[Image:CCT Set FP Mode CCT.png|Set FP mode]]

This VI will change the current front panel capture mode.

==== Set Block Diagram Mode ====

[[Image:CCT Set BD Mode CCT.png|Set BD mode]]

This VI will change the current block diagram capture mode.

==== Set Layout Mode ====

[[Image:CCT Set Layout Mode CCT.png|Set Layout mode]]

This VI will change the current layout orientation.

==== Set Clipboard Mode ====

[[Image:CCT Set Clipboard Mode CCT.png|Set Clipboard mode]]

This VI will change the current clipboard mode.

==== Set VI Ref ====

[[Image:CCT Set VI Ref CCT.png|Set Clipboard mode]]

This VI sets the reference of the VI that needs to be captured

==== Set Folder ====

[[Image:CCT Set Folder CCT.png|Set Folder]]

This VI will change the folder where the images will be saved.

==== Set Filename ====

[[Image:CCT Set File CCT.png|Set Filename]]

This VI will change the filename of the stored image.

=== Get properties ===

{| class="wikitable"
|-
! [[#Get_properties|Get properties]]
| <linkedimage>
img_src=Image:CCT_GetFP.png
wikipage=Code_Capture_Tool#Get_Front_Panel_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GetBD.png
wikipage=Code_Capture_Tool#Get_Block_Diagram_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GetLayout.png
wikipage=Code_Capture_Tool#Get_Layout_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GetClipboard.png
wikipage=Code_Capture_Tool#Get_Clipboard_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GetVI.png
wikipage=Code_Capture_Tool#Get_VI_Ref
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GetFolder.png
wikipage=Code_Capture_Tool#Get_Folder
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GetFileName.png
wikipage=Code_Capture_Tool#Get_Filename
</linkedimage>
|}

These VIs are used to retrieve properties from the CCT instance.

==== Get Front Panel Mode ====

[[Image:CCT Get FP Setting CCT.png|Get FP mode]]

This VI will read the current front panel capture mode.

==== Get Block Diagram Mode ====

[[Image:CCT Get BD Mode CCT.png|Get BD mode]]

This VI will read the current block diagram capture mode.

==== Get Layout Mode ====

[[Image:CCT Get Layout Mode CCT.png|Get Layout mode]]

This VI will read the current layout orientation.

==== Get Clipboard Mode ====

[[Image:CCT Get Clipboard Mode CCT.png|Get Clipboard mode]]

This VI will read the current clipboard mode.

==== Get VI Ref ====

[[Image:CCT Get VI Ref CCT.png|Get VI Reference]]

This VI returns a reference to the that is currently captured in this isntance

==== Get Folder ====

[[Image:CCT Get Folder CCT.png|Get Folder]]

This VI will read the folder where the images will be saved.

==== Get Filename ====

[[Image:CCT Get File CCT.png|Get Filename]]

This VI will read the filename of the stored image.

=== Support ===

{| class="wikitable"
|-
! [[#Support|Support]]
| <linkedimage>
img_src=Image:CCT_CaptureFP.png
wikipage=Code_Capture_Tool#Capture_Front_panel
</linkedimage>
| <linkedimage>
img_src=Image:CCT_CaptureBD.png
wikipage=Code_Capture_Tool#Capture_Block_diagram
</linkedimage>
| <linkedimage>
img_src=Image:CCT_ShowGUI.png
wikipage=Code_Capture_Tool#Show_CCT_GUI
</linkedimage>
| <linkedimage>
img_src=Image:CCT_70Container.png
wikipage=Code_Capture_Tool#7.0_container_VI
</linkedimage>
| <linkedimage>
img_src=Image:CCT_80_Container.png
wikipage=Code_Capture_Tool#8.0_container_VI
</linkedimage>
|}

This submenu shows additional low level functions of the CCT.

==== Capture Front panel ====

[[Image:CCT Capture Panel Picture CCT.png|Capture front panel]]

Use this VI to have direct access to the capturing of a front panel.

==== Capture Block diagram ====

[[Image:CCT Capture Diagram Picture CCT.png|Capture block diagram]]

Use this VI to have direct access to the capturing of a block diagram.

==== Show CCT GUI ====

[[Image:Code Capture Tool GUI CCT.png|Show CCT GUI]]

Use this VI to show the user interface of the CCT.

==== 7.0 container VI ====

[[Image:Container 70 CCT.png|7.0 container]]

Use this VI if you want to build a source distribution or an executable and need to make sure all dynamic VIs are included. For LabVIEW 7.0 and up.

==== 8.0 container VI (deprecated in version 2.0) ====

[[Image:Container 80 CCT.png|8.0 container]]

Use this VI if you want to build a source distribution or an executable and need to make sure all dynamic VIs are included. For LabVIEW 8.0 and up, don't forget to include the 7.0 container.

Version 2.0 of the Code Capture Tool installer will automatically select the correct container VI, so an additional 8.x container isn't needed anymore.

= Known issues =

{| class="wikitable"
|-
! Description
! Status
|-
| After using a non-default path and resetting it to the default, the new setting (temp) is not used
| Solved in version 1.0
|-
| Installing on Linux fails due to case sensitivity
| Solved in version 1.0
|-
| Capturing a non-visible part on a multi-pane front panel fails
| A limitation due to the LabVIEW implementation of panes, most-likely not fixable
|-
| Saving an empty image returns an error
| Solved in version 1.0
|-
| Opening the CCT from the Getting Started Window locks up LabVIEW
| Solved in version 1.0
|-
| Possible High use of memory
| Investigating
|-
| Impossible to capture FP of locked VI
| Investigating
|}

= Version History =

== Version 2.1.0 ==

Release date 15 February 2010

*Added a border around a snippet
*Altered GUI (Preview window is bigger)
*Better key handling with text annotation, support for HOME and END.
*Movement of text annotation with ctrl-left, ctrl-right, up and down
*Movement in a text annotation with left and right

== Version 2.0.5 ==

Release date 28 November 2009

*Bugfix release for bug [https://sourceforge.net/tracker/?func=detail&atid=996819&aid=2905411&group_id=206229 2905411].

== Version 2.0.0 ==

Release date 24 November 2009

*Support for VI snippet creation
*Support for adding comments and drawings

== Version 1.0.0 ==

Release date 27 February 2008

*Bug-fixes
*Support for panning of the preview

== Version 0.9.1 ==

Release date 7 November 2007

*Support for LabVIEW 7.x and up
*Support for all OS'es
*Support for orientation
*Support for selection
*Support for customized naming
*Support for customized folder

= Licensing =

The CCT is licensed under the BSD license

[[Category:Third_party_LabVIEW_tools]]

Code Capture Tool

2010-09-20T19:23:54Z

Tcplomp:

{{TOCright}}

 

== Introduction ==

[[Image:Code Capture Tool GUI FP Halfsize.png|left]]The Code Capture Tool (or CCT) is a [[LabVIEW]] development tool targeted at LabVIEW users to capture images of their code and make it easier to share those images in online forums. 

=== Main Features ===

*Captures of Front Panel
*Captures of Block Diagram
*Comment an Annotate your caputre
*Creation of LabVIEW Snippets in any LabVIEW version
*Save the snippet as anoter (older) version
*Upload the capture to [http://www.imgur.com Imgur.com] and copy the URL to he clipboard

== History ==

The CCT is based on an idea and earlier versions originally released by [http://forums.ni.com/ni/profile?user.id=34024 Chilly Charly] on the [[NI Forums]] as [http://forums.ni.com/ni/board/message?board.id=BreakPoint&thread.id=1020 starware]. Later, it evolved to a multiple OS and LabVIEW versions tool for creating code-shots and documentation shots. A collaboration between [http://forums.lavag.org/Yair-m1431.html Yair Neeman] and [[User:Tcplomp|Ton Plomp]] resulted in the 1.0 version of the CCT that is currently available through the [[LAVA CR]] at [http://forums.lavag.org/downloads-file121.html this site].

Version 2.0 added the possibility to add text and drawings to the captured image, while version 2.1 added an altered GUI, a border around the snippet and better key-handling. Version 2.1.2 added the option upload the image to Imgur.com and save the snippet in an older version. 

== Instruction ==

A series of videos is available at [http://www.screencast.com/t/ZmQ1YjIxNj Screencast].

A short how to is in the [http://www.screencast.com/t/2aWPdibJ9Sk here available]

An extensive discussion and demo of the CCT is [http://www.screencast.com/t/Yhb9IAOc here]. 

Version 2.0 introduces a new option to create annotations with text and graphics and the possibility to create [[Snippet|snippets]]. There is a demo-video available at [http://www.screencast.com/t/YTY4MjllZmIt Screencast].

== Download ==



Click [http://lavag.org/index.php?app=downloads&showfile=63 here] to download the tool.

To check the source you can explore your ''<user.lib>\_Code Capture Too''l folder or download it from [http://lv-cct-tool.svn.sourceforge.net/viewvc/lv-cct-tool Sourceforge.net]. 

= Interface =

The CCT offers two interfaces to make and distribute images of LabVIEW code - a [[Code Capture Tool#GUI|user interface]] and an [[Code Capture Tool#API|API]].

== GUI ==

The user interface of the CCT allows the user to select which parts of a [[Front Panel]] or [[Block Diagram]] should be captured. The resulting image will be stored on disc and optionally the image or the path can be copied to the OS clipboard.

[[Image:CCT GUI.png|frame|center|Code Capture Tool user interface]]

=== Front panel settings ===

The Front Panel listbox supplies the following options:

{| class="wikitable"
|-
! Listbox
! Item
! Captured parts
|-
| rowspan="4" | [[Image:CCT FP.png]]
| None
| Nothing
|-
| Selected
| All selected parts and items in between
|-
| Visible
| Everything visible in the current panel view
|-
| All
| Everything on the front panel
|}

=== Block diagram settings ===

The Block Diagram listbox supplies the following options:

{| class="wikitable"
|-
! Listbox
! Item
! Captured parts
|-
| rowspan="4" | [[Image:CCT BD.png]]
| None
| Nothing
|-
| Selected
| All selected parts and items in between
|-
| Visible
| Everything visible in the current block diagram view
|-
| All
| Everything on the block diagram
|}

==== Snippet Creation ====

The creation of a snippet can only be done when the '''Block Diagram''' is set to '''selected'''. 

[[Image:CCTSnippetButtons.png]]

The header-text of the snippet is dynamically and has the following options which are accessible with the config button: 

{| class="wikitable"
|-
! scope="col" | Token 
! scope="col" | Meaning 
|-
| $VERSION$ 
| Inserts the current [[Labview|LabVIEW]] version 
|-
| $NAME$ 
| Name of the captured VI, retrieved from the VI.VI Name property 
|-
| $TITLE$ 
| Title of the front panel of the captured VI 
|-
| $IMAGENAME$ 
| Name of image on disk without the PNG extension 
|-
| $DATE:xxx$ 
| Date/Time formatter, <tt>xxx</tt> must be replaced by a valid [http://zone.ni.com/reference/en-XX/help/371361F-01/glang/codes_for_time_format_str/ timestring formatter] 
|}

Per default the header string is <tt>LV: $VERSION$ $DATE:%c$</tt>, %c inserts the localized date. 

 

=== Clipboard settings ===

The clipboard listbox supplies the following options:

{| class="wikitable"
|-
! Listbox
! Item
! Copied item
! Remarks
|-
| rowspan="3" | [[Image:CCT ClipBoard.png]]
| None
| Nothing
|-
| Path
| Path of the captured image
| 
|-
| Image
| The captured image
| Only on Windows
|}

=== Layout settings ===

The Layout picture ring supplies the following layout options:

{| class="wikitable"
|-
! Menu Ring
! Item
! Description
|-
| rowspan="4" | [[Image:CCT Layout.png]]
| [[Image:CCT Layout1.png]]
| Front panel in top, block diagram below
|-
| [[Image:CCT Layout2.png]]
| Block diagram in top, front panel below
|-
| [[Image:CCT Layout3.png]]
| Front panel in left, block diagram on the right
|-
| [[Image:CCT Layout4.png]]
| Block diagram in left, front panel on the right
|}

=== File settings ===

[[Image:CCT FileSettings.png]]

The file settings consists of two controls, the string control to name the file (a .png extension is added to the name automatically) and a browse button to set the folder where the file should be stored. To detect which folder is currently used hover over one of the two controls and the tip-strip will show the folder.

==== Resetting the folder ====

By default the storage folder is the LabVIEW temp folder (which by default is the same as the OS temp folder), and can be changed with the browse for folder button. To revert to the temp folder use this button [[Image:CCT Reset.png]].

=== Zoom function ===

[[Image:CCT Zoom.png]]

The zoom slider allows the user to zoom in and out on the captured image and inspect it in detail. This only affects the preview image and will not change the stored image.

=== Annotation/Sketch toolbars ===

[[Image:CCTAnnotationOptions.png]]

The annotation/sketch toolbars are used to add annotations and sketches/drawings to the capture. 

==== Drawing tools ====

{| cellspacing="10" cellpadding="2" border="0" align="left" width="407" style=""
|-
| [[Image:AnnotationOptionsRotated.png|left|18x98px]]
|
'''Rectangle:''' Use shift to draw a square 

'''Oval:''' Use shift to draw a circle '''Line:''' Use shift to limit drawing to one axis (X or Y) 

'''Arrow:''' Use shift to limit drawing to one axis (X or Y) '''Free: ''' Use this to draw irregular shapes 

|}

 

 

 

 

 

 

 

==== Drawing Styles ====

[[Image:CCTStylesDetail.png]] The style of the line can be one of 5 styles: 

*Continious
*Dash
*Dot
*Dash-Dot
*Dash-Dot-Dot

 

==== Line width ====

The linewidth of the sketch/drawing line can be alterd as well [[Image:CCT Linewidth.png]] 

==== Line/Text color ====

It's possible to alter the color of the annotation (sketch or text), when editing text changing the line coler takes effect immediatly.

==== Text size ====

The font of the annotation text cannot be altered and is fixed on <tt>Arial </tt>, the size however can be altered easily.

==== Editing tools ====

{| width="50%" cellspacing="2" cellpadding="1" border="0" align="left"
|-
| [[Image:CCT Text.png]] 
| Starts editing text Use shift-enter to add anew-line Use arrow keys to move the positioning of the text around 
|-
| [[Image:CCT Pan.png]] 
| Use this to move the preview window around, this is the default tool of the Annotation Sketch toolbar. It does not change the captured image. 
|-
| [[Image:CCT Undo.png]] 
| Use this to undo the last edit on the annotation/sketch (4 steps possible), use <ctrl-z> on [[Image:Logo.Windows.png]] and [[Image:Logo.Linux.png]] and <cmd-z> on [[Image:Logo.Mac.png]]. 
|-
| [[Image:CCT Clear.png]]
| Clear the annotation layer. 
|}

 

 

 

 

 

 

=== Help ===

The help button [[Image:CCT Help.png]] calls the about window of the CCT including a short description of the main functions, a link to the webpage, a list of know issues and licensing info.

=== Capture ===

The capture button [[Image:CCT Capture.png]] will capture the image, save it, copy to the clipboard, save the currently selected options for the next time and close the window. This can also be done by pressing Enter.

=== Clean up ===

The clean up button [[Image:CCTCleanUp.png]] will clean up the whole BD (if 'whole' is set as BD option) or the current selection (if 'Selections' is set as BD option). This button is only visible if this option is active (correct LabVIEW version).

=== Key navigation ===

The CCT has several key shortcuts for easier access:

{| class="wikitable"
|-
! Key
! Function
|-
| Enter
| Applies the current settings and does a [[Code Capture Tool#Capture|capture]] or finishes a current text edit 
|-
| F1
| Loads the about window centered on the help tab
|-
| F5
| Refreshes the current image
|-
| Escape
| Closes the CCT without performing a capture or finishes a current text/graph edit 
|}

== API ==

The API provides an interface to the various functions of the CCT. Its palette is accessible under [[User.lib]]\Code Capture Tool.

[[Image:CCT palette.PNG]]

{| class="wikitable"
|-
! [[#Methods|Methods]]
| <linkedimage>
img_src=Image:CCT_GetSessions.png
wikipage=Code_Capture_Tool#Create_CCT_Instance
</linkedimage>
| <linkedimage>
img_src=Image:CCT_Capture_icon.png
wikipage=Code_Capture_Tool#Capture_Image
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SaveImage.png
wikipage=Code_Capture_Tool#Save_Image
</linkedimage>
| <linkedimage>
img_src=Image:CCT_CopyToClipboard.png
wikipage=Code_Capture_Tool#Copy_to_Clipboard
</linkedimage>
| 
| <linkedimage>
img_src=Image:CCT_CloseSession.png
wikipage=Code_Capture_Tool#Destroy_CCT_Instance
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GenerateFileName.png
wikipage=Code_Capture_Tool#Generate_File_Name
</linkedimage>
|-
! [[#Set_properties|Set properties]]
| <linkedimage>
img_src=Image:CCT_SetFP.png
wikipage=Code_Capture_Tool#Set_Front_Panel_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SetBD.png
wikipage=Code_Capture_Tool#Set_Block_Diagram_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SetLayout.png
wikipage=Code_Capture_Tool#Set_Layout_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SetClipboard.png
wikipage=Code_Capture_Tool#Set_Clipboard_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SetVI.png
wikipage=Code_Capture_Tool#Set_VI_Ref
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SetFolder.png
wikipage=Code_Capture_Tool#Set_Folder
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SetFileName.png
wikipage=Code_Capture_Tool#Set_Filename
</linkedimage>
|-
! [[#Get_properties|Get properties]]
| <linkedimage>
img_src=Image:CCT_GetFP.png
wikipage=Code_Capture_Tool#Get_Front_Panel_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GetBD.png
wikipage=Code_Capture_Tool#Get_Block_Diagram_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GetLayout.png
wikipage=Code_Capture_Tool#Get_Layout_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GetClipboard.png
wikipage=Code_Capture_Tool#Get_Clipboard_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GetVI.png
wikipage=Code_Capture_Tool#Get_VI_Ref
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GetFolder.png
wikipage=Code_Capture_Tool#Get_Folder
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GetFileName.png
wikipage=Code_Capture_Tool#Get_Filename
</linkedimage>
|-
! [[#Support|Support]]
| <linkedimage>
img_src=Image:CCT_Support.png
wikipage=Code_Capture_Tool#Support
</linkedimage>
| 
| <linkedimage>
img_src=Image:CCT_CaptureFP.png
wikipage=Code_Capture_Tool#Capture_Front_panel
</linkedimage>
| <linkedimage>
img_src=Image:CCT_CaptureBD.png
wikipage=Code_Capture_Tool#Capture_Block_diagram
</linkedimage>
| <linkedimage>
img_src=Image:CCT_ShowGUI.png
wikipage=Code_Capture_Tool#Show_CCT_GUI
</linkedimage>
| <linkedimage>
img_src=Image:CCT_70Container.png
wikipage=Code_Capture_Tool#7.0_container_VI
</linkedimage>
| <linkedimage>
img_src=Image:CCT_80_Container.png
wikipage=Code_Capture_Tool#8.0_container_VI
</linkedimage>
|}

=== Methods ===

{| class="wikitable"
|-
! [[#Methods|Methods]]
| <linkedimage>
img_src=Image:CCT_GetSessions.png
wikipage=Code_Capture_Tool#Create_CCT_Instance
</linkedimage>
| <linkedimage>
img_src=Image:CCT_Capture_icon.png
wikipage=Code_Capture_Tool#Capture_Image
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SaveImage.png
wikipage=Code_Capture_Tool#Save_Image
</linkedimage>
| <linkedimage>
img_src=Image:CCT_CopyToClipboard.png
wikipage=Code_Capture_Tool#Copy_to_Clipboard
</linkedimage>
| <linkedimage>
img_src=Image:CCT_CloseSession.png
wikipage=Code_Capture_Tool#Destroy_CCT_Instance
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GenerateFileName.png
wikipage=Code_Capture_Tool#Generate_File_Name
</linkedimage>
|}

These VIs are used to activate methods for the CCT.

==== Create CCT Instance ====

[[Image:CCT Create CCT.png|Creat CCT Instance]]

This VI must be called for every instance of the CCT, it creates a GOOP dataspace that will contain the data of the instance. Calling this VI must be done with a valid VI reference.

==== Capture Image ====

[[Image:CCT Capture VI Images CCT.png|Capture Images]]

This VI will apply the current settings and store the captured image in the CCT instance, additionally it returns the image itself.

==== Save Image ====

[[Image:CCT Save Captured Image CCT.png|Save Image]]

This VI will save the image to the path specified by a folder and filename stored in the CCT instance.

==== Copy to Clipboard ====

[[Image:CCT Copy Data to Clipboard CCT.png|Copy to Clipboard]]

This VI will store the data specified by the clipboard settings to the clipboard.

==== Destroy CCT Instance ====

[[Image:CCT Destroy CCT.png|Destroy CCT Instance]]

This VI must be called to close the CCT Instance and will free up used memory resources.

==== Generate File Name ====

[[Image:CCT Generate File Name CCT.png|Generate filename]]

This VI will generate a default filename based on the captured parts and VI name. This filename will not be stored inside the CCT session.

=== Set properties ===

{| class="wikitable"
|-
! [[#Set_properties|Set properties]]
| <linkedimage>
img_src=Image:CCT_SetFP.png
wikipage=Code_Capture_Tool#Set_Front_Panel_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SetBD.png
wikipage=Code_Capture_Tool#Set_Block_Diagram_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SetLayout.png
wikipage=Code_Capture_Tool#Set_Layout_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SetClipboard.png
wikipage=Code_Capture_Tool#Set_Clipboard_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SetVI.png
wikipage=Code_Capture_Tool#Set_VI_Ref
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SetFolder.png
wikipage=Code_Capture_Tool#Set_Folder
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SetFileName.png
wikipage=Code_Capture_Tool#Set_Filename
</linkedimage>
|}

These VIs are used to change properties for the CCT instance.

==== Set Front Panel Mode ====

[[Image:CCT Set FP Mode CCT.png|Set FP mode]]

This VI will change the current front panel capture mode.

==== Set Block Diagram Mode ====

[[Image:CCT Set BD Mode CCT.png|Set BD mode]]

This VI will change the current block diagram capture mode.

==== Set Layout Mode ====

[[Image:CCT Set Layout Mode CCT.png|Set Layout mode]]

This VI will change the current layout orientation.

==== Set Clipboard Mode ====

[[Image:CCT Set Clipboard Mode CCT.png|Set Clipboard mode]]

This VI will change the current clipboard mode.

==== Set VI Ref ====

[[Image:CCT Set VI Ref CCT.png|Set Clipboard mode]]

This VI sets the reference of the VI that needs to be captured

==== Set Folder ====

[[Image:CCT Set Folder CCT.png|Set Folder]]

This VI will change the folder where the images will be saved.

==== Set Filename ====

[[Image:CCT Set File CCT.png|Set Filename]]

This VI will change the filename of the stored image.

=== Get properties ===

{| class="wikitable"
|-
! [[#Get_properties|Get properties]]
| <linkedimage>
img_src=Image:CCT_GetFP.png
wikipage=Code_Capture_Tool#Get_Front_Panel_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GetBD.png
wikipage=Code_Capture_Tool#Get_Block_Diagram_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GetLayout.png
wikipage=Code_Capture_Tool#Get_Layout_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GetClipboard.png
wikipage=Code_Capture_Tool#Get_Clipboard_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GetVI.png
wikipage=Code_Capture_Tool#Get_VI_Ref
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GetFolder.png
wikipage=Code_Capture_Tool#Get_Folder
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GetFileName.png
wikipage=Code_Capture_Tool#Get_Filename
</linkedimage>
|}

These VIs are used to retrieve properties from the CCT instance.

==== Get Front Panel Mode ====

[[Image:CCT Get FP Setting CCT.png|Get FP mode]]

This VI will read the current front panel capture mode.

==== Get Block Diagram Mode ====

[[Image:CCT Get BD Mode CCT.png|Get BD mode]]

This VI will read the current block diagram capture mode.

==== Get Layout Mode ====

[[Image:CCT Get Layout Mode CCT.png|Get Layout mode]]

This VI will read the current layout orientation.

==== Get Clipboard Mode ====

[[Image:CCT Get Clipboard Mode CCT.png|Get Clipboard mode]]

This VI will read the current clipboard mode.

==== Get VI Ref ====

[[Image:CCT Get VI Ref CCT.png|Get VI Reference]]

This VI returns a reference to the that is currently captured in this isntance

==== Get Folder ====

[[Image:CCT Get Folder CCT.png|Get Folder]]

This VI will read the folder where the images will be saved.

==== Get Filename ====

[[Image:CCT Get File CCT.png|Get Filename]]

This VI will read the filename of the stored image.

=== Support ===

{| class="wikitable"
|-
! [[#Support|Support]]
| <linkedimage>
img_src=Image:CCT_CaptureFP.png
wikipage=Code_Capture_Tool#Capture_Front_panel
</linkedimage>
| <linkedimage>
img_src=Image:CCT_CaptureBD.png
wikipage=Code_Capture_Tool#Capture_Block_diagram
</linkedimage>
| <linkedimage>
img_src=Image:CCT_ShowGUI.png
wikipage=Code_Capture_Tool#Show_CCT_GUI
</linkedimage>
| <linkedimage>
img_src=Image:CCT_70Container.png
wikipage=Code_Capture_Tool#7.0_container_VI
</linkedimage>
| <linkedimage>
img_src=Image:CCT_80_Container.png
wikipage=Code_Capture_Tool#8.0_container_VI
</linkedimage>
|}

This submenu shows additional low level functions of the CCT.

==== Capture Front panel ====

[[Image:CCT Capture Panel Picture CCT.png|Capture front panel]]

Use this VI to have direct access to the capturing of a front panel.

==== Capture Block diagram ====

[[Image:CCT Capture Diagram Picture CCT.png|Capture block diagram]]

Use this VI to have direct access to the capturing of a block diagram.

==== Show CCT GUI ====

[[Image:Code Capture Tool GUI CCT.png|Show CCT GUI]]

Use this VI to show the user interface of the CCT.

==== 7.0 container VI ====

[[Image:Container 70 CCT.png|7.0 container]]

Use this VI if you want to build a source distribution or an executable and need to make sure all dynamic VIs are included. For LabVIEW 7.0 and up.

==== 8.0 container VI (deprecated in version 2.0) ====

[[Image:Container 80 CCT.png|8.0 container]]

Use this VI if you want to build a source distribution or an executable and need to make sure all dynamic VIs are included. For LabVIEW 8.0 and up, don't forget to include the 7.0 container.

Version 2.0 of the Code Capture Tool installer will automatically select the correct container VI, so an additional 8.x container isn't needed anymore.

= Known issues =

{| class="wikitable"
|-
! Description
! Status
|-
| After using a non-default path and resetting it to the default, the new setting (temp) is not used
| Solved in version 1.0
|-
| Installing on Linux fails due to case sensitivity
| Solved in version 1.0
|-
| Capturing a non-visible part on a multi-pane front panel fails
| A limitation due to the LabVIEW implementation of panes, most-likely not fixable
|-
| Saving an empty image returns an error
| Solved in version 1.0
|-
| Opening the CCT from the Getting Started Window locks up LabVIEW
| Solved in version 1.0
|-
| Possible High use of memory
| Investigating
|-
| Impossible to capture FP of locked VI
| Investigating
|}

= Version History =

== Version 2.1.0 ==

Release date 15 February 2010

*Added a border around a snippet
*Altered GUI (Preview window is bigger)
*Better key handling with text annotation, support for HOME and END.
*Movement of text annotation with ctrl-left, ctrl-right, up and down
*Movement in a text annotation with left and right

== Version 2.0.5 ==

Release date 28 November 2009

*Bugfix release for bug [https://sourceforge.net/tracker/?func=detail&atid=996819&aid=2905411&group_id=206229 2905411].

== Version 2.0.0 ==

Release date 24 November 2009

*Support for VI snippet creation
*Support for adding comments and drawings

== Version 1.0.0 ==

Release date 27 February 2008

*Bug-fixes
*Support for panning of the preview

== Version 0.9.1 ==

Release date 7 November 2007

*Support for LabVIEW 7.x and up
*Support for all OS'es
*Support for orientation
*Support for selection
*Support for customized naming
*Support for customized folder

= Licensing =

The CCT is licensed under the BSD license

[[Category:Third_party_LabVIEW_tools]]

Code Capture Tool

2010-09-20T19:21:42Z

Tcplomp:

{{TOCright}}

 

== Introduction ==

[[Image:Code Capture Tool GUI FP Halfsize.png|left]]The Code Capture Tool (or CCT) is a [[LabVIEW]] development tool targeted at LabVIEW users to capture images of their code and make it easier to share those images in online forums. 

== Features ==

*Captures of Front Panel
*Captures of Block Diagram
*Comment an Annotate your caputre
*Creation of LabVIEW Snippets in any LabVIEW version
*Save the snippet as anoter (older) version
*Upload the capture to [http://www.imgur.com Imgur.com] and copy the URL to he clipboard

== History ==

The CCT is based on an idea and earlier versions originally released by [http://forums.ni.com/ni/profile?user.id=34024 Chilly Charly] on the [[NI Forums]] as [http://forums.ni.com/ni/board/message?board.id=BreakPoint&thread.id=1020 starware]. Later, it evolved to a multiple OS and LabVIEW versions tool for creating code-shots and documentation shots. A collaboration between [http://forums.lavag.org/Yair-m1431.html Yair Neeman] and [[User:Tcplomp|Ton Plomp]] resulted in the 1.0 version of the CCT that is currently available through the [[LAVA CR]] at [http://forums.lavag.org/downloads-file121.html this site].

Version 2.0 added the possibility to add text and drawings to the captured image, while version 2.1 added an altered GUI, a border around the snippet and better key-handling. Version 2.1.2 added the option upload the image to Imgur.com and save the snippet in an older version. 

== Instruction ==

A series of videos is available at [http://www.screencast.com/t/ZmQ1YjIxNj Screencast].

A short how to is in the [http://www.screencast.com/t/2aWPdibJ9Sk here available]

An extensive discussion and demo of the CCT is [http://www.screencast.com/t/Yhb9IAOc here]. 

Version 2.0 introduces a new option to create annotations with text and graphics and the possibility to create [[Snippet|snippets]]. There is a demo-video available at [http://www.screencast.com/t/YTY4MjllZmIt Screencast].

== Download ==



Click [http://lavag.org/index.php?app=downloads&showfile=63 here] to download the tool.

To check the source you can explore your ''<user.lib>\_Code Capture Too''l folder or download it from [http://lv-cct-tool.svn.sourceforge.net/viewvc/lv-cct-tool Sourceforge.net]. 

= Interface =

The CCT offers two interfaces to make and distribute images of LabVIEW code - a [[Code Capture Tool#GUI|user interface]] and an [[Code Capture Tool#API|API]].

== GUI ==

The user interface of the CCT allows the user to select which parts of a [[Front Panel]] or [[Block Diagram]] should be captured. The resulting image will be stored on disc and optionally the image or the path can be copied to the OS clipboard.

[[Image:CCT GUI.png|frame|center|Code Capture Tool user interface]]

=== Front panel settings ===

The Front Panel listbox supplies the following options:

{| class="wikitable"
|-
! Listbox
! Item
! Captured parts
|-
| rowspan="4" | [[Image:CCT FP.png]]
| None
| Nothing
|-
| Selected
| All selected parts and items in between
|-
| Visible
| Everything visible in the current panel view
|-
| All
| Everything on the front panel
|}

=== Block diagram settings ===

The Block Diagram listbox supplies the following options:

{| class="wikitable"
|-
! Listbox
! Item
! Captured parts
|-
| rowspan="4" | [[Image:CCT BD.png]]
| None
| Nothing
|-
| Selected
| All selected parts and items in between
|-
| Visible
| Everything visible in the current block diagram view
|-
| All
| Everything on the block diagram
|}

==== Snippet Creation ====

The creation of a snippet can only be done when the '''Block Diagram''' is set to '''selected'''. 

[[Image:CCTSnippetButtons.png]]

The header-text of the snippet is dynamically and has the following options which are accessible with the config button: 

{| class="wikitable"
|-
! scope="col" | Token 
! scope="col" | Meaning 
|-
| $VERSION$ 
| Inserts the current [[Labview|LabVIEW]] version 
|-
| $NAME$ 
| Name of the captured VI, retrieved from the VI.VI Name property 
|-
| $TITLE$ 
| Title of the front panel of the captured VI 
|-
| $IMAGENAME$ 
| Name of image on disk without the PNG extension 
|-
| $DATE:xxx$ 
| Date/Time formatter, <tt>xxx</tt> must be replaced by a valid [http://zone.ni.com/reference/en-XX/help/371361F-01/glang/codes_for_time_format_str/ timestring formatter] 
|}

Per default the header string is <tt>LV: $VERSION$ $DATE:%c$</tt>, %c inserts the localized date. 

 

=== Clipboard settings ===

The clipboard listbox supplies the following options:

{| class="wikitable"
|-
! Listbox
! Item
! Copied item
! Remarks
|-
| rowspan="3" | [[Image:CCT ClipBoard.png]]
| None
| Nothing
|-
| Path
| Path of the captured image
| 
|-
| Image
| The captured image
| Only on Windows
|}

=== Layout settings ===

The Layout picture ring supplies the following layout options:

{| class="wikitable"
|-
! Menu Ring
! Item
! Description
|-
| rowspan="4" | [[Image:CCT Layout.png]]
| [[Image:CCT Layout1.png]]
| Front panel in top, block diagram below
|-
| [[Image:CCT Layout2.png]]
| Block diagram in top, front panel below
|-
| [[Image:CCT Layout3.png]]
| Front panel in left, block diagram on the right
|-
| [[Image:CCT Layout4.png]]
| Block diagram in left, front panel on the right
|}

=== File settings ===

[[Image:CCT FileSettings.png]]

The file settings consists of two controls, the string control to name the file (a .png extension is added to the name automatically) and a browse button to set the folder where the file should be stored. To detect which folder is currently used hover over one of the two controls and the tip-strip will show the folder.

==== Resetting the folder ====

By default the storage folder is the LabVIEW temp folder (which by default is the same as the OS temp folder), and can be changed with the browse for folder button. To revert to the temp folder use this button [[Image:CCT Reset.png]].

=== Zoom function ===

[[Image:CCT Zoom.png]]

The zoom slider allows the user to zoom in and out on the captured image and inspect it in detail. This only affects the preview image and will not change the stored image.

=== Annotation/Sketch toolbars ===

[[Image:CCTAnnotationOptions.png]]

The annotation/sketch toolbars are used to add annotations and sketches/drawings to the capture. 

==== Drawing tools ====

{| cellspacing="10" cellpadding="2" border="0" align="left" width="407" style=""
|-
| [[Image:AnnotationOptionsRotated.png|left|18x98px]]
|
'''Rectangle:''' Use shift to draw a square 

'''Oval:''' Use shift to draw a circle '''Line:''' Use shift to limit drawing to one axis (X or Y) 

'''Arrow:''' Use shift to limit drawing to one axis (X or Y) '''Free: ''' Use this to draw irregular shapes 

|}

 

 

 

 

 

 

 

==== Drawing Styles ====

[[Image:CCTStylesDetail.png]] The style of the line can be one of 5 styles: 

*Continious
*Dash
*Dot
*Dash-Dot
*Dash-Dot-Dot

 

==== Line width ====

The linewidth of the sketch/drawing line can be alterd as well [[Image:CCT Linewidth.png]] 

==== Line/Text color ====

It's possible to alter the color of the annotation (sketch or text), when editing text changing the line coler takes effect immediatly.

==== Text size ====

The font of the annotation text cannot be altered and is fixed on <tt>Arial </tt>, the size however can be altered easily.

==== Editing tools ====

{| width="50%" cellspacing="2" cellpadding="1" border="0" align="left"
|-
| [[Image:CCT Text.png]] 
| Starts editing text Use shift-enter to add anew-line Use arrow keys to move the positioning of the text around 
|-
| [[Image:CCT Pan.png]] 
| Use this to move the preview window around, this is the default tool of the Annotation Sketch toolbar. It does not change the captured image. 
|-
| [[Image:CCT Undo.png]] 
| Use this to undo the last edit on the annotation/sketch (4 steps possible), use <ctrl-z> on [[Image:Logo.Windows.png]] and [[Image:Logo.Linux.png]] and <cmd-z> on [[Image:Logo.Mac.png]]. 
|-
| [[Image:CCT Clear.png]]
| Clear the annotation layer. 
|}

 

 

 

 

 

 

=== Help ===

The help button [[Image:CCT Help.png]] calls the about window of the CCT including a short description of the main functions, a link to the webpage, a list of know issues and licensing info.

=== Capture ===

The capture button [[Image:CCT Capture.png]] will capture the image, save it, copy to the clipboard, save the currently selected options for the next time and close the window. This can also be done by pressing Enter.

=== Clean up ===

The clean up button [[Image:CCTCleanUp.png]] will clean up the whole BD (if 'whole' is set as BD option) or the current selection (if 'Selections' is set as BD option). This button is only visible if this option is active (correct LabVIEW version).

=== Key navigation ===

The CCT has several key shortcuts for easier access:

{| class="wikitable"
|-
! Key
! Function
|-
| Enter
| Applies the current settings and does a [[Code Capture Tool#Capture|capture]] or finishes a current text edit 
|-
| F1
| Loads the about window centered on the help tab
|-
| F5
| Refreshes the current image
|-
| Escape
| Closes the CCT without performing a capture or finishes a current text/graph edit 
|}

== API ==

The API provides an interface to the various functions of the CCT. Its palette is accessible under [[User.lib]]\Code Capture Tool.

[[Image:CCT palette.PNG]]

{| class="wikitable"
|-
! [[#Methods|Methods]]
| <linkedimage>
img_src=Image:CCT_GetSessions.png
wikipage=Code_Capture_Tool#Create_CCT_Instance
</linkedimage>
| <linkedimage>
img_src=Image:CCT_Capture_icon.png
wikipage=Code_Capture_Tool#Capture_Image
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SaveImage.png
wikipage=Code_Capture_Tool#Save_Image
</linkedimage>
| <linkedimage>
img_src=Image:CCT_CopyToClipboard.png
wikipage=Code_Capture_Tool#Copy_to_Clipboard
</linkedimage>
| 
| <linkedimage>
img_src=Image:CCT_CloseSession.png
wikipage=Code_Capture_Tool#Destroy_CCT_Instance
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GenerateFileName.png
wikipage=Code_Capture_Tool#Generate_File_Name
</linkedimage>
|-
! [[#Set_properties|Set properties]]
| <linkedimage>
img_src=Image:CCT_SetFP.png
wikipage=Code_Capture_Tool#Set_Front_Panel_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SetBD.png
wikipage=Code_Capture_Tool#Set_Block_Diagram_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SetLayout.png
wikipage=Code_Capture_Tool#Set_Layout_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SetClipboard.png
wikipage=Code_Capture_Tool#Set_Clipboard_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SetVI.png
wikipage=Code_Capture_Tool#Set_VI_Ref
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SetFolder.png
wikipage=Code_Capture_Tool#Set_Folder
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SetFileName.png
wikipage=Code_Capture_Tool#Set_Filename
</linkedimage>
|-
! [[#Get_properties|Get properties]]
| <linkedimage>
img_src=Image:CCT_GetFP.png
wikipage=Code_Capture_Tool#Get_Front_Panel_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GetBD.png
wikipage=Code_Capture_Tool#Get_Block_Diagram_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GetLayout.png
wikipage=Code_Capture_Tool#Get_Layout_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GetClipboard.png
wikipage=Code_Capture_Tool#Get_Clipboard_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GetVI.png
wikipage=Code_Capture_Tool#Get_VI_Ref
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GetFolder.png
wikipage=Code_Capture_Tool#Get_Folder
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GetFileName.png
wikipage=Code_Capture_Tool#Get_Filename
</linkedimage>
|-
! [[#Support|Support]]
| <linkedimage>
img_src=Image:CCT_Support.png
wikipage=Code_Capture_Tool#Support
</linkedimage>
| 
| <linkedimage>
img_src=Image:CCT_CaptureFP.png
wikipage=Code_Capture_Tool#Capture_Front_panel
</linkedimage>
| <linkedimage>
img_src=Image:CCT_CaptureBD.png
wikipage=Code_Capture_Tool#Capture_Block_diagram
</linkedimage>
| <linkedimage>
img_src=Image:CCT_ShowGUI.png
wikipage=Code_Capture_Tool#Show_CCT_GUI
</linkedimage>
| <linkedimage>
img_src=Image:CCT_70Container.png
wikipage=Code_Capture_Tool#7.0_container_VI
</linkedimage>
| <linkedimage>
img_src=Image:CCT_80_Container.png
wikipage=Code_Capture_Tool#8.0_container_VI
</linkedimage>
|}

=== Methods ===

{| class="wikitable"
|-
! [[#Methods|Methods]]
| <linkedimage>
img_src=Image:CCT_GetSessions.png
wikipage=Code_Capture_Tool#Create_CCT_Instance
</linkedimage>
| <linkedimage>
img_src=Image:CCT_Capture_icon.png
wikipage=Code_Capture_Tool#Capture_Image
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SaveImage.png
wikipage=Code_Capture_Tool#Save_Image
</linkedimage>
| <linkedimage>
img_src=Image:CCT_CopyToClipboard.png
wikipage=Code_Capture_Tool#Copy_to_Clipboard
</linkedimage>
| <linkedimage>
img_src=Image:CCT_CloseSession.png
wikipage=Code_Capture_Tool#Destroy_CCT_Instance
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GenerateFileName.png
wikipage=Code_Capture_Tool#Generate_File_Name
</linkedimage>
|}

These VIs are used to activate methods for the CCT.

==== Create CCT Instance ====

[[Image:CCT Create CCT.png|Creat CCT Instance]]

This VI must be called for every instance of the CCT, it creates a GOOP dataspace that will contain the data of the instance. Calling this VI must be done with a valid VI reference.

==== Capture Image ====

[[Image:CCT Capture VI Images CCT.png|Capture Images]]

This VI will apply the current settings and store the captured image in the CCT instance, additionally it returns the image itself.

==== Save Image ====

[[Image:CCT Save Captured Image CCT.png|Save Image]]

This VI will save the image to the path specified by a folder and filename stored in the CCT instance.

==== Copy to Clipboard ====

[[Image:CCT Copy Data to Clipboard CCT.png|Copy to Clipboard]]

This VI will store the data specified by the clipboard settings to the clipboard.

==== Destroy CCT Instance ====

[[Image:CCT Destroy CCT.png|Destroy CCT Instance]]

This VI must be called to close the CCT Instance and will free up used memory resources.

==== Generate File Name ====

[[Image:CCT Generate File Name CCT.png|Generate filename]]

This VI will generate a default filename based on the captured parts and VI name. This filename will not be stored inside the CCT session.

=== Set properties ===

{| class="wikitable"
|-
! [[#Set_properties|Set properties]]
| <linkedimage>
img_src=Image:CCT_SetFP.png
wikipage=Code_Capture_Tool#Set_Front_Panel_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SetBD.png
wikipage=Code_Capture_Tool#Set_Block_Diagram_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SetLayout.png
wikipage=Code_Capture_Tool#Set_Layout_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SetClipboard.png
wikipage=Code_Capture_Tool#Set_Clipboard_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SetVI.png
wikipage=Code_Capture_Tool#Set_VI_Ref
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SetFolder.png
wikipage=Code_Capture_Tool#Set_Folder
</linkedimage>
| <linkedimage>
img_src=Image:CCT_SetFileName.png
wikipage=Code_Capture_Tool#Set_Filename
</linkedimage>
|}

These VIs are used to change properties for the CCT instance.

==== Set Front Panel Mode ====

[[Image:CCT Set FP Mode CCT.png|Set FP mode]]

This VI will change the current front panel capture mode.

==== Set Block Diagram Mode ====

[[Image:CCT Set BD Mode CCT.png|Set BD mode]]

This VI will change the current block diagram capture mode.

==== Set Layout Mode ====

[[Image:CCT Set Layout Mode CCT.png|Set Layout mode]]

This VI will change the current layout orientation.

==== Set Clipboard Mode ====

[[Image:CCT Set Clipboard Mode CCT.png|Set Clipboard mode]]

This VI will change the current clipboard mode.

==== Set VI Ref ====

[[Image:CCT Set VI Ref CCT.png|Set Clipboard mode]]

This VI sets the reference of the VI that needs to be captured

==== Set Folder ====

[[Image:CCT Set Folder CCT.png|Set Folder]]

This VI will change the folder where the images will be saved.

==== Set Filename ====

[[Image:CCT Set File CCT.png|Set Filename]]

This VI will change the filename of the stored image.

=== Get properties ===

{| class="wikitable"
|-
! [[#Get_properties|Get properties]]
| <linkedimage>
img_src=Image:CCT_GetFP.png
wikipage=Code_Capture_Tool#Get_Front_Panel_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GetBD.png
wikipage=Code_Capture_Tool#Get_Block_Diagram_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GetLayout.png
wikipage=Code_Capture_Tool#Get_Layout_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GetClipboard.png
wikipage=Code_Capture_Tool#Get_Clipboard_Mode
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GetVI.png
wikipage=Code_Capture_Tool#Get_VI_Ref
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GetFolder.png
wikipage=Code_Capture_Tool#Get_Folder
</linkedimage>
| <linkedimage>
img_src=Image:CCT_GetFileName.png
wikipage=Code_Capture_Tool#Get_Filename
</linkedimage>
|}

These VIs are used to retrieve properties from the CCT instance.

==== Get Front Panel Mode ====

[[Image:CCT Get FP Setting CCT.png|Get FP mode]]

This VI will read the current front panel capture mode.

==== Get Block Diagram Mode ====

[[Image:CCT Get BD Mode CCT.png|Get BD mode]]

This VI will read the current block diagram capture mode.

==== Get Layout Mode ====

[[Image:CCT Get Layout Mode CCT.png|Get Layout mode]]

This VI will read the current layout orientation.

==== Get Clipboard Mode ====

[[Image:CCT Get Clipboard Mode CCT.png|Get Clipboard mode]]

This VI will read the current clipboard mode.

==== Get VI Ref ====

[[Image:CCT Get VI Ref CCT.png|Get VI Reference]]

This VI returns a reference to the that is currently captured in this isntance

==== Get Folder ====

[[Image:CCT Get Folder CCT.png|Get Folder]]

This VI will read the folder where the images will be saved.

==== Get Filename ====

[[Image:CCT Get File CCT.png|Get Filename]]

This VI will read the filename of the stored image.

=== Support ===

{| class="wikitable"
|-
! [[#Support|Support]]
| <linkedimage>
img_src=Image:CCT_CaptureFP.png
wikipage=Code_Capture_Tool#Capture_Front_panel
</linkedimage>
| <linkedimage>
img_src=Image:CCT_CaptureBD.png
wikipage=Code_Capture_Tool#Capture_Block_diagram
</linkedimage>
| <linkedimage>
img_src=Image:CCT_ShowGUI.png
wikipage=Code_Capture_Tool#Show_CCT_GUI
</linkedimage>
| <linkedimage>
img_src=Image:CCT_70Container.png
wikipage=Code_Capture_Tool#7.0_container_VI
</linkedimage>
| <linkedimage>
img_src=Image:CCT_80_Container.png
wikipage=Code_Capture_Tool#8.0_container_VI
</linkedimage>
|}

This submenu shows additional low level functions of the CCT.

==== Capture Front panel ====

[[Image:CCT Capture Panel Picture CCT.png|Capture front panel]]

Use this VI to have direct access to the capturing of a front panel.

==== Capture Block diagram ====

[[Image:CCT Capture Diagram Picture CCT.png|Capture block diagram]]

Use this VI to have direct access to the capturing of a block diagram.

==== Show CCT GUI ====

[[Image:Code Capture Tool GUI CCT.png|Show CCT GUI]]

Use this VI to show the user interface of the CCT.

==== 7.0 container VI ====

[[Image:Container 70 CCT.png|7.0 container]]

Use this VI if you want to build a source distribution or an executable and need to make sure all dynamic VIs are included. For LabVIEW 7.0 and up.

==== 8.0 container VI (deprecated in version 2.0) ====

[[Image:Container 80 CCT.png|8.0 container]]

Use this VI if you want to build a source distribution or an executable and need to make sure all dynamic VIs are included. For LabVIEW 8.0 and up, don't forget to include the 7.0 container.

Version 2.0 of the Code Capture Tool installer will automatically select the correct container VI, so an additional 8.x container isn't needed anymore.

= Known issues =

{| class="wikitable"
|-
! Description
! Status
|-
| After using a non-default path and resetting it to the default, the new setting (temp) is not used
| Solved in version 1.0
|-
| Installing on Linux fails due to case sensitivity
| Solved in version 1.0
|-
| Capturing a non-visible part on a multi-pane front panel fails
| A limitation due to the LabVIEW implementation of panes, most-likely not fixable
|-
| Saving an empty image returns an error
| Solved in version 1.0
|-
| Opening the CCT from the Getting Started Window locks up LabVIEW
| Solved in version 1.0
|-
| Possible High use of memory
| Investigating
|-
| Impossible to capture FP of locked VI
| Investigating
|}

= Version History =

== Version 2.1.0 ==

Release date 15 February 2010

*Added a border around a snippet
*Altered GUI (Preview window is bigger)
*Better key handling with text annotation, support for HOME and END.
*Movement of text annotation with ctrl-left, ctrl-right, up and down
*Movement in a text annotation with left and right

== Version 2.0.5 ==

Release date 28 November 2009

*Bugfix release for bug [https://sourceforge.net/tracker/?func=detail&atid=996819&aid=2905411&group_id=206229 2905411].

== Version 2.0.0 ==

Release date 24 November 2009

*Support for VI snippet creation
*Support for adding comments and drawings

== Version 1.0.0 ==

Release date 27 February 2008

*Bug-fixes
*Support for panning of the preview

== Version 0.9.1 ==

Release date 7 November 2007

*Support for LabVIEW 7.x and up
*Support for all OS'es
*Support for orientation
*Support for selection
*Support for customized naming
*Support for customized folder

= Licensing =

The CCT is licensed under the BSD license

[[Category:Third_party_LabVIEW_tools]]

2010-05-11T17:02:38Z

Tcplomp: New page: In order to use a SCC tool with teststand sequence files, it's possible to use SeqFileDifferApp.exe deliverd by NI in the <Teststand&g...

In order to use a [[Source_Code_Control_Tools|SCC tool]] with [[teststand|teststand]] sequence files, it's possible to use SeqFileDifferApp.exe deliverd by [[NI|NI]] in the <Teststand>\bin folder. 

For [[TortoiseSVN_client_to_Subversion|TortoiseSVN]] the following settings can be used: 
<pre>"C:\Program Files\National Instruments\TestStand 4.2\Bin\SequenceFileDiffer.exe" %base %mine
</pre>
Reported by Asbo<ref>http://lavag.org/topic/12386-tortoisesvn-diff-with-teststand-sequences/page__view__findpost__p__74269</ref>

[[Category:SCC]]