Visionscape Programmer's Kit (VSKit) Manual Visionscapevskitmanual

2016-08-18

• Visionscape® Programmer’s Kit (VSKit) Manual
  • Contents
  • PREFACE Welcome
    • Purpose of This Manual
    • Manual Conventions
    • Related Publications
      • Prerequisite Reading for C++ Programming
  • CHAPTER 1 Introduction
    • Visionscape® Architecture
    • Visionscape® Devices
    • Programming Language Considerations
      • Visual Basic 6, Service Pack 6
    • Common User Interface Scenarios
      • Scenario 1 — Simple GigE Camera Runtime User Interface
      • Scenario 2 — Smart Camera Runtime Monitoring Application
      • Scenario 3 — A Runtime User Interface w/Job Analysis Capability
      • Scenario 4 — A More Complex Runtime User Interface w/Maximum Control Over Image and Results Upload
        • Application Extras
  • CHAPTER 2 Jobs, Steps and Datums
    • Jobs and Job Files
    • Steps
    • Datums
    • Steplib and The Step Object
      • JobStep
      • The Step Object
        • Steps Are Collections
        • The Step Object Provides Many Properties That Describe the Step
        • The Step Object Has Many Methods for Finding Child Steps
        • Use Step Object to Add and Remove Steps From Your Job
        • Every Step Contains a Collection of Datums
      • The Major Properties That Describe A Step
      • Finding Steps in the Step Tree
      • Adding and Removing Steps
        • Accessing a Step’s Datum Values
        • Modifying Datum Values
    • Using StepBrowser to Look Up Symbolic Names
    • The JobStep Object
    • The VisionSystemStep Object
    • Step Object Properties
    • Step Object Methods
    • Datum Object Properties
    • Datum Object Methods
    • Step Handles: Converting to Step Objects
  • CHAPTER 3 Talking to Visionscape Hardware: VsCoordinator and VsDevice
    • Introduction to Visionscape® Device Objects (VSOBJ.DLL)
      • VsCoordinator
      • VsDevice
      • VsCoordinator and Device Discovery
      • Networked Device Discovery and UDPInfo
      • Device Focus
    • Connecting Jobs to Visionscape® Devices
    • What Else Can I Do With Device Objects?
    • A Detailed Look at VsDevice
      • Device Control Functions
        • Taking Control / Releasing Control of a Smart Camera
        • Start / Stop Inspections
        • Downloading a Job
        • Uploading a Job
    • Obtaining Device Information
      • Basic Device Information
      • DeviceClass Property
      • IsHostBased Property
      • Determining if any Inspections are Running
      • Device States
      • Special Device States
      • Determining the IO Capabilities of a Device
      • UDPInfo Available for Networked Devices
      • Retrieving Real Time Device Information
    • Namespace Information
    • VsNameNode
      • VsNameNode Properties
      • VsNameNode Methods
    • A Detailed Look at VsCoordinator
      • Device Collection
      • DeviceFocusSet
      • Grouping Controls Using GroupID
      • Device Focus Property
      • DeviceFocusSetOnDiscovery
      • Finding a Device by Name or IP
      • OnDeviceDiscovered Event
      • Using Message Broadcasting to Simplify Application Design
      • Global Strings
      • UpdateUI Method
      • LogMessage and the Debug Window
      • Using VsFunctions to Synchronize UI Elements
      • Getting Information About Local Network Interface Controllers
    • VsCoordinator Reference
      • Device Enumeration and Device Focus
      • UI Coordination
      • Miscellaneous
    • VsDevice Reference
      • Identification and Information
      • Download / Upload Job
      • Control
      • Advanced
  • CHAPTER 4 Viewing Images and Results with VSRunView Control
    • Visionscape® Runtime Toolkit
      • The VsRunView Control
      • Snap Buttons and Snap Views
        • Snap Buttons
        • Snap Views
        • Device Views and Report Views
    • A Simple Application
    • Other Features of VsRunKit
      • Showing and Hiding the Various Control Areas
      • Handling Reports Yourself
      • Opening all the Snapshot Views
      • Modifying the Image Layout
      • Automatically Saving and Restoring the Control Settings
      • Logging Results to File
        • AvpLogOptions
      • Look and Feel Features
  • CHAPTER 5 Using VsKit Components
    • Visionscape® Control Toolkit
      • A Simple Application
      • VsDeviceDropdown
        • OnFilterDevice Event
        • OnDeviceSelected Event
        • OnSelectedDeviceLost Event
        • AutoConnect Property
        • Device Property
        • GroupID Property
      • VsFilmstrip
        • FilmstripMode Property
        • AutoConnectInspection and AutoConnectBuffer Properties
        • AutoConnect Property
        • NewBufferDm Method
        • Clear Method
        • GroupID Property
        • OnNewReport Event — Sharing the AutoConnect Report Connection
      • VsReportConnection
        • Connect Method
        • IsConnected Property
        • Disconnect Method
        • Image Connections
        • DropWhenBusy Property
        • GraphicsOn Property
        • MaxRate Property
        • ExcludeImages Property
        • FreezeMode Property
        • DataRecordAdd Method
      • VsFileUtilities
        • Toolbar Example
      • VsView
      • VsTreeBrowser
      • VsDeviceButtons
      • VsDeviceBar
      • VsReport
      • VsChart
      • VsIOButtons
      • VsToolbar
  • CHAPTER 6 Using Report Connections
    • The AvpReportConnection Object
      • Creating a Report Connection
      • Connection Details
      • Adding Records to Your Report Programmatically
      • Adding Images to your Report
      • Adding All Snapshot Images by Analyzing the Job
      • Adding All Snapshot Images by Analyzing the Namespace
        • Now That I Have Images, How Do I Display Them?
    • Handling Inspection Reports: The AvpInspReport Object
      • Handling Inspection Results
      • Handling Inspection Statistics
      • Handling Images
        • Displaying Images
        • Saving Images to Disk
      • Performance Concerns?
    • Inspection Report Details
      • The AvpInspReport Object
      • AvpInspStats Object
      • AvpInspDataRecord Object
      • AvpMemStats
      • Part Queue Connections
      • AvpPartQueueConnection
  • CHAPTER 7 I/O Capabilities
    • The AVP I/O Library ActiveX Control
      • How to Use AvpIOClient
      • Setting Analog Outputs
      • Properties
      • Methods
      • Events
      • Error Codes
  • CHAPTER 8 Display and Setup Components
    • Buffer Manager ActiveX Control
      • Context Menu
      • Displaying an Image
      • Properties
      • Methods
      • Events
      • Error Codes
    • Setup Manager ActiveX Control
      • Random Access vs. Wizard Mode
      • Tryout Mode
      • Toolbar
      • Step and Train Buttons
      • Acquire Buttons
      • Wizard Training Complete
      • Tryout Buttons
      • Image Display
      • Tool Properties Display
      • Setup Item Checklist
      • Status Bar
      • Using Setup Manager in your Application
      • Properties
      • Methods
      • Events
      • Error Codes
    • Job Manager ActiveX Control
      • Job Tree
      • Context Menus
      • Step
      • Datum
      • Toolbar
      • Edit Parameters Window
      • Using Job Manager in your Application
      • Properties
      • Methods
      • Events
      • Error Codes
    • Datum Grid Active X Control
      • DatumGridLib
      • Using the Datum Grid in Your Application
      • Properties
      • Methods
      • Events
    • StepTreeView ActiveX Control
      • Theory Of Operations
      • Properties
      • Node Management Methods
      • Events
      • Error Codes
      • ISTVCustomHighlight Interface
      • Methods
  • APPENDIX A Examples
    • Example 1 — Load and Run
      • Loading, Connecting Hardware and Running
      • Add References and Components to Your Project
      • Name Your Project and Form
      • Drop the VsRunView Control on Your Main Form
      • Add Global Variables to frmMain
      • Add Code to the Form_Load Event
      • Stop Inspections in the Form_Unload Event
      • Compile and Run
      • Extras
        • Hide VsRunView Components
    • Example 2 — Monitor a Smart Camera
      • Discover, Connect to, and Monitor a Running Smart Camera
      • Add References and Components to your project
      • Name Your Project and Form
      • Drop the VsRunView Control on Your Main Form
      • Add Global Variables to frmMain
      • Add Code to the Form_Load Event
      • Attach VsRunView in the OnDeviceFocus Event
      • Size the VsRunView Control in Form_Resize
      • Compile and Run
      • Extras
        • Handle the Uploaded Results Yourself
        • Monitor Multiple Smart Cameras
        • Add IO Capabilities
  • APPENDIX B Legacy Controls
    • Calibration Manager ActiveX Control
      • Calibration Windows Wizard Dialog Boxes
      • Properties
      • Methods
      • Error Codes
    • Datum Manager ActiveX Control
      • Properties
      • Methods
      • Events
      • Error Codes
    • Message Scroll Window ActiveX Control
      • Properties
      • Methods
      • Events
      • Hooking DLLs for Internal Messages
      • Error Codes
    • Runtime Manager ActiveX Control
    • Converting Runtime Manager Applications to New Components
    • Runtime/Target Manager ActiveX Control
      • Toolbar
      • Connection Control
      • Inspection Control
      • Image Display Control
      • Report
      • Status Bar
      • Properties
      • Results Upload Methods
        • About Results Upload Methods
      • Events
      • Error Codes
  • APPENDIX C Advanced Datums
    • The DMR Tool’s VerifyDetails Datum
    • Changing the OCV Tool Layout String Using the “LayoutInfo” Datum
    • Changing the Camera Selection with the CamDefDm Datum
  • APPENDIX D Installed Sample Applications
    • Installing the Samples
    • AppRunner Source Code
    • VSRUNKIT Sample
      • Adv02_apprunnerlite
    • VSKIT Samples
      • Ex01_Simple
      • Ex02_Control
      • Ex03_Monitor
      • Ex04_Editor
      • Ex05_CreateAndControl
    • Extras
      • Adv01_Engine