|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.system.TimeInstant
public class TimeInstant
An object that represents a time-referenced instant in time.
A Time Instant represents a single point on the time line. It has no length.
Constructor Summary | |
---|---|
TimeInstant()
Constructs a TimeInstant using ArcGIS Engine. |
|
TimeInstant(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. TimeInstant theTimeInstant = (TimeInstant) obj; |
Method Summary | |
---|---|
void |
addDays(double value)
Adds the input amount of days. |
void |
addDuration(ITimeDuration timeDuration)
Adds a time duration. |
void |
addHours(double value)
Adds the input amount of hours. |
void |
addMilliseconds(double value)
Adds the input amount of milliseconds. |
void |
addMinutes(double value)
Adds the input amount of minutes. |
boolean |
addMonths(double value,
boolean preserveEndOfMonth,
boolean goForwardOnInvalidDate)
Adds the input amount of months. |
void |
addNanoseconds(long value)
Adds the input amount of nanoseconds. |
void |
addSeconds(double value)
Adds the input amount of seconds. |
void |
addWeeks(double value)
Adds the input amount of weeks. |
boolean |
addYears(double value,
boolean preserveEndOfMonth,
boolean goForwardOnInvalidDate)
Adds the input amount of years. |
void |
assign(IClone src)
Assigns the properties of src to the receiver. |
boolean |
contains(ITimeValue otherTimeValue)
Indicates whether this time value contains the other time value. |
Object |
convertToSupportedObject(int docVersion)
Convert the object to another object that is supported. |
void |
deserialize(IXMLSerializeData data)
Deserializes an object from XML. |
boolean |
disjoint(ITimeValue otherTimeValue)
Indicates whether the input time value falls fully outside of the time extent. |
boolean |
equals(Object o)
Compare this object with another |
IClone |
esri_clone()
Clones the receiver and assigns the result to *clone. |
boolean |
esri_equals(ITimeValue otherTimeValue)
Indicates whether the two time values are of the same type and define the same time values. |
void |
getClassID(GUID[] pClassID)
getClassID |
static String |
getClsid()
getClsid. |
String |
getMinNamespaceSupported()
The minimum namespace the class can serialize to (eg the 90 namespace). |
void |
getSizeMax(_ULARGE_INTEGER[] pcbSize)
getSizeMax |
ITime |
getTime()
The time instant time value. |
ITimeReference |
getTimeReference()
The time reference associated with the time value. |
int |
hashCode()
the hashcode for this object |
void |
isDirty()
isDirty |
boolean |
isEqual(IClone other)
Indicates if the receiver and other have the same properties. |
boolean |
isIdentical(IClone other)
Indicates if the receiver and other are the same object. |
boolean |
isSupportedAtVersion(int docVersion)
Is this object valid at the given document version. |
void |
load(IStream pstm)
load |
void |
project(ITimeReference timeReference)
Projects this time value from its time reference, to a given time reference. |
void |
projectFromUTC()
Projects this time value from UTC, to its time reference. |
void |
projectToUTC()
Projects this time value from its time reference, to UTC. |
void |
readExternal(ObjectInput in)
|
void |
save(IStream pstm,
int fClearDirty)
save |
void |
serialize(IXMLSerializeData data)
Serializes an object to XML. |
void |
setTime(ITime time)
The time instant time value. |
void |
setTimeReferenceByRef(ITimeReference timeReference)
The time reference associated with the time value. |
void |
subtractDuration(ITimeDuration timeDuration)
Subtracts a time duration. |
boolean |
touches(ITimeValue otherTimeValue)
Indicates whether the boundaries of the time values intersect. |
boolean |
within(ITimeValue otherTimeValue)
Indicates whether this time value is contained (is within) the other time value. |
void |
writeExternal(ObjectOutput out)
|
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef |
---|
getJintegraDispatch, release |
Constructor Detail |
---|
public TimeInstant() throws IOException, UnknownHostException
IOException
- if there are interop problems
UnknownHostException
- if there are interop problemspublic TimeInstant(Object obj) throws IOException
TimeInstant theTimeInstant = (TimeInstant) obj;
obj
to TimeInstant
.
obj
- an object returned from ArcGIS Engine or Server
IOException
- if there are interop problemsMethod Detail |
---|
public static String getClsid()
public boolean equals(Object o)
equals
in class Object
public int hashCode()
hashCode
in class Object
public ITime getTime() throws IOException, AutomationException
getTime
in interface ITimeInstant
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setTime(ITime time) throws IOException, AutomationException
setTime
in interface ITimeInstant
time
- A reference to a com.esri.arcgis.system.ITime (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ITimeReference getTimeReference() throws IOException, AutomationException
getTimeReference
in interface ITimeValue
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setTimeReferenceByRef(ITimeReference timeReference) throws IOException, AutomationException
setTimeReferenceByRef
in interface ITimeValue
timeReference
- A reference to a com.esri.arcgis.system.ITimeReference (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void project(ITimeReference timeReference) throws IOException, AutomationException
This function modifies the underlying time value in addition to changing the value of the temporal reference. For example, if you have a time value whose time reference is in Pacific Time Zone, and is currently 6:00 AM. The equivalent time in Eastern Time Zone is 9:00 AM. Calling the Project method, and passing in a reference to the Eastern time zone will change the time reference to the Eastern Time Zone, and also change the value to 9:00 AM.
project
in interface ITimeValue
timeReference
- A reference to a com.esri.arcgis.system.ITimeReference (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void projectToUTC() throws IOException, AutomationException
projectToUTC
in interface ITimeValue
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void projectFromUTC() throws IOException, AutomationException
projectFromUTC
in interface ITimeValue
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean esri_equals(ITimeValue otherTimeValue) throws IOException, AutomationException
esri_equals
in interface ITimeRelationalOperator
otherTimeValue
- A reference to a com.esri.arcgis.system.ITimeValue (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean disjoint(ITimeValue otherTimeValue) throws IOException, AutomationException
This is the opposite of the Touches operation. It can be used to find out if there is a non-zero amount of time between the input time and the current time extent.
disjoint
in interface ITimeRelationalOperator
otherTimeValue
- A reference to a com.esri.arcgis.system.ITimeValue (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean touches(ITimeValue otherTimeValue) throws IOException, AutomationException
This function results in a TRUE value if there exists a Time instant that is contained by both of the TimeExtents. for example if the time extents are 1:00-2:00 and 2:00-3:00, then there is exactly one moment in time (2:00) that is in both TimeExtents.
touches
in interface ITimeRelationalOperator
otherTimeValue
- A reference to a com.esri.arcgis.system.ITimeValue (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean within(ITimeValue otherTimeValue) throws IOException, AutomationException
This function can be used to find out if the current time is contained fully within the time extent passed in. The start times can be equal or the end times can be equal and the function will still be TRUE.
within
in interface ITimeRelationalOperator
otherTimeValue
- A reference to a com.esri.arcgis.system.ITimeValue (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean contains(ITimeValue otherTimeValue) throws IOException, AutomationException
This function returns true if the passed Time value is contained fully within the current time extent. The start times can be equal, or the end times can be equal and the function will still result in TRUE.
contains
in interface ITimeRelationalOperator
otherTimeValue
- A reference to a com.esri.arcgis.system.ITimeValue (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void addDuration(ITimeDuration timeDuration) throws IOException, AutomationException
addDuration
in interface ITimeOffsetOperator
timeDuration
- A reference to a com.esri.arcgis.system.ITimeDuration (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void subtractDuration(ITimeDuration timeDuration) throws IOException, AutomationException
subtractDuration
in interface ITimeOffsetOperator
timeDuration
- A reference to a com.esri.arcgis.system.ITimeDuration (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean addYears(double value, boolean preserveEndOfMonth, boolean goForwardOnInvalidDate) throws IOException, AutomationException
addYears
in interface ITimeOffsetOperator
value
- The value (in)preserveEndOfMonth
- The preserveEndOfMonth (in)goForwardOnInvalidDate
- The goForwardOnInvalidDate (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean addMonths(double value, boolean preserveEndOfMonth, boolean goForwardOnInvalidDate) throws IOException, AutomationException
addMonths
in interface ITimeOffsetOperator
value
- The value (in)preserveEndOfMonth
- The preserveEndOfMonth (in)goForwardOnInvalidDate
- The goForwardOnInvalidDate (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void addWeeks(double value) throws IOException, AutomationException
addWeeks
in interface ITimeOffsetOperator
value
- The value (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void addDays(double value) throws IOException, AutomationException
addDays
in interface ITimeOffsetOperator
value
- The value (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void addHours(double value) throws IOException, AutomationException
addHours
in interface ITimeOffsetOperator
value
- The value (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void addMinutes(double value) throws IOException, AutomationException
addMinutes
in interface ITimeOffsetOperator
value
- The value (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void addSeconds(double value) throws IOException, AutomationException
addSeconds
in interface ITimeOffsetOperator
value
- The value (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void addMilliseconds(double value) throws IOException, AutomationException
addMilliseconds
in interface ITimeOffsetOperator
value
- The value (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void addNanoseconds(long value) throws IOException, AutomationException
addNanoseconds
in interface ITimeOffsetOperator
value
- Signed 64-bit int (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void serialize(IXMLSerializeData data) throws IOException, AutomationException
serialize
in interface IXMLSerialize
data
- A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void deserialize(IXMLSerializeData data) throws IOException, AutomationException
deserialize
in interface IXMLSerialize
data
- A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getMinNamespaceSupported() throws IOException, AutomationException
getMinNamespaceSupported
in interface IXMLVersionSupport
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IClone esri_clone() throws IOException, AutomationException
esri_clone
in interface IClone
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void assign(IClone src) throws IOException, AutomationException
assign
in interface IClone
src
- A reference to a com.esri.arcgis.system.IClone (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isEqual(IClone other) throws IOException, AutomationException
IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.
isEqual
in interface IClone
other
- A reference to a com.esri.arcgis.system.IClone (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isIdentical(IClone other) throws IOException, AutomationException
IsIdentical returns true if the receiver and the source reference the same object.
isIdentical
in interface IClone
other
- A reference to a com.esri.arcgis.system.IClone (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void isDirty() throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
isDirty
in interface IPersistStream
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void load(IStream pstm) throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
load
in interface IPersistStream
pstm
- A reference to a com.esri.arcgis.system.IStream (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void save(IStream pstm, int fClearDirty) throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
save
in interface IPersistStream
pstm
- A reference to a com.esri.arcgis.system.IStream (in)fClearDirty
- The fClearDirty (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void getSizeMax(_ULARGE_INTEGER[] pcbSize) throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
getSizeMax
in interface IPersistStream
pcbSize
- A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void getClassID(GUID[] pClassID) throws IOException, AutomationException
IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.
getClassID
in interface IPersist
pClassID
- A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isSupportedAtVersion(int docVersion) throws IOException, AutomationException
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.
isSupportedAtVersion
in interface IDocumentVersionSupportGEN
docVersion
- A com.esri.arcgis.system.esriArcGISVersion constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public Object convertToSupportedObject(int docVersion) throws IOException, AutomationException
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.
convertToSupportedObject
in interface IDocumentVersionSupportGEN
docVersion
- A com.esri.arcgis.system.esriArcGISVersion constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void writeExternal(ObjectOutput out) throws IOException
writeExternal
in interface Externalizable
IOException
public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException
readExternal
in interface Externalizable
IOException
ClassNotFoundException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |