Skip to content

AdvancedParameterAccessKey Class#

Provides advanced parameter information

Inheritance Hierarchy#

System.Object
  Basler.Pylon.AdvancedParameterAccessKey

Syntax#

C#

public static class AdvancedParameterAccessKey

VB

Public NotInheritable Class AdvancedParameterAccessKey

The AdvancedParameterAccessKey type exposes the following members.

Properties#

NameDescription
Public propertyStatic memberAccessMode The access mode of the parameter. The AccessMode parameter is writable. Valid values are NI (not implemented), NA (not available), WO (write only), RO (read only), and RW (read/write).
Public propertyStatic memberCachingMode Information on the caching mode.
Public propertyStatic memberDescription The description of the parameter.
Public propertyStatic memberDevicePortName The name of the device port.
Public propertyStatic memberDisplayName The displayed name of the parameter.
Public propertyStatic memberDisplayNotation Indicates how the parameter should be displayed.
Public propertyStatic memberDisplayPrecision The precision that should be used to display the parameter.
Public propertyStatic memberDocuURL The URL of the documentation.
Public propertyStatic memberEventID The event identifier.
Public propertyStatic memberIsAccessModeCacheable Indicates if the access mode value of the parameter is cacheable.
Public propertyStatic memberIsCacheable Indicates if the parameter value is cacheable.
Public propertyStatic memberIsDeprecated Indicates if the parameter is deprecated.
Public propertyStatic memberIsFeature Indicates if the parameter is a feature or an internal parameter.
Public propertyStatic memberIsStreamable Indicates if the parameter is streamable.
Public propertyStatic memberNamespace The namespace defining the parameter name.
Public propertyStatic memberPollingTime The interval between polling for the parameter value.
Public propertyStatic memberPrincipalInterfaceType The type of the principal interface.
Public propertyStatic memberRepresentation The string representation of the parameter value, depending on the parameter type (e.g. fixed or scientific notation for float parameters).
Public propertyStatic memberShortDescription The short description of the parameter, e.g. for display in a tool tip.
Public propertyStatic memberUnit The unit of the parameter.
Public propertyStatic memberVisibility The visibility level of the parameter. The Visibility parameter is writable. Valid values are 'Beginner', 'Expert', 'Guru', and 'Invisible'.
 

AdvancedParameterAccessKey.AccessMode Property#

The access mode of the parameter. The AccessMode parameter is writable. Valid values are NI (not implemented), NA (not available), WO (write only), RO (read only), and RW (read/write).

Syntax#

C#

public static string AccessMode { get; }

VB

Public Shared ReadOnly Property AccessMode As String
    Get

Property Value#

Type: String

AdvancedParameterAccessKey.CachingMode Property#

Information on the caching mode.

Syntax#

C#

public static string CachingMode { get; }

VB

Public Shared ReadOnly Property CachingMode As String
    Get

Property Value#

Type: String

AdvancedParameterAccessKey.Description Property#

The description of the parameter.

Syntax#

C#

public static string Description { get; }

VB

Public Shared ReadOnly Property Description As String
    Get

Property Value#

Type: String

AdvancedParameterAccessKey.DevicePortName Property#

The name of the device port.

Syntax#

C#

public static string DevicePortName { get; }

VB

Public Shared ReadOnly Property DevicePortName As String
    Get

Property Value#

Type: String

AdvancedParameterAccessKey.DisplayName Property#

The displayed name of the parameter.

Syntax#

C#

public static string DisplayName { get; }

VB

Public Shared ReadOnly Property DisplayName As String
    Get

Property Value#

Type: String

AdvancedParameterAccessKey.DisplayNotation Property#

Indicates how the parameter should be displayed.

Syntax#

C#

public static string DisplayNotation { get; }

VB

Public Shared ReadOnly Property DisplayNotation As String
    Get

Property Value#

Type: String

AdvancedParameterAccessKey.DisplayPrecision Property#

The precision that should be used to display the parameter.

Syntax#

C#

public static string DisplayPrecision { get; }

VB

Public Shared ReadOnly Property DisplayPrecision As String
    Get

Property Value#

Type: String

AdvancedParameterAccessKey.DocuURL Property#

The URL of the documentation.

Syntax#

C#

public static string DocuURL { get; }

VB

Public Shared ReadOnly Property DocuURL As String
    Get

Property Value#

Type: String

AdvancedParameterAccessKey.EventID Property#

The event identifier.

Syntax#

C#

public static string EventID { get; }

VB

Public Shared ReadOnly Property EventID As String
    Get

Property Value#

Type: String

AdvancedParameterAccessKey.IsAccessModeCacheable Property#

Indicates if the access mode value of the parameter is cacheable.

Syntax#

C#

public static string IsAccessModeCacheable { get; }

VB

Public Shared ReadOnly Property IsAccessModeCacheable As String
    Get

Property Value#

Type: String

AdvancedParameterAccessKey.IsCacheable Property#

Indicates if the parameter value is cacheable.

Syntax#

C#

public static string IsCacheable { get; }

VB

Public Shared ReadOnly Property IsCacheable As String
    Get

Property Value#

Type: String

AdvancedParameterAccessKey.IsDeprecated Property#

Indicates if the parameter is deprecated.

Syntax#

C#

public static string IsDeprecated { get; }

VB

Public Shared ReadOnly Property IsDeprecated As String
    Get

Property Value#

Type: String

AdvancedParameterAccessKey.IsFeature Property#

Indicates if the parameter is a feature or an internal parameter.

Syntax#

C#

public static string IsFeature { get; }

VB

Public Shared ReadOnly Property IsFeature As String
    Get

Property Value#

Type: String

AdvancedParameterAccessKey.IsStreamable Property#

Indicates if the parameter is streamable.

Syntax#

C#

public static string IsStreamable { get; }

VB

Public Shared ReadOnly Property IsStreamable As String
    Get

Property Value#

Type: String

AdvancedParameterAccessKey.Namespace Property#

The namespace defining the parameter name.

Syntax#

C#

public static string Namespace { get; }

VB

Public Shared ReadOnly Property Namespace As String
    Get

Property Value#

Type: String

AdvancedParameterAccessKey.PollingTime Property#

The interval between polling for the parameter value.

Syntax#

C#

public static string PollingTime { get; }

VB

Public Shared ReadOnly Property PollingTime As String
    Get

Property Value#

Type: String

AdvancedParameterAccessKey.PrincipalInterfaceType Property#

The type of the principal interface.

Syntax#

C#

public static string PrincipalInterfaceType { get; }

VB

Public Shared ReadOnly Property PrincipalInterfaceType As String
    Get

Property Value#

Type: String

AdvancedParameterAccessKey.Representation Property#

The string representation of the parameter value, depending on the parameter type (e.g. fixed or scientific notation for float parameters).

Syntax#

C#

public static string Representation { get; }

VB

Public Shared ReadOnly Property Representation As String
    Get

Property Value#

Type: String

AdvancedParameterAccessKey.ShortDescription Property#

The short description of the parameter, e.g. for display in a tool tip.

Syntax#

C#

public static string ShortDescription { get; }

VB

Public Shared ReadOnly Property ShortDescription As String
    Get

Property Value#

Type: String

AdvancedParameterAccessKey.Unit Property#

The unit of the parameter.

Syntax#

C#

public static string Unit { get; }

VB

Public Shared ReadOnly Property Unit As String
    Get

Property Value#

Type: String

AdvancedParameterAccessKey.Visibility Property#

The visibility level of the parameter. The Visibility parameter is writable. Valid values are 'Beginner', 'Expert', 'Guru', and 'Invisible'.

Syntax#

C#

public static string Visibility { get; }

VB

Public Shared ReadOnly Property Visibility As String
    Get

Property Value#

Type: String