%SYS
Period Class Reference

Defines time Periods for evaluation of Health Monitor Sensors. More...

Inheritance diagram for Period:
Collaboration diagram for Period:

Public Member Functions

_.Library.Status OnNew (_.Library.Integer rec, _.Library.Integer day, _.Library.Integer month, _.Library.Integer start, _.Library.Integer end, _.Library.String desc)
 Set the interval properties.
 

Static Public Member Functions

_.Library.Status Create (_.Library.Integer Rec, _.Library.String Start, _.Library.String End, _.Library.Integer Day, _.Library.String Desc, _.Library.Integer Month)
 Create a Period. More...
 
_.Library.Status Delete (_.Library.String PeriodId)
 Delete a Period.
 
_.Library.Status Modify (_.Library.Integer Period, _.Library.String Start, _.Library.String End, _.Library.Integer Day, _.Library.Integer Rec, _.Library.String Desc, _.Library.Integer Month)
 Modify a Period.
 

Public Attributes

 Day
 Day. More...
 
 Description
 Recurrance: More...
 
 EndTime
 End time. More...
 
 Month
 Month - Quarterly or yearly. More...
 
 Recurrence
 Recurrence - weekly-1, monthly-2, quarterly-3, yearly-4. More...
 
 StartTime
 Start time. More...
 

Detailed Description

Defines time Periods for evaluation of Health Monitor Sensors.

Default is 63 weekly periods, nine Periods for each day of the week.

Member Function Documentation

◆ Create()

Create a Period.

Start and End time is 24-hour time format.

Recurrence - weekly-1, monthly-2, quarterly-3, yearly-4 Day = day of week (1-7) for weekly recurrence, day of month (1-31 or 99 for "end of month") for all other recurrence.

Member Data Documentation

◆ Day

Day

Day.

1-7 for weekly, 1-31 or 99 for others

 

◆ Description

Description

Recurrance:

every day at (start/end), every week on day (default) every month on day of month or "last day of month" every 3 months (quarterly) on day of month or "last day of month" every year on month and day of month or "last day of month" Description of the interval  

◆ EndTime

EndTime

End time.

 

◆ Month

Month

Month - Quarterly or yearly.

 

◆ Recurrence

Recurrence

Recurrence - weekly-1, monthly-2, quarterly-3, yearly-4.

 

◆ StartTime

StartTime

Start time.