PingReport Object


Description:

Provides a Ping summary after each Ping command.

Automatically created from: Port

Relations:

Side name
(Type)
Relative Description
ResultParent
(ResultChild)

Port

Use this to connect a results object to an object.

PingReport Writable Attributes

Attribute Description
Common Writable Attributes Active, Name

PingReport Read-Only Attributes

Read-Only Attribute Description
AttemptedPingCount

Total number of attempted Pings.

Type: u32

Default: 0

FailedPingCount

Total number of failed Pings.

Type: u32

Default: 0

PingResult

Ping output prompt message.

Type: string

Default: "" (empty string)

PingStatus

Ping status string from the PingStart command. This is constantly updated as Pings continue.

Type: enum

Default: IDLE

Possible Values:

Value Description
IDLE

Ping is not in progress.

INPROGRESS

Ping is in progress.

SUCCESSFUL

Ping is successful.

FAILURE

Ping failed.

SuccessfulPingCount

Total number of successful Pings.

Type: u32

Default: 0