Class TimeExtentClass

Namespace
ESRI.ArcGIS.esriSystem
Assembly
ESRI.Server.System.dll
[Guid("5DC783DE-283A-4963-AB53-25A05C5D76CC")]
[ClassInterface(ClassInterfaceType.None)]
public class TimeExtentClass : TimeExtent, ITimeExtent, ITimeValue, ITimeRelationalOperator, ITimeOffsetOperator, IXMLSerialize, IXMLVersionSupport, IClone, IPersistStream, IPersist, IDocumentVersionSupportGEN
Inheritance
TimeExtentClass
Implements
Inherited Members

Constructors

TimeExtentClass()

public TimeExtentClass()

Explicit Interface Implementations

AddDays(double)

Adds the input amount of days.

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.

virtual void AddHours(double Value)

Parameters

Value double

AddMilliseconds(double)

Adds the input amount of milliseconds.

virtual void AddMilliseconds(double Value)

Parameters

Value double

AddMinutes(double)

Adds the input amount of minutes.

virtual void AddMinutes(double Value)

Parameters

Value double

AddMonths(double, bool, bool)

Adds the input amount of months.

virtual bool AddMonths(double Value, bool preserveEndOfMonth, bool goForwardOnInvalidDate)

Parameters

Value double
preserveEndOfMonth bool
goForwardOnInvalidDate bool

Returns

bool

AddNanoseconds(long)

Adds the input amount of nanoseconds.

virtual void AddNanoseconds(long Value)

Parameters

Value long

AddSeconds(double)

Adds the input amount of seconds.

virtual void AddSeconds(double Value)

Parameters

Value double

AddWeeks(double)

Adds the input amount of weeks.

virtual void AddWeeks(double Value)

Parameters

Value double

AddYears(double, bool, bool)

Adds the input amount of years.

virtual bool AddYears(double Value, bool preserveEndOfMonth, bool goForwardOnInvalidDate)

Parameters

Value double
preserveEndOfMonth bool
goForwardOnInvalidDate bool

Returns

bool

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

Contains(ITimeValue)

Indicates whether this time value contains the other time value.

virtual bool Contains(ITimeValue otherTimeValue)

Parameters

otherTimeValue ITimeValue

Returns

bool

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.

Deserialize(IXMLSerializeData)

Deserializes an object from XML.

virtual void Deserialize(IXMLSerializeData data)

Parameters

data IXMLSerializeData

Disjoint(ITimeValue)

Indicates whether the input time value falls fully outside of the time extent.

virtual bool Disjoint(ITimeValue otherTimeValue)

Parameters

otherTimeValue ITimeValue

Returns

bool

Empty

Indicates whether the time extent is empty.

virtual bool Empty { get; set; }

Returns

bool

EndTime

The time extent's end time.

virtual ITime EndTime { get; set; }

Returns

ITime

Equals(ITimeValue)

Indicates whether the two time values are of the same type and define the same time values.

virtual bool Equals(ITimeValue otherTimeValue)

Parameters

otherTimeValue ITimeValue

Returns

bool

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

ITimeValue_Project(ITimeReference)

Projects this time value from its time reference, to a given time reference.

virtual void ITimeValue_Project(ITimeReference TimeReference)

Parameters

TimeReference ITimeReference

ITimeValue_ProjectFromUTC()

Projects this time value from UTC, to its time reference.

virtual void ITimeValue_ProjectFromUTC()

ITimeValue_ProjectToUTC()

Projects this time value from its time reference, to UTC.

virtual void ITimeValue_ProjectToUTC()

ITimeValue_TimeReference

The time reference associated with the time value.

virtual ITimeReference ITimeValue_TimeReference { get; set; }

Returns

ITimeReference

Intersect(ITimeValue)

Adjust to intersect with the input time value.

virtual void Intersect(ITimeValue otherTimeValue)

Parameters

otherTimeValue ITimeValue

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.

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

Project(ITimeReference)

virtual void Project(ITimeReference TimeReference)

Parameters

TimeReference ITimeReference

ProjectFromUTC()

virtual void ProjectFromUTC()

ProjectToUTC()

virtual void ProjectToUTC()

QueryTimeDuration()

Obtains the time extent's time duration.

virtual ITimeDuration QueryTimeDuration()

Returns

ITimeDuration

Save(IStream, int)

virtual void Save(IStream pstm, int fClearDirty)

Parameters

pstm IStream
fClearDirty int

Serialize(IXMLSerializeData)

Serializes an object to XML.

virtual void Serialize(IXMLSerializeData data)

Parameters

data IXMLSerializeData

SetExtent(ITime, ITime)

Writes start and end time, with copies of the input time values.

virtual void SetExtent(ITime StartTime, ITime EndTime)

Parameters

StartTime ITime
EndTime ITime

StartTime

The time extent's start time.

virtual ITime StartTime { get; set; }

Returns

ITime

SubtractDuration(ITimeDuration)

Subtracts a time duration.

virtual void SubtractDuration(ITimeDuration TimeDuration)

Parameters

TimeDuration ITimeDuration

TimeReference

virtual ITimeReference TimeReference { get; set; }

Returns

ITimeReference

Touches(ITimeValue)

Indicates whether the boundaries of the time values intersect.

virtual bool Touches(ITimeValue otherTimeValue)

Parameters

otherTimeValue ITimeValue

Returns

bool

Union(ITimeValue)

Adjust to ovelap the input time value.

virtual void Union(ITimeValue otherTimeValue)

Parameters

otherTimeValue ITimeValue

Within(ITimeValue)

Indicates whether this time value is contained (is within) the other time value.

virtual bool Within(ITimeValue otherTimeValue)

Parameters

otherTimeValue ITimeValue

Returns

bool