AFTimeRule Properties
- Last UpdatedNov 18, 2025
- 4 minute read
- PI System
- AF SDK 2024 R2
- Developer
The AFTimeRule type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
| AdditionalInfo |
This property represents the additional information associated with the event.
| |
| Analysis |
This property returns the analysis that owns this object.
| |
| AnalysisTemplate |
This property returns the analysis template that owns this object.
| |
| ConfigString |
This property represents the current configuration of the Time Rule as a string suitable
for displaying to an end-user and/or setting its configuration.
| |
| ConfigStringStored |
Returns the currently stored configuration string.
| |
| Database |
This read-only property returns the AFDatabase where this object is defined.
| |
| Description |
Read-only property that provides more detailed description of the object.
| |
| DisplayString |
Returns the configuration of the AFTimeRule for display purposes.
| |
| EditorType |
This method returns the Type of the editor that is used to configure this
time rule.
| |
| HasChildren | Obsolete.
This read-only property returns if the time rule has child time rules.
| |
| ID |
Read-only property that provides a unique identifier for the object to be used for
quick access that is not dependent upon the index.
(Inherited from AFObject.) | |
| Identity |
This read-only property contains identity of the object.
(Inherited from AFObject.) | |
| IsConfigured |
This method returns if the time rule instance is properly configured.
| |
| IsDeleted |
This read-only property indicates whether the object has been deleted.
(Inherited from AFObject.) | |
| IsInitializing |
Indicates that the AFTimeRule is in the process
of being initialized.
| |
| MergeDuplicatedItems |
When the same event is generated by multiple time rules, should we merge them? An event is considered the same
if its start and end times are the same.
| |
| Name |
Read-only property that identifies the name of the object.
| |
| Parent | Obsolete.
Returns the parent time rule which owns this time rule.
| |
| PISystem |
This read-only property allows access to the PISystem associated with this
object.
(Inherited from AFObject.) | |
| PlugIn |
This read-only property returns the AFPlugIn used to create
this instance of the plugin.
| |
| SimplifiedConfigString |
This property presents a simplified view of the current configuration of the Time Rule
that is easier for users to edit and that does not contain redundant information (e.g. IDs for resolution).
| |
| TimeRules | Obsolete.
This read-only property returns the child time rules.
| |
| UniqueID |
Read-only property that provides the object's ID as a String.
(Inherited from AFObject.) |
See Also
In This Topic
Related Links
- AdditionalInfo Property
- Analysis Property
- AnalysisTemplate Property
- ConfigString Property
- ConfigStringStored Property
- Database Property
- Description Property
- DisplayString Property
- EditorType Property
- HasChildren Property
- IsConfigured Property
- IsInitializing Property
- MergeDuplicatedItems Property
- Name Property
- Parent Property
- PlugIn Property
- SimplifiedConfigString Property
- TimeRules Property