2 defining exception dates – Echelon i.LON SmartServer 2.0 User Manual

Page 156

Advertising
background image

i.LON SmartServer 2.0 Programmer’s Reference

10-6

Property Description

<Schedule>

The <Schedule> element contains a series of child elements and
properties that define the dates that the exception applies to.
These are described in the next section, Defining Exception
Dates
.

10.3.2.2 Defining Exception Dates

The <Schedule> element contains a series of child elements and properties that define the dates that the
Calendar is active.

<Schedule>
<StartDate>
<UCPTdate>2008-03-14</UCPTdate>
<UCPTyearMask

LonFormat="UCPTyearMask">DW_NUL</UCPTyearMask>

<UCPTmonthMask

LonFormat="UCPTmonthMask">DW_NUL</UCPTmonthMask>

<UCPTdayMask

LonFormat="UCPTdayMask">DW_NUL</UCPTdayMask>

</StartDate>
<EndDate>
<UCPTdate>2037-03-31</UCPTdate>
<UCPTyearMask

LonFormat="UCPTyearMask">DW_WILDCARD</UCPTyearMask>

<UCPTmonthMask

LonFormat="UCPTmonthMask">DW_NUL</UCPTmonthMask>

<UCPTdayMask

LonFormat="UCPTdayMask">DW_NUL</UCPTdayMask>

</EndDate>
<UCPTschedDay

LonFormat="UCPTschedDay">DM_EVERY_WEEKDAY</UCPTschedDay>

<UCPTschedMonth

LonFormat="UCPTschedMonth">MN_EVERY_MONTH</UCPTschedMonth>

</Schedule>

The following table lists and describes the elements and properties in a <Schedule> element:

<StartDate>
<EndDate>

The <StartDate> and <EndDate> elements each contain the
following properties that define the start and end dates for the
exception:

• <UCPTdate> . The date the exception starts or ends in the

following format: YYYY-MM-DD.

• <UCPTyearMask>. Indicates whether the exception

applies to the years specified by the date range (DW_NUL),
or to all years (DW_WILDCARD).

• Setting the <StartDate> of <UCPTyearMask> to DW_

WILDCARD means that the starting year is 2000.

• Setting the <EndDate> of <UCPTyearMask> to DW_

WILDCARD means that the ending year is 2037.

• <UCPTmonthMask>. Indicates whether the exception

applies to the pattern of months specified by the date range
(DW_NUL), or to all months (DW_WILDCARD).

• Setting the <StartDate> of <UCPTmonthMask> to DW_

WILDCARD means that the starting month is January.

• Setting the <EndDate> of <UCPTmonthMask> to DW_

WILDCARD means that the ending month is December.

• <UCPTdayMask>. Indicates whether the exception applies

to the pattern of days marks specified by the date range
(DW_NUL), or to all days (DW_WILDCARD).

• Setting the <StartDate> of <UCPTdayMask> to DW_

Advertising