JCam DLL API Reference
tagProfile Struct Reference

Profile data from the scanner. More...

#include <jcam_dll.h>

Public Attributes

INT32 sequenceNumber
 Sequence number from Synchronized Scanning Mode. More...
 
INT32 location
 The encoder value when when the scanner created the profile. More...
 
INT32 sendLocation
 The encoder value when the scanner sent the profile. More...
 
INT32 laserOnTime
 The number of 10 microsecond units the laser was on. More...
 
INT32 timeInHead
 The time since the scanner was turned on. More...
 
INT32 inputs
 The status of all cable inputs to the scanner. More...
 
INT32 flags
 Information from the scanner. More...
 
INT32 laserIndex
 Currently unused. More...
 
INT32 reserved2
 Which laser this profile is from. More...
 
INT32 numberPoints
 The number of valid coordinate points in this profile. More...
 
ProfileDataPoint data [MAX_VERTICAL]
 Coordinates in 1000ths of an inch; i.e. 2000 is 2 inches. If units are set to metric units are micrometers, and 2000 in 2mm. More...
 

Detailed Description

Profile data from the scanner.

Member Data Documentation

◆ data

ProfileDataPoint tagProfile::data[MAX_VERTICAL]

Coordinates in 1000ths of an inch; i.e. 2000 is 2 inches. If units are set to metric units are micrometers, and 2000 in 2mm.

MAX_VERTICAL is defined in jsConstants.

◆ flags

INT32 tagProfile::flags

Information from the scanner.

If bit 0 is set, then Synchronized Scanning Mode scanning is trying to run faster than the scanner is capable and some data will be lost on one end of the laser line.
If bit 1 is set, this indicates that an internal error has occured in the scanner. Contact a JoeScan support engineer if you encounter this flag.
The remaining bits are reserved and values may change in future DLLs. So you should mask them to be ensure future firmware revision don't break your software.

◆ inputs

INT32 tagProfile::inputs

The status of all cable inputs to the scanner.

This 32 bit integer holds status of the encoder inputs and Start Scan line at the time the scan was taken. The value for the differential encoder inputs (0x20 and 0x40) should not be used by client code. The value of the Start Scan line is in bit 8 (0x80) and will be set to 1 for profiles taken while the line was pulled low, and 0 otherwise.

◆ laserIndex

INT32 tagProfile::laserIndex

Currently unused.

◆ laserOnTime

INT32 tagProfile::laserOnTime

The number of 10 microsecond units the laser was on.

◆ location

INT32 tagProfile::location

The encoder value when when the scanner created the profile.

◆ numberPoints

INT32 tagProfile::numberPoints

The number of valid coordinate points in this profile.

◆ reserved2

INT32 tagProfile::reserved2

Which laser this profile is from.

◆ sendLocation

INT32 tagProfile::sendLocation

The encoder value when the scanner sent the profile.

◆ sequenceNumber

INT32 tagProfile::sequenceNumber

Sequence number from Synchronized Scanning Mode.

Sequential jsProfile's during Synchronized Scanning Mode should have sequential sequenceNumber's. The counter is reset to 0 every time Synchronized Scanning Mode is restarted.

◆ timeInHead

INT32 tagProfile::timeInHead

The time since the scanner was turned on.

It is not the time of day, nor the current date.


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