NI DIGITAL PATTERN DRIVER History RAM Attributes - ni/grpc-device GitHub Wiki

History RAM Attributes

NIDIGITAL_ATTRIBUTE_HISTORY_RAM_TRIGGER_TYPE

Specific Attribute:

Numeric Value 1150043
Datatype ViInt32
Access R/W
Applies to N/A
Coercion None
High-level Functions

niDigital_ConfigurePatternLabelHistoryRAMTrigger

niDigital_ConfigureCycleNumberHistoryRAMTrigger

niDigital_ConfigureFirstFailureHistoryRAMTrigger

Description:

Specifies the type of trigger condition on which History RAM starts acquiring pattern information.

Defined Values:
NIDIGITAL_VAL_FIRST_FAILURE (2200) Starts acquiring pattern information in History RAM on the first failed cycle in a pattern burst.
NIDIGITAL_VAL_CYCLE_NUMBER (2201) Starts acquiring pattern information in History RAM starting from a specified cycle number.
NIDIGITAL_VAL_PATTERN_LABEL (2202) Starts acquiring pattern information in History RAM starting from a specified pattern label, augmented by vector and cycle offsets.

NIDIGITAL_ATTRIBUTE_CYCLE_NUMBER_HISTORY_RAM_TRIGGER_CYCLE_NUMBER

Specific Attribute:

Numeric Value 1150044
Datatype ViInt64
Access R/W
Applies to N/A
Coercion None
High-level Functions niDigital_ConfigureCycleNumberHistoryRAMTrigger

Description:

Specifies the cycle number on which History RAM starts acquiring pattern information when configured for a cycle number trigger.

NIDIGITAL_ATTRIBUTE_PATTERN_LABEL_HISTORY_RAM_TRIGGER_VECTOR_OFFSET

Specific Attribute:

Numeric Value 1150052
Datatype ViInt64
Access R/W
Applies to N/A
Coercion None
High-level Functions niDigital_ConfigurePatternLabelHistoryRAMTrigger

Description:

Specifies the number of vectors that follow the specified pattern label, after which History RAM will start acquiring pattern information when configured for a pattern label trigger.

NIDIGITAL_ATTRIBUTE_PATTERN_LABEL_HISTORY_RAM_TRIGGER_CYCLE_OFFSET

Specific Attribute:

Numeric Value 1150045
Datatype ViInt64
Access R/W
Applies to N/A
Coercion None
High-level Functions niDigital_ConfigurePatternLabelHistoryRAMTrigger

Description:

Specifies the number of cycles that follow the specified pattern label and vector offset, after which History RAM will start acquiring pattern information when configured for a pattern label trigger.

NIDIGITAL_ATTRIBUTE_PATTERN_LABEL_HISTORY_RAM_TRIGGER_LABEL

Specific Attribute:

Numeric Value 1150046
Datatype ViString
Access R/W
Applies to N/A
Coercion None
High-level Functions niDigital_ConfigurePatternLabelHistoryRAMTrigger

Description:

Specifies the pattern label, augmented by the vector and cycle offset, to determine the point where History RAM will start acquiring pattern information when configured for a pattern label trigger.

NIDIGITAL_ATTRIBUTE_HISTORY_RAM_CYCLES_TO_ACQUIRE

Specific Attribute:

Numeric Value 1150047
Datatype ViInt32
Access R/W
Applies to N/A
Coercion None
High-level Functions niDigital_ConfigureHistoryRAMCyclesToAcquire

Description:

Configures which cycles History RAM acquires after the trigger conditions are met. If you configure History RAM to only acquire failed cycles, you must set the pretrigger samples for History RAM to 0.

Defined Values:
NIDIGITAL_VAL_FAILED_CYCLES (2303) Only acquires cycles that fail a compare after the triggering conditions are met.
NIDIGITAL_VAL_ALL_CYCLES (2304) Acquires all cycles after the triggering conditions are met.

NIDIGITAL_ATTRIBUTE_HISTORY_RAM_PRETRIGGER_SAMPLES

Specific Attribute:

Numeric Value 1150048
Datatype ViInt32
Access R/W
Applies to N/A
Coercion None
High-level Functions

niDigital_ConfigurePatternLabelHistoryRAMTrigger

niDigital_ConfigureCycleNumberHistoryRAMTrigger

niDigital_ConfigureFirstFailureHistoryRAMTrigger

Description:

Specifies the number of samples to acquire before the trigger conditions are met. If you configure History RAM to only acquire failed cycles, you must set the pretrigger samples for History RAM to 0.

NIDIGITAL_ATTRIBUTE_HISTORY_RAM_MAX_SAMPLES_TO_ACQUIRE_PER_SITE

Specific Attribute:

Numeric Value 1150077
Datatype ViInt32
Access R/W
Applies to N/A
Coercion Yes
High-level Functions N/A

Description:

Specifies the maximum number of History RAM samples to acquire per site. If the property is set to -1, it will acquire until the History RAM buffer is full.

NIDIGITAL_ATTRIBUTE_HISTORY_RAM_NUMBER_OF_SAMPLES_IS_FINITE

Specific Attribute:

Numeric Value 1150078
Datatype ViBoolean
Access R/W
Applies to N/A
Coercion None
High-level Functions N/A

Description:

Specifies whether the instrument acquires a finite number of History RAM samples or acquires continuously.

The maximum number of samples that will be acquired when this property is set to VI_TRUE is determined by the instrument History RAM depth specification and the History RAM Max Samples to Acquire Per Site property.

Valid Values:
VI_TRUE Specifies that History RAM results will not stream into the host buffer until a History RAM fetch API is called.
VI_FALSE Specifies that History RAM results will automatically start streaming into a host buffer after a pattern is burst and the History RAM has triggered.
Default Value:
VI_TRUE

NIDIGITAL_ATTRIBUTE_HISTORY_RAM_BUFFER_SIZE_PER_SITE

Specific Attribute:

Numeric Value 1150079
Datatype ViInt64
Access R/W
Applies to N/A
Coercion None
High-level Functions N/A

Description:

Specifies the size, in samples, of the host memory buffer.

Valid Values:
0-INT64_MAX
Default Value:
32,000
⚠️ **GitHub.com Fallback** ⚠️