HighResolutionSamplingPortConfig Object


Description:

Configuration parameters for port-level high resolution measurement.

Automatically created from: Analyzer

Result children (automatically created): HighResolutionSamplingPortResults

Relations:

Side name
(Type)
Relative Description
PfcConfig
(AffiliatedPfcTrigger)

PfcMeasurementConfig

ResultChild
(ResultChild)

HighResolutionSamplingPortResults

Use this to connect a results object to an object.

HighResolutionSamplingPortConfig Writable Attributes

Attribute Description
Common Writable Attributes Active, Name
BaselineSampleCount

Number of samples used to calculate the trigger value.

Type: u8

Default: 3

Range: 1 - 255

EnableTrigger

Whether triggering should be enabled or disabled.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Enable triggering.

FALSE

Disable triggering.

SamplingDuration

Duration of the sample polling period in ms.

Type: u16

Default: 10

Range: 1 - 100

SamplingInterval

Interval for polling the samples in ms.

Type: u16

Default: 10

Range: 1 - 100

TimingMode

Mode used for timing purposes.

Type: enum

Default: INTERVAL

Possible Values:

Value Description
INTERVAL

Interval timing mode.

DURATION

Duration timing mode.

TriggerCondition

Condition to apply the statistic.

Type: enum

Default: LESS_THAN

Possible Values:

Value Description
LESS_THAN

Less than condition.

LESS_THAN_OR_EQUAL

Less than or equal to.

GREATER_THAN

Greater than.

GREATER_THAN_OR_EQUAL

Greater than or equal to.

EQUAL

Equal to.

NOT_EQUAL

Not equal to.

TriggerLocation

Trigger location.

Type: u8

Default: 20

Range: 0 - 99

TriggerStat

What statistic to use for triggering.

Type: string

Default: TotalFrameRate

TriggerValue

Value to use for the trigger.

Type: double

Default: 95

TriggerValueUnitMode

Type of trigger value.

Type: enum

Default: PERCENT_BASELINE

Possible Values:

Value Description
PERCENT_BASELINE

Percent of baseline.

ABSOLUTE

Absolute value.

KILOBITS_PER_SECOND

Bit rate in Kbps.

MEGABITS_PER_SECOND

Bit rate in Mbps.

GIGABITS_PER_SECOND

Bit rate in Gbps.

HighResolutionSamplingPortConfig Read-Only Attributes

Read-Only Attribute Description
BufferingState

Stored buffer state.

Type: enum

Default: READY

Possible Values:

Value Description
READY

Ready

FILLED

Filled

RUNNING

Running

PENDING_START

Starting

PENDING_STOP

Stopping

EventTriggeredStatus

Trigger status.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Enabled

FALSE

Disabled

TotalSamples

Total number of samples supported for port high resolution.

Type: u16

Default: 1000

Range: 1 - 1000