Click or drag to resize
OSIsoft, LLC

AFTimeZone Class

Represents information about a time zone.

Inheritance Hierarchy

Namespace:  OSIsoft.AF.Time
Assembly:  OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 2.10.8.440
Syntax
[SerializableAttribute]
public sealed class AFTimeZone : TimeZone, 
	ISerializable, IComparable, IComparable<AFTimeZone>, IEquatable<AFTimeZone>

The AFTimeZone type exposes the following members.

Constructors
  NameDescription
Public methodAFTimeZone
Creates a new AFTimeZone instance representing the current time zone of the local computer system.
Top
Properties
  NameDescription
Public propertyBaseUtcOffset
Gets the time difference between the current time zone's standard time and Coordinated Universal Time (UTC).
Public propertyStatic memberCurrentAFTimeZone
Returns the AFTimeZone representing the current time zone of the local computer system.
Public propertyDaylightName
Gets the localized display name for the current time zone's daylight saving time.
(Overrides TimeZoneDaylightName.)
Public propertyDisplayName
The localized general display name that represents the time zone.
Public propertyName
The invariant culture name of the time zone.
Public propertyStandardName
Gets the localized display name for the time zone's standard time.
(Overrides TimeZoneStandardName.)
Public propertySupportsDaylightSavingsTime
Get a value indicating whether the time zone has any daylight saving time rules.
Public propertyStatic memberUtcTimeZone
Returns the AFTimeZone representing Coordinated Universal Time (UTC) zone.
Top
Methods
  NameDescription
Public methodStatic memberClearCachedData
Clears cached time zone data.
Public methodCompareTo(Object)
Compares this instance with a specified Object.
Public methodCompareTo(AFTimeZone)
Compares this instance with a specified AFTimeZone.
Public methodStatic memberCreateCustomTimeZone
Creates a custom AFTimeZone with a specified identifier, an offset from Coordinated Universal Time (UTC), a display name, a standard time name, a daylight savings time name, daylight saving time rules, and a value indicates whether the returned object reflects daylight saving time information.
Public methodEquals(Object)
Determines whether the specified Object is equal to the current object.
(Overrides ObjectEquals(Object).)
Public methodEquals(AFTimeZone)
Indicates whether the current object is equal to another object of the same type.
Public methodStatic memberFromName
Gets a AFTimeZone which corresponds to the specified time zone invariant culture name.
Public methodGetDaylightChanges
Returns the daylight saving time period for a particular year.
(Overrides TimeZoneGetDaylightChanges(Int32).)
Public methodGetHashCode
Gets the hash code for this instance of the object which is suitable for use in hashing algorithms and data structures like a hash table.
(Overrides ObjectGetHashCode.)
Public methodStatic memberGetSystemTimeZones
Retrieves a list of AFTimeZone objects by pulling values from the registry.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetUtcOffset
Calculates the offset or difference between the time in this time zone and the Coordinated Universal Time (UTC) for a particular date and time.
(Overrides TimeZoneGetUtcOffset(DateTime).)
Public methodIsDaylightSavingTime
Returns a value indicating whether a specified date and time is within a daylight savings time period.
(Overrides TimeZoneIsDaylightSavingTime(DateTime).)
Public methodStatic memberLoadSystemTimeZones
Load the system time zones from XML.
Public methodStatic memberSaveSystemTimeZones
Save the system time zones to XML.
Public methodToLocalTime(DateTime)
Returns the local time that corresponds to a specified time.
(Overrides TimeZoneToLocalTime(DateTime).)
Public methodStatic memberToLocalTime(AFTimeZone, DateTime)
Convert a DateTime to the specified AFTimeZone.
Public methodToString
Returns a String that represents the current object.
(Overrides ObjectToString.)
Public methodToString(IFormatProvider)
Returns a String that represents the current object.
Public methodToUniversalTime(DateTime)
Returns the Coordinated Universal Time (UTC) that corresponds to a specified time.
(Overrides TimeZoneToUniversalTime(DateTime).)
Public methodStatic memberToUniversalTime(AFTimeZone, DateTime)
Convert a DateTime from the specified AFTimeZone.
Top
Operators
  NameDescription
Public operatorStatic memberEquality
The equality operator (==) compares its operands to determine if they are equal.
Public operatorStatic memberGreaterThan
The greater than relation operator (>) compares its operands to determine which one is greater than the other.
Public operatorStatic memberGreaterThanOrEqual
The greater than or equal relation operator (>=) compares its operands to determine which one is greater than or equal to the other.
Public operatorStatic member(TimeZoneInfo to AFTimeZone)
Implicit cast operator to convert a TimeZoneInfo to an AFTimeZone.
Public operatorStatic member(AFTimeZone to TimeZoneInfo)
Implicit cast operator to convert an AFTimeZone to a TimeZoneInfo.
Public operatorStatic memberInequality
The inequality operator (!=) compares its operands to determine if they are not equal.
Public operatorStatic memberLessThan
The less than relation operator (<) compares its operands to determine which one is less than the other.
Public operatorStatic memberLessThanOrEqual
The less than or equal relation operator (<=) compares its operands to determine which one is less than or equal to the other.
Top
Remarks

A time zone is a geographical region in which the same standard time is used.

This is an extension of the TimeZone class provided by the .NET Framework that provides methods to convert a time between the specified time zone's local time (see ToLocalTime Overload and ToUniversalTime Overload). This class also provides the GetSystemTimeZones method to get a list of all the currently defined time zones.

Important note Important
The implementation of this class uses the .NET Framework class TimeZoneInfo. Therefore, adjustment rules created for the TimeZoneInfo class will be used by this class.

Version Information

AFSDK

Supported in: 2.10.5, 2.10, 2.9.5, 2.9, 2.8.5, 2.8, 2.7.5, 2.7, 2.6, 2.5, 2.4
See Also
Enabling Operational Intelligence