GenICam feature-related constants. More...

Enumerations
enum	PvGenVisibility { PvGenVisibilityBeginner = 0 , PvGenVisibilityExpert , PvGenVisibilityGuru , PvGenVisibilityInvisible , PvGenVisibilityUndefined = 999 }
	Feature (PvGenParameter object) visibility. More...

enum	PvGenType { PvGenTypeInteger = 0 , PvGenTypeEnum , PvGenTypeBoolean , PvGenTypeString , PvGenTypeCommand , PvGenTypeFloat , PvGenTypeRegister , PvGenTypeUndefined = 999 }
	Feature data type (Boolean, integer, etc.) More...

enum	PvGenRepresentation { PvGenRepresentationLinear = 0 , PvGenRepresentationLogarithmic , PvGenRepresentationBoolean , PvGenRepresentationPureNumber , PvGenRepresentationHexNumber , PvGenRepresentationIPV4Address , PvGenRepresentationMACAddress , PvGenRepresentationUndefined = 999 }

enum	PvGenNameSpace { PvGenNameSpaceStandard = 0 , PvGenNameSpaceCustom , PvGenNameSpaceUndefined = 999 }

enum	PvGenAccessMode { PvGenAccessModeReadOnly = 0 , PvGenAccessModeReadWrite = 1 , PvGenAccessModeWriteOnly = 2 , PvGenAccessModeNotImplemented = 3 , PvGenAccessModeNotAvailable = 4 , PvGenAccessModeUndefined = 999 }

enum	PvGenCache { PvGenCacheWriteThrough = 0 , PvGenCacheWriteAround , PvGenCacheNone , PvGenCacheUndefined = 999 }

enum	PvGenRefresh { PvGenRefreshInvalid = -1 , PvGenRefreshPolling = 0 , PvGenRefreshAuto , PvGenRefreshManual }
	Refresh method for a GenApi browser. More...

enum	PvGenEndianness { PvGenEndiannessInvalid = -1 , PvGenEndiannessLittle = 0 , PvGenEndiannessBig }

enum	PvGenSign { PvGenSignUndefined = -1 , PvGenSignUnsigned = 0 , PvGenSignSigned }

Detailed Description

GenICam feature-related constants.

Enumeration Type Documentation

◆ PvGenAccessMode

enum PvGenAccessMode

Enumerator
PvGenAccessModeReadOnly	Read only.
PvGenAccessModeReadWrite	Read and write.
PvGenAccessModeWriteOnly	Write only.
PvGenAccessModeNotImplemented	PvGenAccessMode has not been implemented.
PvGenAccessModeNotAvailable	PvGenAccessMode is not available.
PvGenAccessModeUndefined	PvGenAccessMode is not defined.

◆ PvGenCache

enum PvGenCache

Enumerator
PvGenCacheWriteThrough	PvGenCache is write though.
PvGenCacheWriteAround	PvGenCache is write around.
PvGenCacheNone	PvGenCache is none.
PvGenCacheUndefined	PvGenCache is undefined.

◆ PvGenEndianness

enum PvGenEndianness

Enumerator
PvGenEndiannessInvalid	Invalid endianness.
PvGenEndiannessLittle	Litte endianness.
PvGenEndiannessBig	Big endianness.

◆ PvGenNameSpace

enum PvGenNameSpace

Enumerator
PvGenNameSpaceStandard	Standard PvGenNameSpace.
PvGenNameSpaceCustom	Custom PvGenNamespace.
PvGenNameSpaceUndefined	Undefined PvGenNameSpace.

◆ PvGenRefresh

enum PvGenRefresh

Refresh method for a GenApi browser.

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

Enumerator
PvGenRefreshInvalid	Refresh mode is invalid.
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

enum 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.
PvGenRepresentationIPV4Address	IPv4 address. Use an edit box with an IP address dot-decimal display.
PvGenRepresentationMACAddress	MAC address. Use an edit box with a MAC address (e.g. 01-23-45-67-89-AB) display.
PvGenRepresentationUndefined	Not defined; valid representation not provided.

◆ PvGenSign

enum PvGenSign

Enumerator
PvGenSignUndefined	Undefined if it's signed.
PvGenSignUnsigned	Is not signed.
PvGenSignSigned	Is signed.

◆ 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.
PvGenTypeRegister	Type: Register Class: PvGenRegister.
PvGenTypeUndefined	Type: Not defined; valid type not provided. Class: Not applicable.

◆ PvGenVisibility

enum 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:

PvGenParameter::IsVisible
PvGenParameter::GetVisibility
PvGenEnumEntry::IsVisible (for enumeration entries)
PvGenEnumEntry::GetVisibility (for enumeration entries)

The visibility levels, from lowest to highest:

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.

eBUS SDK v7.0.1.7536 API

Enumerations