Class TimeDurationClass

Namespace
ESRI.ArcGIS.esriSystem
Assembly
ESRI.Server.System.dll
[Guid("09692C1C-21FA-4FE2-8EFA-6C4ACB59A323")]
[ClassInterface(ClassInterfaceType.None)]
public class TimeDurationClass : TimeDuration, ITimeDuration, IXMLSerialize, IXMLVersionSupport, IClone, IPersistStream, IPersist, IDocumentVersionSupportGEN
Inheritance
TimeDurationClass
Implements
Inherited Members

Constructors

TimeDurationClass()

public TimeDurationClass()

Explicit Interface Implementations

AddDays(double)

Adds the input amount of days to the time duration.

virtual void AddDays(double Value)

Parameters

Value double

AddDuration(ITimeDuration)

Adds a time duration.

virtual void AddDuration(ITimeDuration TimeDuration)

Parameters

TimeDuration ITimeDuration

AddHours(double)

Adds the input amount of hours to the time duration.

virtual void AddHours(double Value)

Parameters

Value double

AddMilliseconds(double)

Adds the input amount of milliseconds to the time duration.

virtual void AddMilliseconds(double Value)

Parameters

Value double

AddMinutes(double)

Adds the input amount of minutes to the time duration.

virtual void AddMinutes(double Value)

Parameters

Value double

AddNanoseconds(long)

Adds the input amount of nanoseconds to the time duration.

virtual void AddNanoseconds(long Value)

Parameters

Value long

AddSeconds(double)

Adds the input amount of seconds to the time duration.

virtual void AddSeconds(double Value)

Parameters

Value double

AddWeeks(double)

Adds the input amount of weeks to the time duration.

virtual void AddWeeks(double Value)

Parameters

Value double

Assign(IClone)

Assigns the properties of src to the receiver.

virtual void Assign(IClone src)

Parameters

src IClone

Clone()

Clones the receiver and assigns the result to *clone.

virtual IClone Clone()

Returns

IClone

Compare(ITimeDuration)

Compares this time duration to the other time duration. Returns -1 if this time duration's value is less, 1 if greater, and 0 otherwise.

virtual int Compare(ITimeDuration otherDuration)

Parameters

otherDuration ITimeDuration

Returns

int

ConvertToSupportedObject(esriArcGISVersion)

Convert the object to another object that is supported.

virtual object ConvertToSupportedObject(esriArcGISVersion docVersion)

Parameters

docVersion esriArcGISVersion

Returns

object

Remarks

This method should be used when IDocumentVersionSupportGEN::IsSupportedAtVersion returns FALSE.  Calling ConvertToSupportedObject will return an IUnknown pointer to a relevant object supported at the particular ArcGIS version.  Not all objects will return a supported object; in these cases a null pointer will be returned.

Days

The time duration days component.

virtual int Days { get; set; }

Returns

int

Deserialize(IXMLSerializeData)

Deserializes an object from XML.

virtual void Deserialize(IXMLSerializeData data)

Parameters

data IXMLSerializeData

GetClassID(out Guid)

virtual void GetClassID(out Guid pClassID)

Parameters

pClassID Guid

GetSizeMax(out _ULARGE_INTEGER)

virtual void GetSizeMax(out _ULARGE_INTEGER pcbSize)

Parameters

pcbSize _ULARGE_INTEGER

Hours

The time duration hours component.

virtual int Hours { get; set; }

Returns

int

IsDirty()

virtual void IsDirty()

IsEqual(IClone)

Indicates if the receiver and other have the same properties.

virtual bool IsEqual(IClone other)

Parameters

other IClone

Returns

bool

IsIdentical(IClone)

Indicates if the receiver and other are the same object.

virtual bool IsIdentical(IClone other)

Parameters

other IClone

Returns

bool

IsSupportedAtVersion(esriArcGISVersion)

Is this object valid at the given document version.

virtual bool IsSupportedAtVersion(esriArcGISVersion docVersion)

Parameters

docVersion esriArcGISVersion

Returns

bool

Remarks

Use IsSupportedAtVersion to identify if a particular object should be saved to the ObjectStream.  This result is based on the esriArcGISVersion enumeration.  In some instances, if the object is not supported at a particular ArcGIS version, the object may support conversion to another similar object; use IDocumentVersionSupportGEN::ConvertToSupportedObject to accomplish this.

IsZero()

Indicates whether the time duration's value is zero.

virtual bool IsZero()

Returns

bool

Load(IStream)

virtual void Load(IStream pstm)

Parameters

pstm IStream

MinNamespaceSupported

The minimum namespace the class can serialize to (eg the 90 namespace).

virtual string MinNamespaceSupported { get; }

Returns

string

Minutes

The time duration minutes component.

virtual int Minutes { get; set; }

Returns

int

Nanoseconds

The time duration nanoseconds component.

virtual int Nanoseconds { get; set; }

Returns

int

Positive

Indicates whether the time duration value is positive or negative.

virtual bool Positive { get; set; }

Returns

bool

QueryDayFraction()

The time duration day fraction portion as a day fraction. Corresponds to the Hour, Minute, Second, and Nanoseconds properties.

virtual double QueryDayFraction()

Returns

double

QueryDayFractionNanoseconds()

The time duration day fraction portion as the number of nanoseconds elapsed since midnight. Corresponds to the Hour, Minute, Second, and Nanoseconds properties.

virtual long QueryDayFractionNanoseconds()

Returns

long

QueryTicks()

Obtains the time duration as the number of ticks.

virtual long QueryTicks()

Returns

long

Remarks

Using the QueryTicks function allows you to find the Ticks value, which is used in many Windows time controls.

QueryTotalDays()

Obtains the time duration as total days floating point value.

virtual double QueryTotalDays()

Returns

double

QueryTotalHours()

Obtains the time duration as total hours floating point value.

virtual double QueryTotalHours()

Returns

double

QueryTotalMinutes()

Obtains the time duration as total minutes floating point value.

virtual double QueryTotalMinutes()

Returns

double

QueryTotalSeconds()

Obtains the time duration as total seconds floating point value.

virtual double QueryTotalSeconds()

Returns

double

QueryWKSTimeDuration()

Obtains time as a WKSTimeDuration.

virtual WKSTimeDuration QueryWKSTimeDuration()

Returns

WKSTimeDuration

QueryXMLTimeDurationString()

Obtains the time duration as an XML time duration string.

virtual string QueryXMLTimeDurationString()

Returns

string

Reset()

Reset the time duration to zero.

virtual void Reset()

Save(IStream, int)

virtual void Save(IStream pstm, int fClearDirty)

Parameters

pstm IStream
fClearDirty int

Scale(double)

Scales the time duration by a scale factor.

virtual void Scale(double scaleFactor)

Parameters

scaleFactor double

Seconds

The time duration seconds component.

virtual int Seconds { get; set; }

Returns

int

Serialize(IXMLSerializeData)

Serializes an object to XML.

virtual void Serialize(IXMLSerializeData data)

Parameters

data IXMLSerializeData

SetDayFraction(double)

The time duration day fraction portion as a day fraction. Corresponds to the Hour, Minute, Second, and Nanoseconds properties.

virtual void SetDayFraction(double dayFraction)

Parameters

dayFraction double

SetDayFractionNanoseconds(long)

The time duration day fraction portion as the number of nanoseconds elapsed since midnight. Corresponds to the Hour, Minute, Second, and Nanoseconds properties.

virtual void SetDayFractionNanoseconds(long dayFractionNanoseconds)

Parameters

dayFractionNanoseconds long

SetFromTicks(long)

Writes the time duration from a given number of ticks.

virtual void SetFromTicks(long ticks)

Parameters

ticks long

SetFromWKSTimeDuration(ref WKSTimeDuration)

Writes the time from a given WKSTimeDuration value.

virtual void SetFromWKSTimeDuration(ref WKSTimeDuration TimeDuration)

Parameters

TimeDuration WKSTimeDuration

SetFromXMLTimeDurationString(string)

Writes the time duration from an XML time duration string.

virtual void SetFromXMLTimeDurationString(string xmlTimeDurationString)

Parameters

xmlTimeDurationString string

SubtractDuration(ITimeDuration)

Subtracts a time duration.

virtual void SubtractDuration(ITimeDuration TimeDuration)

Parameters

TimeDuration ITimeDuration