com.esri.arcgis.schematic
Interface INgAttributeFunction

All Superinterfaces:
Serializable
All Known Implementing Classes:
INgAttributeFunctionProxy, NgAttributeFunction

public interface INgAttributeFunction
extends Serializable

Provides access to members that control the attribute function.

Description

An attribute function is an attribute whose values are computed by a function.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

See Also:
INgAttribute

Method Summary
 String getName()
          Name of the attribute function.
 INgNames getParameterNames()
          List of the parameter names required by the function that computes the attribute values.
 String getProcedureName()
          Name of the function that computes the attribute values.
 INgUserAttributeSet getUserAttributeSet()
          User attribute functions set where the function used to compute the attribute values is stored.
 String getUserAttributeSetName()
          Name of the set of user attribute functions where the function that computes the attribute values is stored.
 void setName(String pVal)
          Name of the attribute function.
 void setParameterNames(INgNames pVal)
          List of the parameter names required by the function that computes the attribute values.
 void setProcedureName(String pVal)
          Name of the function that computes the attribute values.
 void setUserAttributeSet(INgUserAttributeSet pVal)
          User attribute functions set where the function used to compute the attribute values is stored.
 void setUserAttributeSetName(String pVal)
          Name of the set of user attribute functions where the function that computes the attribute values is stored.
 

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException
Name of the attribute function.

Description

This name is defined when the function attribute is created
- either by calling the INgObjectType CreateAttribute method in the program code,
- or through ArcGIS Schematics Designer, when the attribute has been created.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setName

void setName(String pVal)
             throws IOException,
                    AutomationException
Name of the attribute function.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getUserAttributeSet

INgUserAttributeSet getUserAttributeSet()
                                        throws IOException,
                                               AutomationException
User attribute functions set where the function used to compute the attribute values is stored.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
A reference to a com.esri.arcgis.schematic.INgUserAttributeSet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUserAttributeSet

void setUserAttributeSet(INgUserAttributeSet pVal)
                         throws IOException,
                                AutomationException
User attribute functions set where the function used to compute the attribute values is stored.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
pVal - A reference to a com.esri.arcgis.schematic.INgUserAttributeSet (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getProcedureName

String getProcedureName()
                        throws IOException,
                               AutomationException
Name of the function that computes the attribute values.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setProcedureName

void setProcedureName(String pVal)
                      throws IOException,
                             AutomationException
Name of the function that computes the attribute values.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getParameterNames

INgNames getParameterNames()
                           throws IOException,
                                  AutomationException
List of the parameter names required by the function that computes the attribute values.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
A reference to a com.esri.arcgis.schematic.INgNames
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setParameterNames

void setParameterNames(INgNames pVal)
                       throws IOException,
                              AutomationException
List of the parameter names required by the function that computes the attribute values.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
pVal - A reference to a com.esri.arcgis.schematic.INgNames (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getUserAttributeSetName

String getUserAttributeSetName()
                               throws IOException,
                                      AutomationException
Name of the set of user attribute functions where the function that computes the attribute values is stored.

Description

The user attribute set name must be formatted as follows "ComponentName.ClassModuleName" where ComponentName is the name of the COM component that implements the ClassModuleName class where the function that will be used to compute the attribute values is stored.

Remarks

If you set a reference to your COM component in your project references, you can only set the class module name for the UserAtttributeSetName value.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUserAttributeSetName

void setUserAttributeSetName(String pVal)
                             throws IOException,
                                    AutomationException
Name of the set of user attribute functions where the function that computes the attribute values is stored.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.