Click or drag to resize

PingMonitoringRule Class

Controls for an individual ping monitor that is part of the Pc350v.

This class will trigger PingMonitoringRuleChange with events IDs defined in the PcX00 with Index is set to the corresponding monitor.

Inheritance Hierarchy
SystemObject
  Crestron.SimplSharpPro.GeneralIO.PowerConditionersPingMonitoringRule

Namespace: Crestron.SimplSharpPro.GeneralIO.PowerConditioners
Assembly: Crestron.SimplSharpPro.GeneralIO (in Crestron.SimplSharpPro.GeneralIO.dll) Version: 2.21.121
Syntax
C#
public class PingMonitoringRule : IParentInformation

The PingMonitoringRule type exposes the following members.

Properties
 NameDescription
Public propertyFailedPingAttemptsFeedback Property to indicate the number of ping failures. This value will be reset anytime a ping succeeds.

The PingMonitoringRuleChange event of the parent will trigger with FailedPingAttemptsFeedbackEventId.

Public propertyIncludedOutletsBitmask Collection of properties to select which outlets are controlled by this Rule (Least Significant Bit = Outlet1, Most Significant Bit = Outlet16 for item 1 and Least Significant Bit = Outlet17 for item 2 in the collection).
Public propertyIncludedOutletsBitmaskFeedback Collection of properties to report which outlets are controlled by this Rule (Least Significant Bit = Outlet1, Most Significant Bit = Outlet16 for item 1 and Least Significant Bit = Outlet17 for item 2 in the collection).

The PingMonitoringRuleChange event of the parent will trigger with PingIncludedOutletsBitmaskFeedbackEventId.

Public propertyOnOffFeedback Property to indicate that this rule is enabled.

The PingMonitoringRuleChange event of the parent will trigger with PingRuleOnOffFeedbackEventId.

Public propertyPingInterval Property to set the configurable delay between pings.
Public propertyPingIntervalFeedback Property to report the configurable delay between pings.

The PingMonitoringRuleChange event of the parent will trigger with PingIntervalFeedbackEventId.

Public propertyPingMonitoringTimeout Property to set the user configurable ping timeOut. Value between 1-60 seconds.
Public propertyPingMonitoringTimeoutFeedback Property to report the user configurable ping timeOut. Value between 1-60 seconds.

The PingMonitoringRuleChange event of the parent will trigger with PingMonitoringTimeoutFeedbackEventId.

Public propertyPingRetries Property to set the user configurable number of continuous ping failures to trigger power cycle.
Public propertyPingRetriesFeedback Property to report the user configurable number of continuous ping failures to trigger power cycle.

The PingMonitoringRuleChange event of the parent will trigger with PingRetriesFeedbackEventId.

Public propertyPowerUpWaitTime Property to set the user configurable wait time in minutes before executing Ping test once the specific outlet is power cycled [ note: prevent the device going into infinite power cycle loop].
Public propertyPowerUpWaitTimeFeedback Property to report the current user configurable wait time in minutes before executing Ping test once the specific outlet is power cycled.

The PingMonitoringRuleChange event of the parent will trigger with PingPowerUpWaitTimeFeedbackEventId.

Public propertyRebootAttempts Property to set the user configurable count for number of times the device will auto-reboot.
Public propertyRebootAttemptsFeedback Property to report the user configurable count for number of times the device will auto-reboot.

The PingMonitoringRuleChange event of the parent will trigger with PingRebootAttemptsFeedbackEventId.

Public propertyTarget Collection of properties to set the hostname or IP address of device to ping.
Public propertyTargetFeedback Collection of properties to report the hostname or IP address of device to ping.

The PingMonitoringRuleChange event of the parent will trigger with TargetFeedbackEventId.

Public propertyUserSpecifiedObject Object that can be set to aid in development.
Top
Methods
 NameDescription
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodOff Method to disable this rule.
Public methodOn Method to enable this rule.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Events
 NameDescription
Public eventPingMonitoringRuleChange Event triggered when a feedback has changed for this PingMonitoringRule.
Top
Fields
 NameDescription
Public fieldNumber Number of this PingMonitoringRule.
Public fieldParent Power conditioner that owns this PingMonitoringRule.
Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also