com.esri.sde.sdk.pe
Class PeParameters

java.lang.Object
  com.esri.sde.sdk.pe.PeObject
      com.esri.sde.sdk.pe.PeParameters

All Implemented Interfaces:

java.lang.Cloneable

public final class PeParameters
extends PeObject

Parameters are required by projection and geographic transformation objects. A parameter has the following attributes. name The name of the parameter. value The value of the parameter.

Constructor Summary

PeParameters(java.lang.String str)
Constructor.

PeParameters(java.lang.String name, double value)
Constructor.

Method Summary

java.lang.Object	clone() Clone a parameter object.
void	delete() Deconstructor.
static PeParameters	fromString(java.lang.String str) Construct parameter object from string.
PeAuthority	getAuth() Retrieve a parameter's authority.
int	getCode()
int	getIndex() Retrieve a parameter's index.
java.lang.String	getName() Retrieve a parameter's name.
int	getStatus() Retrieve a parameter's status.
int	getType() Retrieve a parameter's type.
double	getValue() Retrieve a parameter's value.
boolean	isEqual(PeObject peobj) Check if both objects are equal.
boolean	isEqual(PeParameters param) Test if two parameters are identical.
void	setAuth(PeAuthority authority) Store a authority in a parameter.
PeParameters[]	setMethodDefaults(PeMethod method) Create default parameters in array parameters for a method object.
void	setName(java.lang.String name) Set a parameter's name.
PeParameters[]	setProjectionDefaults(PeProjection projection) Create default parameters in array parameters for a projection object.
void	setValue(double value) Set a parameter's value.
PeParameters[]	setVTMethodDefaults(PeVTMethod vtmethod) Create default parameters in array parameters for a vtmethod object.
java.lang.String	toString() Retrieve a parameter's external representation.
java.lang.String	toString(int mode) Retrieve a parameter's extended external representation.

Methods inherited from class com.esri.sde.sdk.pe.PeObject

fromAnyString, fromStringByType

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PeParameters

public PeParameters(java.lang.String name,
                    double value)
             throws PeProjectionException

Constructor.

Throws:

PeProjectionException

PeParameters

public PeParameters(java.lang.String str)
             throws PeProjectionException

Constructor.

Throws:

PeProjectionException

Method Detail

fromString

public static PeParameters fromString(java.lang.String str)
                               throws PeProjectionException

Construct parameter object from string.

Throws:

PeProjectionException

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Clone a parameter object.

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException

delete

public void delete()

Deconstructor.

Specified by:

delete in class PeObject

getName

public java.lang.String getName()

Retrieve a parameter's name.

Specified by:

getName in class PeObject

getType

public int getType()

Retrieve a parameter's type.

Specified by:

getType in class PeObject

getStatus

public int getStatus()

Retrieve a parameter's status.

Specified by:

getStatus in class PeObject

isEqual

public boolean isEqual(PeObject peobj)

Check if both objects are equal.

Specified by:

isEqual in class PeObject

isEqual

public boolean isEqual(PeParameters param)

Test if two parameters are identical.

toString

public java.lang.String toString()

Retrieve a parameter's external representation.

Specified by:

toString in class PeObject

toString

public java.lang.String toString(int mode)

Retrieve a parameter's extended external representation.

Specified by:

toString in class PeObject

getAuth

public PeAuthority getAuth()

Retrieve a parameter's authority.

Specified by:

getAuth in class PeObject

setAuth

public void setAuth(PeAuthority authority)

Store a authority in a parameter.

Specified by:

setAuth in class PeObject

getValue

public double getValue()

Retrieve a parameter's value.

getIndex

public int getIndex()
             throws PeProjectionException

Retrieve a parameter's index.

Throws:

PeProjectionException

setValue

public void setValue(double value)

Set a parameter's value.

setName

public void setName(java.lang.String name)

Set a parameter's name.

setMethodDefaults

public PeParameters[] setMethodDefaults(PeMethod method)
                                 throws PeProjectionException

Create default parameters in array parameters for a method object.

Throws:

PeProjectionException

setVTMethodDefaults

public PeParameters[] setVTMethodDefaults(PeVTMethod vtmethod)
                                   throws PeProjectionException

Create default parameters in array parameters for a vtmethod object.

Throws:

PeProjectionException

setProjectionDefaults

public PeParameters[] setProjectionDefaults(PeProjection projection)
                                     throws PeProjectionException

Create default parameters in array parameters for a projection object.

Throws:

PeProjectionException

getCode

public int getCode()

Specified by:

getCode in class PeObject