Class CIM_TimeZoneSettingData
extends CIM_SettingData

The TimeZone class is a set of properties that define a particular time zone. These properties include the concept of daylight saving time. If time zone is implemented, then there must be a current zone, as indicated using the IsCurrent property of the inherited ElementSettingData association. This class allows an application or client to pick the time zone that will be used for any related ManagedElements. The latter are defined by the Element SettingData association, based on the IsCurrent/IsDefault properties of the association. There should be an instance of TimeZoneSettingData for each zone supported by an element. If this class is implemented, then TimeService must also be implemented and available for a particular ManagedElement. Together the elements define the date and time. If the ElementSettingData instance that is associating the ManagedElement has the IsCurrent property set to true, then the TimeData parameter that is returned by the ManageTime method must reflect this zone when time data is requested.

Table of Contents
Hierarchy
Direct Known Subclasses
Class Qualifiers
Class Properties
Class Methods


Class Hierarchy

CIM_ManagedElement
   |
   +--CIM_SettingData
   |
   +--CIM_TimeZoneSettingData

Direct Known Subclasses

Class Qualifiers

NameData TypeValue
DescriptionstringThe TimeZone class is a set of properties that define a particular time zone. These properties include the concept of daylight saving time. If time zone is implemented, then there must be a current zone, as indicated using the IsCurrent property of the inherited ElementSettingData association. This class allows an application or client to pick the time zone that will be used for any related ManagedElements. The latter are defined by the Element SettingData association, based on the IsCurrent/IsDefault properties of the association. There should be an instance of TimeZoneSettingData for each zone supported by an element. If this class is implemented, then TimeService must also be implemented and available for a particular ManagedElement. Together the elements define the date and time. If the ElementSettingData instance that is associating the ManagedElement has the IsCurrent property set to true, then the TimeData parameter that is returned by the ManageTime method must reflect this zone when time data is requested.
Experimentalbooleantrue
UMLPackagePathstringCIM::Core::Settings
Versionstring2.10.0

Class Properties

Local Class Properties

NameData TypeDefault ValueQualifiers
NameData TypeValue
DaylightCaptionstring
DescriptionstringShort name of the "daylight" time zone (for example, EDT), suitable for presentation to the user in the default locale. Note that a specific DaylightCaption property is defined instead of using the inherited Caption. This definition is used to force consistent property naming for the StandardXXX and DaylightXXX properties.
DaylightDaysint8
DescriptionstringThere are two different interpretations for this property, depending on the value of DaylightDayOfWeek. In one case, DaylightDay defines the day-in-month on which daylight saving time starts. This interpretation is used when the DaylightDayOfWeek is 0. A positive or negative integer is specified to indicate whether the DaylightDay is calculated from the beginning or the end of the month. For example, 5 indicates the fifth day in the DaylightMonth and -1 indicates the last day in the DaylightMonth. When DaylightDayOfWeek is not 0, DaylightDay is the day in the month on which daylight saving time starts, as defined in conjunction with DaylightDayOfWeek. For example, if DaylightDay is 15 and DaylightDayOfWeek is Saturday, then daylight saving time starts on the first Saturday on or after the 15th day in the DaylightMonth (that is, the third Saturday in the month). If DaylightDay is 20 and DaylightDayOfWeek is -Saturday, then this indicates the first Saturday on or before the 20th day in the DaylightMonth. If DaylightDay is -1 and DaylightDayOfWeek is -Sunday, then this indicates the last Sunday in the month.
MaxValuesint6431
MinValuesint64-31
DaylightDayOfWeeksint8
DescriptionstringPositive or negative integer used in conjunction with DaylightDay to indicate the day of the week on which daylight saving time starts. Set DaylightDayOfWeek to 0 to indicate an exact day of the month, such as March 1. A positive integer (Sunday, Monday, and so on through Saturday) means that the day of the week is found on or after DaylightDay. A negative integer (-Sunday, -Monday, and so on through -Saturday) means that the day of the week is found on or before DaylightDay.
ValueMapstring-7, -6, -5, -4, -3, -2, -1, 0, 1, 2, 3, 4, 5, 6, 7
Valuesstring-Saturday, -Friday, -Thursday, -Wednesday, -Tuesday, -Monday, -Sunday, ExactDayOfMonth, Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday
DaylightMonthuint8
DescriptionstringThe month in which daylight saving time starts. Specify 0 for January, 1 for February, and so on.
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11
ValuesstringJanuary, February, March, April, May, June, July, August, September, October, November, December
DaylightNamestring
DescriptionstringFull name of the "daylight" time zone (for example, U.S. Eastern Daylight Saving Time), suitable for presentation to the user in the default locale.
DaylightOffsetsint32
DescriptionstringThe number of minutes by which this daylight saving time differs from UTC. For example, U.S. EDT differs from UTC by -4.0 hours or -240 minutes, whereas Australia Adelaide Daylight Time differs by 10.5 hours or 630 minutes.
PUnitstringminute
UnitsstringMinutes
DaylightStartIntervaldatetime
DescriptionstringThe time interval after midnight when daylight saving time starts. For example, 00000000020000.000000:000 indicates that daylight saving time starts at two o'clock, local time (usually, standard time).
StandardCaptionstring
DescriptionstringShort name of the "standard" time zone (for example, EST), suitable for presentation to the user in the default locale. Note that a specific StandardCaption property is defined, instead of using the inherited Caption. This definition is used to force consistent property naming for the StandardXXX and DaylightXXX properties.
StandardDaysint8
DescriptionstringThere are two different interpretations for this property, depending on the value of StandardDayOfWeek. In one case, StandardDay defines the day-in-month on which daylight saving time ends. This interpretation is used when the StandardDayOfWeek is 0. A positive or negative integer is specified to indicate whether the StandardDay is calculated from the beginning or the end of the month. For example, 5 indicates the fifth day in the StandardMonth and -1 indicates the last day in the StandardMonth. When StandardDayOfWeek is not 0, StandardDay is the day-in-month on which daylight saving time ends, as defined in conjunction with StandardDayOfWeek. For example, if StandardDay is 15 and StandardDayOfWeek is Saturday, then daylight saving time ends on the first Saturday on or after the 15th day in the StandardMonth (that is, the third Saturday in the month). If StandardDay is 20 and StandardDayOfWeek is -Saturday, then this indicates the first Saturday on or before the 20th day in the StandardMonth. If StandardDay is -1 and StandardDayOfWeek is -Sunday, then this indicates the last Sunday in the StandardMonth.
MaxValuesint6431
MinValuesint64-31
StandardDayOfWeeksint8
DescriptionstringPositive or negative integer used in conjunction with StandardDay to indicate the day of the week on which daylight saving time ends (and "standard" time begins). StandardDayOfWeek is set to 0 to indicate an exact day of the month, such as March 1. A positive integer (representing Sunday, Monday, and so on through Saturday) means that the day of the week is found on or after the specified StandardDay. A negative integer (representing -Sunday, -Monday and so on through -Saturday) means that the day of the week is found on or before the StandardDay.
ValueMapstring-7, -6, -5, -4, -3, -2, -1, 0, 1, 2, 3, 4, 5, 6, 7
Valuesstring-Saturday, -Friday, -Thursday, -Wednesday, -Tuesday, -Monday, -Sunday, ExactDayOfMonth, Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday
StandardMonthuint8
DescriptionstringThe month in which daylight saving time ends (and "standard" time begins). Specify 0 for January, 1 for February, and so on.
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11
ValuesstringJanuary, February, March, April, May, June, July, August, September, October, November, December
StandardNamestring
DescriptionstringFull name of the "standard" time zone (for example, U.S. Eastern Standard Time), suitable for presentation to the user in the default locale.
StandardOffsetsint32
DescriptionstringThe number of minutes by which this "standard" time differs from UTC. For example, U.S. EST differs from UTC by -5.0 hours or -300 minutes, whereas Australia Adelaide Standard Time differs by 9.5 hours or 570 minutes.
PUnitstringminute
UnitsstringMinutes
StandardStartIntervaldatetime
DescriptionstringThe time interval after midnight when daylight saving time ends. For example, 00000000020000.000000:000 indicates that daylight saving time ends at two o'clock, local time (usually, daylight saving time).

Inherited Properties

NameData TypeClass Origin
CaptionstringCIM_ManagedElement
ChangeableTypeuint16CIM_SettingData
ConfigurationNamestringCIM_SettingData
DescriptionstringCIM_ManagedElement
ElementNamestringCIM_SettingData
Generationuint64CIM_ManagedElement
InstanceIDstringCIM_SettingData
SoIDstringCIM_SettingData
SoOrgIDstringCIM_SettingData
ComponentSettingstring[]CIM_SettingData

Class Methods