Pleora Technologies Inc. eBUS SDK v6.2.8.5877 API



PvGenTypes.h File Reference

GenICam feature-related constants. More...

Go to the source code of this file.

Enumerations

enum  PvGenVisibility {
  PvGenVisibilityBeginner = 0, PvGenVisibilityExpert, PvGenVisibilityGuru, PvGenVisibilityInvisible,
  PvGenVisibilityUndefined = 999
}
 Feature (PvGenParameter object) visibility. More...
 
enum  PvGenType {
  PvGenTypeInteger = 0, PvGenTypeEnum, PvGenTypeBoolean, PvGenTypeString,
  PvGenTypeCommand, PvGenTypeFloat , PvGenTypeUndefined = 999
}
 Feature data type (Boolean, integer, etc.) More...
 
enum  PvGenRepresentation {
  PvGenRepresentationLinear = 0, PvGenRepresentationLogarithmic, PvGenRepresentationBoolean, PvGenRepresentationPureNumber,
  PvGenRepresentationHexNumber , PvGenRepresentationUndefined = 999
}
 
enum  PvGenRefresh { , PvGenRefreshPolling = 0, PvGenRefreshAuto, PvGenRefreshManual }
 Refresh method for a GenApi browser. More...
 

Detailed Description

GenICam feature-related constants.

Enumeration Type Documentation

◆ PvGenRefresh

Refresh method for a GenApi browser.

GenApi browsers typically provides different methods for refresh the parameters it is displaying.

Enumerator
PvGenRefreshPolling 

The polling time provided for parameters in the XML are used to control parameter refreshing.

PvGenRefreshAuto 

A round-robbin refresh is performed on all visible features.

PvGenRefreshManual 

Refresh is disabled. The browser may offer a manual Refresh button that can be used to control parameter refreshing.

◆ PvGenRepresentation

PvGenRepresentation suggests how the UI should present a numerical feature (PvGenInteger or PvGenFloat).

To get a feature's representation, use the following methods:

Enumerator
PvGenRepresentationLinear 

Linear. Use a slider.

PvGenRepresentationLogarithmic 

Logarithmic. Use a slider. The GenICam standard doesn't specify if the feature's value represents x or y in the formula x = n ^ y.

PvGenRepresentationBoolean 

Boolean. The number might be presented as a check box or enable. Use a similar UI as for features from the PvGenBoolean class.

PvGenRepresentationPureNumber 

Pure number. Use an edit box with a decimal display.

PvGenRepresentationHexNumber 

Hex number. Use an edit box with a hexadecimal display.

PvGenRepresentationUndefined 

Not defined; valid representation not provided.

◆ PvGenType

enum PvGenType

Feature data type (Boolean, integer, etc.)

Each feature has a type that defines the information it contains and how it can be used. The type also determines the eBUS SDK class used to represent it (and the methods that are available).

To test for a feature's type, use PvGenParameter::GetType.

Enumerator
PvGenTypeInteger 

Type: Integer
Class: PvGenInteger

PvGenTypeEnum 

Type: Enumeration
Class: PvGenEnum

PvGenTypeBoolean 

Type: Boolean
Class: PvGenBoolean

PvGenTypeString 

Type: String
Class: PvGenString

PvGenTypeCommand 

Type: Command
Class: PvGenCommand

PvGenTypeFloat 

Type: Float
Class: PvGenFloat

PvGenTypeUndefined 

Type: Not defined; valid type not provided.
Class: Not applicable.

◆ PvGenVisibility

Feature (PvGenParameter object) visibility.

Every feature has a visibility setting that suggests how difficult the feature is to use and when it shouldn't be made available (visible) to the end user. The current visibility might be a program-specific variable available, for example, in an options or configuration dialog. When opening the program for the first time, the visibility would typically be set to beginner.

You can test the feature-by-feature visibility using the following methods:

The visibility levels, from lowest to highest:

  1. Beginner (PvGenVisibilityBeginner)
  2. Expert (PvGenVisibilityExpert)
  3. Guru (PvGenVisibilityGuru)
  4. Invisible (PvGenVisibilityInvisible)

If a program's current visibility were set to Expert, the user would expect to see Beginner and Expert-level features, but not Guru or Invisible-level features.

Enumerator
PvGenVisibilityBeginner 

Always visible, to all users.

PvGenVisibilityExpert 

Intended for advanced users.

PvGenVisibilityGuru 

Intended for very advanced users.

PvGenVisibilityInvisible 

Appears in the API, but not the GUI.

PvGenVisibilityUndefined 

Not defined; valid visibility not provided.


Copyright (c) 2002-2021 Pleora Technologies Inc.
www.pleora.com