com.inductiveautomation.ignition.common

Interface Diagnosable

All Known Subinterfaces:

AlarmEvaluator, HistoryEvaluator

All Known Implementing Classes:

AbstractClientSystemTag, AbstractClientTag, AppDescriptionTag, AppEditCountTag, AppNameTag, AppTitleTag, ClientTagFolder, ClientTimeTag, CurrentWindowTag, DateTimeFormatTag, DefaultDatabaseTag, DefaultTagProviderTag, GatewayAddressTag, GatewayRedundancyRoleTag, HistoryActorFactory.ArrayHistorizer, HistoryActorFactory.AtomicHistorizer, HistoryActorFactory.DelayedAtomicHistorizer, HostnameTag, IPAddressTag, LanguageTag, LastModifiedDateTag, LastModifiedUserTag, MACAddressTag, PollingClientSystemTag, ProjectTag, RolesDataSetTag, RolesStringTag, StaticClientSystemTag, SystemFlagsTag, SystemTagFolder, UserNameTag, UserSourceTag

public interface Diagnosable

Indicates that the object provides some sort of diagnostics information. When desired, the system will call sampleDiagnostics with a DiagnosticsSample.

Method Summary

Modifier and Type	Method and Description
void	sampleDiagnostics(DiagnosticsSample sample) Provides the sample upon which the object can set diagnostics information.

Method Detail

sampleDiagnostics

void sampleDiagnostics(DiagnosticsSample sample)

Provides the sample upon which the object can set diagnostics information. It is expected that the calling object will first call getSubSample() in order to specify a useful identifier for this object's data.