com.esri.arcgis.editor
Class Course

java.lang.Object
  com.esri.arcgis.editor.Course

All Implemented Interfaces:

ICourse, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class Course
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ICourse

COM Class 'Course'. Generated 3/19/2015 1:20:50 PM from 'C:\ArcGIS\COM\esriEditor.olb'

Description 'Creates line segments defined by COGO descriptions.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.editor.ICourse

IID, IIDfc110ccf_4f67_4fa9_9c9e_065d913a3a09, xxDummy

Constructor Summary

Course()
Constructs a Course using ArcGIS Engine.

Course(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
Course theCourse = (Course) obj;

Method Summary

ISegment	addSegment(IGeometry geom, double distanceFactor, double angularOffset) Adds a reference for the course to the input geometry.
boolean	equals(java.lang.Object o) Compare this object with another
ICourse	esri_clone() Clones the course and adds the result to *clone.
static java.lang.String	getClsid() getClsid.
int	getCurveDirectionType() If the course type is esriCTCurve, defines the curve direction type of the third value.
int	getCurveParameter1() If the course type is esriCTTangentCurve or esriCTCurve, defines the curve parameter of the first value.
int	getCurveParameter2() If the course type is esriCTTangentCurve or esriCTCurve, defines the curve parameter of the second value.
java.lang.String	getDescription(IEditor editor) Description of the course.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
double	getMeasure1() The first value that defines the course.
double	getMeasure2() The second value that defines the course.
double	getMeasure3() Optionally, the direction of the curve if the course type is esriCTCurve.
int	getTurnDirection() Indicates if curve turns to the left or right.
int	getType() The type of course.
int	hashCode() the hashcode for this object
void	release() Release a Course.
void	setCurveDirectionType(int cdt) If the course type is esriCTCurve, defines the curve direction type of the third value.
void	setCurveParameter1(int cp) If the course type is esriCTTangentCurve or esriCTCurve, defines the curve parameter of the first value.
void	setCurveParameter2(int cp) If the course type is esriCTTangentCurve or esriCTCurve, defines the curve parameter of the second value.
void	setMeasure1(double measure) The first value that defines the course.
void	setMeasure2(double measure) The second value that defines the course.
void	setMeasure3(double measure) Optionally, the direction of the curve if the course type is esriCTCurve.
void	setTurnDirection(int td) Indicates if curve turns to the left or right.
void	setType(int type) The type of course.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Course

public Course()
       throws java.io.IOException,
              java.net.UnknownHostException

Constructs a Course using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

Course

public Course(java.lang.Object obj)
       throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
Course theCourse = (Course) obj;

Construct a Course using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to Course.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a Course.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getType

public int getType()
            throws java.io.IOException,
                   AutomationException

The type of course.

Specified by:

getType in interface ICourse

Returns:

A com.esri.arcgis.editor.esriCourseType constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setType

public void setType(int type)
             throws java.io.IOException,
                    AutomationException

The type of course.

Specified by:

setType in interface ICourse

Parameters:

type - A com.esri.arcgis.editor.esriCourseType constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMeasure1

public double getMeasure1()
                   throws java.io.IOException,
                          AutomationException

The first value that defines the course.

Specified by:

getMeasure1 in interface ICourse

Returns:

The measure

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMeasure1

public void setMeasure1(double measure)
                 throws java.io.IOException,
                        AutomationException

The first value that defines the course.

Specified by:

setMeasure1 in interface ICourse

Parameters:

measure - The measure (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMeasure2

public double getMeasure2()
                   throws java.io.IOException,
                          AutomationException

The second value that defines the course.

Specified by:

getMeasure2 in interface ICourse

Returns:

The measure

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMeasure2

public void setMeasure2(double measure)
                 throws java.io.IOException,
                        AutomationException

The second value that defines the course.

Specified by:

setMeasure2 in interface ICourse

Parameters:

measure - The measure (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMeasure3

public double getMeasure3()
                   throws java.io.IOException,
                          AutomationException

Optionally, the direction of the curve if the course type is esriCTCurve.

Specified by:

getMeasure3 in interface ICourse

Returns:

The measure

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMeasure3

public void setMeasure3(double measure)
                 throws java.io.IOException,
                        AutomationException

Optionally, the direction of the curve if the course type is esriCTCurve.

Specified by:

setMeasure3 in interface ICourse

Parameters:

measure - The measure (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurveParameter1

public int getCurveParameter1()
                       throws java.io.IOException,
                              AutomationException

If the course type is esriCTTangentCurve or esriCTCurve, defines the curve parameter of the first value.

Specified by:

getCurveParameter1 in interface ICourse

Returns:

A com.esri.arcgis.editor.esriCurveParameter constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCurveParameter1

public void setCurveParameter1(int cp)
                        throws java.io.IOException,
                               AutomationException

If the course type is esriCTTangentCurve or esriCTCurve, defines the curve parameter of the first value.

Specified by:

setCurveParameter1 in interface ICourse

Parameters:

cp - A com.esri.arcgis.editor.esriCurveParameter constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurveParameter2

public int getCurveParameter2()
                       throws java.io.IOException,
                              AutomationException

If the course type is esriCTTangentCurve or esriCTCurve, defines the curve parameter of the second value.

Specified by:

getCurveParameter2 in interface ICourse

Returns:

A com.esri.arcgis.editor.esriCurveParameter constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCurveParameter2

public void setCurveParameter2(int cp)
                        throws java.io.IOException,
                               AutomationException

If the course type is esriCTTangentCurve or esriCTCurve, defines the curve parameter of the second value.

Specified by:

setCurveParameter2 in interface ICourse

Parameters:

cp - A com.esri.arcgis.editor.esriCurveParameter constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTurnDirection

public int getTurnDirection()
                     throws java.io.IOException,
                            AutomationException

Indicates if curve turns to the left or right.

Specified by:

getTurnDirection in interface ICourse

Returns:

A com.esri.arcgis.editor.esriTurnDirection constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTurnDirection

public void setTurnDirection(int td)
                      throws java.io.IOException,
                             AutomationException

Indicates if curve turns to the left or right.

Specified by:

setTurnDirection in interface ICourse

Parameters:

td - A com.esri.arcgis.editor.esriTurnDirection constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurveDirectionType

public int getCurveDirectionType()
                          throws java.io.IOException,
                                 AutomationException

If the course type is esriCTCurve, defines the curve direction type of the third value.

Specified by:

getCurveDirectionType in interface ICourse

Returns:

A com.esri.arcgis.editor.esriCurveDirectionType constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCurveDirectionType

public void setCurveDirectionType(int cdt)
                           throws java.io.IOException,
                                  AutomationException

If the course type is esriCTCurve, defines the curve direction type of the third value.

Specified by:

setCurveDirectionType in interface ICourse

Parameters:

cdt - A com.esri.arcgis.editor.esriCurveDirectionType constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addSegment

public ISegment addSegment(IGeometry geom,
                           double distanceFactor,
                           double angularOffset)
                    throws java.io.IOException,
                           AutomationException

Adds a reference for the course to the input geometry.

Specified by:

addSegment in interface ICourse

Parameters:

geom - A reference to a com.esri.arcgis.geometry.IGeometry (in)

distanceFactor - The distanceFactor (in)

angularOffset - The angularOffset (in)

Returns:

A reference to a com.esri.arcgis.geometry.ISegment

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_clone

public ICourse esri_clone()
                   throws java.io.IOException,
                          AutomationException

Clones the course and adds the result to *clone.

Specified by:

esri_clone in interface ICourse

Returns:

A reference to a com.esri.arcgis.editor.ICourse

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

public java.lang.String getDescription(IEditor editor)
                                throws java.io.IOException,
                                       AutomationException

Description of the course.

Specified by:

getDescription in interface ICourse

Parameters:

editor - A reference to a com.esri.arcgis.editor.IEditor (in)

Returns:

The description

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.