|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.location.RouteMeasurePointProperties
public class RouteMeasurePointProperties
Properties for route measure point event tables.
Route event properties identify certain characteristics of a table so that it can be recognized as a table containing route events.
RouteMeasurePointProperties identify a table as a point event table.
RouteMeasurePointProperties are helper objects for a RouteEventSource.
Constructor Summary | |
---|---|
RouteMeasurePointProperties()
Constructs a RouteMeasurePointProperties using ArcGIS Engine. |
|
RouteMeasurePointProperties(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. RouteMeasurePointProperties theRouteMeasurePointProperties = (RouteMeasurePointProperties) obj; |
Method Summary | |
---|---|
void |
assign(IClone src)
Assigns the properties of src to the receiver. |
boolean |
equals(Object o)
Compare this object with another |
IClone |
esri_clone()
Clones the receiver and assigns the result to *clone. |
String |
getAngleFieldName()
Name of the angle field name. |
void |
getClassID(GUID[] pClassID)
getClassID |
static String |
getClsid()
getClsid. |
String |
getErrorFieldName()
Name of the error field name. |
int |
getEventMeasureUnit()
The units of the event measure(s). |
String |
getEventRouteIDFieldName()
The route identifier field name. |
String |
getLateralOffsetFieldName()
The lateral offset field name. |
String |
getMeasureFieldName()
The measure field name. |
void |
getSettingError()
The state of the object (see if all the required field names have been set). |
void |
getSizeMax(_ULARGE_INTEGER[] pcbSize)
getSizeMax |
int |
hashCode()
the hashcode for this object |
void |
interfaceSupportsErrorInfo(GUID riid)
interfaceSupportsErrorInfo |
boolean |
isAddAngleField()
Indicates if an angle field should be added to the field set. |
boolean |
isAddErrorField()
Indicates if the error field should be added to the field set. |
boolean |
isALineEvent()
Is a line event. |
boolean |
isAsPointFeature()
Indicates if the point event shape should be output as a multipoint or a point. |
boolean |
isComplementAngle()
Indicates if 180 degres should be added to the angle field value. |
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 |
isMDirectionOffsetting()
Indicates if the offset should based onthe M direction or the digitized direction. |
boolean |
isNormalAngle()
Indicates if the angle field should be the normal or the tangent anglea. |
void |
load(IStream pstm)
load |
void |
readExternal(ObjectInput in)
|
void |
save(IStream pstm,
int fClearDirty)
save |
void |
setAddAngleField(boolean angleField)
Indicates if an angle field should be added to the field set. |
void |
setAddErrorField(boolean value)
Indicates if the error field should be added to the field set. |
void |
setAngleFieldName(String fieldName)
Name of the angle field name. |
void |
setAsPointFeature(boolean value)
Indicates if the point event shape should be output as a multipoint or a point. |
void |
setComplementAngle(boolean value)
Indicates if 180 degres should be added to the angle field value. |
void |
setErrorFieldName(String fieldName)
Name of the error field name. |
void |
setEventMeasureUnit(int units)
The units of the event measure(s). |
void |
setEventRouteIDFieldName(String fieldName)
The route identifier field name. |
void |
setLateralOffsetFieldName(String fieldName)
The lateral offset field name. |
void |
setMDirectionOffsetting(boolean value)
Indicates if the offset should based onthe M direction or the digitized direction. |
void |
setMeasureFieldName(String fieldName)
The measure field name. |
void |
setNormalAngle(boolean value)
Indicates if the angle field should be the normal or the tangent anglea. |
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 RouteMeasurePointProperties() throws IOException, UnknownHostException
IOException
- if there are interop problems
UnknownHostException
- if there are interop problemspublic RouteMeasurePointProperties(Object obj) throws IOException
RouteMeasurePointProperties theRouteMeasurePointProperties = (RouteMeasurePointProperties) obj;
obj
to RouteMeasurePointProperties
.
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 void setAddErrorField(boolean value) throws IOException, AutomationException
setAddErrorField
in interface IRouteEventProperties2
value
- The value (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isAddErrorField() throws IOException, AutomationException
This property allows you to add a non editable and dynamic field to the route event source to provide information about whether the events were located or not.
isAddErrorField
in interface IRouteEventProperties2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setErrorFieldName(String fieldName) throws IOException, AutomationException
setErrorFieldName
in interface IRouteEventProperties2
fieldName
- The fieldName (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getErrorFieldName() throws IOException, AutomationException
If the AddErrorField property is set to True, this property is used to set the name of the field which will contain the locating errors.
getErrorFieldName
in interface IRouteEventProperties2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setMDirectionOffsetting(boolean value) throws IOException, AutomationException
setMDirectionOffsetting
in interface IRouteEventProperties2
value
- The value (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isMDirectionOffsetting() throws IOException, AutomationException
isMDirectionOffsetting
in interface IRouteEventProperties2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setEventRouteIDFieldName(String fieldName) throws IOException, AutomationException
setEventRouteIDFieldName
in interface IRouteEventProperties
fieldName
- The fieldName (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getEventRouteIDFieldName() throws IOException, AutomationException
getEventRouteIDFieldName
in interface IRouteEventProperties
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setEventMeasureUnit(int units) throws IOException, AutomationException
setEventMeasureUnit
in interface IRouteEventProperties
units
- A com.esri.arcgis.system.esriUnits constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getEventMeasureUnit() throws IOException, AutomationException
getEventMeasureUnit
in interface IRouteEventProperties
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setLateralOffsetFieldName(String fieldName) throws IOException, AutomationException
setLateralOffsetFieldName
in interface IRouteEventProperties
fieldName
- The fieldName (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getLateralOffsetFieldName() throws IOException, AutomationException
getLateralOffsetFieldName
in interface IRouteEventProperties
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isALineEvent() throws IOException, AutomationException
isALineEvent
in interface IRouteEventProperties
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void getSettingError() throws IOException, AutomationException
getSettingError
in interface IRouteEventProperties
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setAsPointFeature(boolean value) throws IOException, AutomationException
setAsPointFeature
in interface IRouteMeasurePointProperties2
value
- The value (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isAsPointFeature() throws IOException, AutomationException
If this property is set to True, the geometry of the RouteEventSource will be of type Point, and if this is False, the geometry will be of type Multipoint.
isAsPointFeature
in interface IRouteMeasurePointProperties2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setAddAngleField(boolean angleField) throws IOException, AutomationException
setAddAngleField
in interface IRouteMeasurePointProperties2
angleField
- The angleField (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isAddAngleField() throws IOException, AutomationException
This property will allow you to add an angle field to the RouteEventSource. The angle is calculated dynamically for every point event at its route measure location.
isAddAngleField
in interface IRouteMeasurePointProperties2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setAngleFieldName(String fieldName) throws IOException, AutomationException
setAngleFieldName
in interface IRouteMeasurePointProperties2
fieldName
- The fieldName (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getAngleFieldName() throws IOException, AutomationException
This is used to set the name of the angle field that will exist in the RouteEventSource.
getAngleFieldName
in interface IRouteMeasurePointProperties2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setNormalAngle(boolean value) throws IOException, AutomationException
setNormalAngle
in interface IRouteMeasurePointProperties2
value
- The value (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isNormalAngle() throws IOException, AutomationException
This property is used to set whether the angle will be the normal angle (True) or the tangent angle (False) at the point event's route measure location. The normal angle is perpendicular to the route at the route measure location whereas, the tangent is parallel to the route.
The Normal direction is determined by what is set in IRouteEventProperties2::MDirectionOffsetting. If MDirectionOffsetting is set to True, the angle will be normal to the increasing measure direction. If MDirectionOffsetting is set to False, the angle will be normal to the route's digitized direction.
isNormalAngle
in interface IRouteMeasurePointProperties2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setComplementAngle(boolean value) throws IOException, AutomationException
setComplementAngle
in interface IRouteMeasurePointProperties2
value
- The value (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isComplementAngle() throws IOException, AutomationException
The ComplementaryAngle property calculates the angle which is 180 degrees to the Normal or Tangent of the route at the point events route measure location. If the NormalAngle property is set to True, the calculated angle will be the angle 180 degrees to the Normal. If the NormalAngle property is set to False, the calculated angle will be the angle 180 degrees to the Tangent.
isComplementAngle
in interface IRouteMeasurePointProperties2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setMeasureFieldName(String fieldName) throws IOException, AutomationException
setMeasureFieldName
in interface IRouteMeasurePointProperties
fieldName
- The fieldName (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getMeasureFieldName() throws IOException, AutomationException
getMeasureFieldName
in interface IRouteMeasurePointProperties
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 void interfaceSupportsErrorInfo(GUID riid) throws IOException, AutomationException
Indicates whether the interface supports IErrorInfo.
interfaceSupportsErrorInfo
in interface ISupportErrorInfo
riid
- A Structure: com.esri.arcgis.support.ms.stdole.GUID (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 |