com.esri.arcgis.editor
Interface ICourse

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

Course, ICourseProxy

public interface ICourse
extends java.io.Serializable

COM Interface 'ICourse'. Generated 3/19/2015 1:21:02 PM from 'C:\ArcGIS\COM\esriEditor.olb'

Description: 'Provides access to members that define a course in a traverse.' 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 =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IIDfc110ccf_4f67_4fa9_9c9e_065d913a3a09
static int	xxDummy Deprecated. Internal use only

Method Summary

ISegment	addSegment(IGeometry geom, double distanceFactor, double angularOffset) Adds a reference for the course to the input geometry.
ICourse	esri_clone() Clones the course and adds the result to *clone.
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.
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.
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.

Field Detail

IIDfc110ccf_4f67_4fa9_9c9e_065d913a3a09

static final int IIDfc110ccf_4f67_4fa9_9c9e_065d913a3a09

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getType

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

The type of course.

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

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

The type of course.

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

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

The first value that defines the course.

Returns:

The measure

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMeasure1

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

The first value that defines the course.

Parameters:

measure - The measure (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMeasure2

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

The second value that defines the course.

Returns:

The measure

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMeasure2

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

The second value that defines the course.

Parameters:

measure - The measure (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMeasure3

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

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

Returns:

The measure

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMeasure3

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

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

Parameters:

measure - The measure (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCurveParameter1

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

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

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

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.

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

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

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

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

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.

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

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

Indicates if curve turns to the left or right.

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

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

Indicates if curve turns to the left or right.

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

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

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

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

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

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

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

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

Adds a reference for the course to the input geometry.

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

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

Clones the course and adds the result to *clone.

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

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

Description of the course.

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.