C# Class CustomFunction.NDVICustomFunctionArguments

Inheritance: INDVICustomFunctionArguments
Show file Open project: Esri/arcobjects-sdk-community-samples Class Usage Examples

Public Methods

Method Description
ConvertToSupportedObject ( esriArcGISVersion docVersion ) : object

Convert the instance into an object supported by the given version

Deserialize ( IXMLSerializeData data ) : void

Deserialize the argument object from the datastream provided

GetValue ( string Name ) : object

Get the value associated with the name provided.

IsSupportedAtVersion ( esriArcGISVersion docVersion ) : bool

Check if the object is supported at the given version

Load ( IVariantStream Stream ) : void

Load the properties of the argument object from the stream provided

NDVICustomFunctionArguments ( ) : System
PutValue ( string Name, object Value ) : void

Set the given property name to the given value

Remove ( string Name ) : void

Remove the value of the property name provided

RemoveAll ( ) : void

Clear the property set of all names and values.

Resolve ( IRow pRow, IPropertySet pPropertySet ) : void

Resolve variables containing field names with the corresponding values.

Save ( IVariantStream Stream ) : void

Save the properties of the argument object to the stream provided

Serialize ( IXMLSerializeData data ) : void

Serialize the argument object into the stream provided.

Update ( IRow pRow, IPropertySet pPropertySet, IRasterFunctionArguments pTemplateArguments ) : void

Update the variables containing field names to their updated values.

Private Methods

Method Description
FindPropertyInRow ( IRasterFunctionVariable rasterFunctionVar, IRow pRow ) : object

Check the Name and Alias properties of the given Raster Function Variable to see if they contain a field name and get the value of the corresponding field if needed.

GetDereferencedValue ( string name ) : object

Dereference and return the value of the property whose name is given if necessary.

OpenRasterDataset ( string path ) : IRasterDataset

Open the Raster Dataset given the path to the file.

ResolveRasterVal ( IRow pRow ) : void

Resolve the 'Raster' variable if it contains field names with the corresponding values.

Method Details

ConvertToSupportedObject() public method

Convert the instance into an object supported by the given version
public ConvertToSupportedObject ( esriArcGISVersion docVersion ) : object
docVersion esriArcGISVersion Version to convert to
return object

Deserialize() public method

Deserialize the argument object from the datastream provided
public Deserialize ( IXMLSerializeData data ) : void
data IXMLSerializeData Xml stream to deserialize the argument object from
return void

GetValue() public method

Get the value associated with the name provided.
public GetValue ( string Name ) : object
Name string Name of the property
return object

IsSupportedAtVersion() public method

Check if the object is supported at the given version
public IsSupportedAtVersion ( esriArcGISVersion docVersion ) : bool
docVersion esriArcGISVersion Version to check against
return bool

Load() public method

Load the properties of the argument object from the stream provided
public Load ( IVariantStream Stream ) : void
Stream IVariantStream Stream that contains the serialized form of the argument object
return void

NDVICustomFunctionArguments() public method

public NDVICustomFunctionArguments ( ) : System
return System

PutValue() public method

Set the given property name to the given value
public PutValue ( string Name, object Value ) : void
Name string Name of the property
Value object Value of the property
return void

Remove() public method

Remove the value of the property name provided
public Remove ( string Name ) : void
Name string Name of the property to be removed
return void

RemoveAll() public method

Clear the property set of all names and values.
public RemoveAll ( ) : void
return void

Resolve() public method

Resolve variables containing field names with the corresponding values.
public Resolve ( IRow pRow, IPropertySet pPropertySet ) : void
pRow IRow The row corresponding to the function raster dataset.
pPropertySet IPropertySet Property Set to add the list of the names and the resolved values to.
return void

Save() public method

Save the properties of the argument object to the stream provided
public Save ( IVariantStream Stream ) : void
Stream IVariantStream Stream to which to serialize the argument object into
return void

Serialize() public method

Serialize the argument object into the stream provided.
public Serialize ( IXMLSerializeData data ) : void
data IXMLSerializeData Xml stream to serialize the argument object into
return void

Update() public method

Update the variables containing field names to their updated values.
public Update ( IRow pRow, IPropertySet pPropertySet, IRasterFunctionArguments pTemplateArguments ) : void
pRow IRow The row corresponding to the function raster dataset.
pPropertySet IPropertySet Property Set to add the list of the names and the updated values to.
pTemplateArguments IRasterFunctionArguments The arguements object containing the properties to update if
return void