InterarrivalTimeHistogram Object


Description:

Inter-Arrival Time histogram configuration. Total, minimum, maximum, and average inter-arrival times, and 16 histogram bin counters can be retrieved from the results.

Automatically created from: AnalyzerConfig

Relations:

Side name
(Type)
Relative Description
ActiveParent
(ActiveHistogram)

AnalyzerConfig

Associates an active histogram configuration to the AnalyzerConfig object.

InterarrivalTimeHistogram Writable Attributes

Attribute Description
Common Writable Attributes Active, Name
BucketSizeList

List of bucket sizes when DistributionMode is CUSTOM_MODE and ConfigMode is CONFIG_SIZE_MODE. For example, a bucket size list as follows: "2 4 8 16 32 64 128 256 512 1024 2048 4096 8192 16384 32768 65536" has a first bucket of size 2, second bucket of size 4, and so on.

Type: double

Default: 0

BucketSizeUnit

Unit for the bucket size.

Type: enum

Default: TEN_NANOSECONDS

Possible Values:

Value Description
TEN_NANOSECONDS

Size unit in nanoseconds.

MICROSECONDS

Size unit in microseconds.

MILLISECONDS

Size unit in millseconds.

SECONDS

Size unit in seconds.

NONE

No size unit..

CenterPoint

Center point for the selected center mode.

Type: double

Default: 568

ConfigMode

Choose the configuration mode for the histogram buckets.

Type: enum

Default: CONFIG_SIZE_MODE

Possible Values:

Value Description
CONFIG_SIZE_MODE

Configure the histogram buckets using the bucket sizes.

CONFIG_LIMIT_MODE

Configure the histogram buckets using the upper limit values for each bucket.

Description

Description of the histogram configuration.

Type: string

Default: (ns)

DistributionMode

Select the distribution size mode when ConfigMode is CONFIG_SIZE_MODE. CUSTOM_MODE is the default distribution mode.

Type: enum

Default: CUSTOM_MODE

Possible Values:

Value Description
CENTERED_MODE

Bucket in the middle will be of DistributionModeSize and other buckets around it will be of UniformDistributionSize.

LEFT_MODE

Leftmost bucket will be of DistributionModeSize and other buckets will be of UniformDistributionSize.

RIGHT_MODE

Rightmost bucket will be of DistributionModeSize and other buckets will be of UniformDistributionSize.

CUSTOM_MODE

Custom distribution of the histogram buckets using the BucketSizeList.

AUTOMATIC_UNIFORM_MODE

Automatic uniform distribution of the histogram buckets using the BucketSizeList.

DistributionModeSize

Size of the bucket in the left, right, or center, according to the DistributionMode.

Type: double

Default: 1024

LimitList

List of limits when config mode is CONFIG_LIMIT_MODE. For example, a limit list as follows: "2 4 8 16 32 64 128 256 512 1024 2048 4096 8192 16384 32768" has the first bucket from 0 to 2, second bucket from 3 to 4, and so on.

Type: double

Default: 0

UniformDistributionSize

Size of the uniformly sized buckets. For example, if the DistributionMode is LEFT_MODE, then all the buckets, except the leftmost one, will be of UniformDistributionSize.

Type: double

Default: 8

InterarrivalTimeHistogram Read-Only Attributes

There are no read-only attributes.