GenApi Grid Control Reference 14.1
Enumerations

Enumerations

enum  TMaxVisibility { MV_BEGINNER = 0 , MV_EXPERT = 1 , MV_GURU = 2 }
 Defines the maximum visibility level.
More...
 
enum  TNodeInfo {
}
 Defines commands to retrieve information about a NODE. More...
 

Detailed Description

Enumeration Type Documentation

◆ TMaxVisibility

Defines the maximum visibility level.

Enumerator
MV_BEGINNER 

Node is visible for all.

MV_EXPERT 

Node is visible for only experts and gurus.

MV_GURU 

Node is visible for gurus only.

◆ TNodeInfo

enum TNodeInfo

Defines commands to retrieve information about a NODE.

These commands define which kind of information is retrieved from a NODE.

See also:
GetInfoAsFloat
GetInfoAsInteger
GetInfoAsString
Enumerator
NI_Name 

Gets the full name of the node.

The full name can be used to uniquely identify a certain node.

It contains its namespace (Cust or Standard) and its name separated 
by a double colon (::).

This is a string value. 
NI_DisplayName 

Gets the display name of the node.

This is a readable name of the node.

This is a string value. 
NI_AccessMode 

Gets the TAccessMode of a node.

This is an integer value.  
NI_Max 

Gets the maximal possible value for the node.

This is an integer or float value depending on the \c TNodeType.  
NI_Min 

Gets the minimal possible value for the node.

This is an integer or float value depending on the \c TNodeType.    
NI_Increment 

Gets the increment value of the node.

All values of the node must be multiples of this value.

This is an integer value for the \c NT_Integer. 
NI_Streamable 

Gets whether the node is streamable.

This feature can be used to save settings of a device and restore 
them later.

Streamable nodes support being written to the device unvalidated. If 
the device supports it the register map can be checked after the 
complete write process. 

This is an integer value. 
NI_CachingMode 

Gets the TCachingMode.

This is an integer value. 
NI_Tooltip 

Gets the tooltip of the node.

The tooltip is a short descriptive text about the node and its 
function. 

This is a string value. 
NI_Description 

Gets the description of the node.

The description is a long descriptive text about the node and its 
function. 

This is a string value. 
NI_Visibility 

Gets the TMaxVisibility.

Recommended visibility level.

This is an integer value. 
NI_PollingTime 

Gets the polling time in ms for uncached nodes (0 for no polling).

The polling time is a hint in which intervals the client application should reread the value (update frequency).

This is an integer value.

NI_EventID 

Gets the event ID if any is available, otherwise it return an empty string.

This is a string value.