com.esri.arcgis.datasourcesfile
Interface ISMRestriction

All Superinterfaces:
Serializable
All Known Implementing Classes:
SMRestriction

public interface ISMRestriction
extends Serializable

Provides access to the routing restriction properties.

Product Availability

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


Method Summary
 ISMNetAttribute getAttribute()
          The network attribute used as a restriction.
 Object getParam()
          The restriction parameter value.
 int getType()
          Restriction type.
 void setAttributeByRef(ISMNetAttribute pAttr)
          The network attribute used as a restriction.
 void setParam(Object pvParam)
          The restriction parameter value.
 void setType(int pVal)
          Restriction type.
 

Method Detail

getAttribute

ISMNetAttribute getAttribute()
                             throws IOException,
                                    AutomationException
The network attribute used as a restriction.

Product Availability

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

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

setAttributeByRef

void setAttributeByRef(ISMNetAttribute pAttr)
                       throws IOException,
                              AutomationException
The network attribute used as a restriction.

Product Availability

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

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

getType

int getType()
            throws IOException,
                   AutomationException
Restriction type.

Remarks

The restriction type can be Strict or Relaxed. Strict restrictions can never be violated by the solver, while Relaxed restrictions can be violated if there is no other way to calculate a route.

Product Availability

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

Returns:
A com.esri.arcgis.datasourcesfile.esriSMRestrictionType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setType

void setType(int pVal)
             throws IOException,
                    AutomationException
Restriction type.

Product Availability

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

Parameters:
pVal - A com.esri.arcgis.datasourcesfile.esriSMRestrictionType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getParam

Object getParam()
                throws IOException,
                       AutomationException
The restriction parameter value.

Product Availability

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

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

setParam

void setParam(Object pvParam)
              throws IOException,
                     AutomationException
The restriction parameter value.

Product Availability

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

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