Class BuilderItemClass

Namespace
ESRI.ArcGIS.DatasourcesRaster
Assembly
ESRI.Server.DatasourcesRaster.dll
[Guid("E9432EF9-9A04-4E89-A956-E3757DAE3F5C")]
[ClassInterface(ClassInterfaceType.None)]
public class BuilderItemClass : BuilderItem, IBuilderItem3, IBuilderItem2, IBuilderItem, IDocumentVersionSupportGEN
Inheritance
BuilderItemClass
Implements
Inherited Members

Constructors

BuilderItemClass()

public BuilderItemClass()

Explicit Interface Implementations

AddVariable(string, object, bool)

Adds a variable to this item's collection given the variable name, value, and a flag that indicates whether the item URI's tag is prefixed with the variable name and separated by a period.

virtual void AddVariable(string VariableName, object vtVariableValue, bool bPrefixWithTag)

Parameters

VariableName string
vtVariableValue object
bPrefixWithTag bool

AuxiliaryFieldValues

The field values corresponding to the AuxiliaryFields of the parent raster builder described by a property set that maps field names to fields values. These values take precedence over metadata from the BuilderItem's function raster dataset.

virtual IPropertySet AuxiliaryFieldValues { get; set; }

Returns

IPropertySet

Category

The catagory of builder item. The value in this property appears in the Category field of the mosaic catalog.

virtual esriRasterCatalogItemCategory Category { get; set; }

Returns

esriRasterCatalogItemCategory

ColorCorrectionProperties

Variables supporting color correction operation.

virtual IPropertySet ColorCorrectionProperties { get; set; }

Returns

IPropertySet

ConvertToSupportedObject(esriArcGISVersion)

Convert the object to another object that is supported.

virtual object ConvertToSupportedObject(esriArcGISVersion docVersion)

Parameters

docVersion esriArcGISVersion

Returns

object

Remarks

This method should be used when IDocumentVersionSupportGEN::IsSupportedAtVersion returns FALSE.  Calling ConvertToSupportedObject will return an IUnknown pointer to a relevant object supported at the particular ArcGIS version.  Not all objects will return a supported object; in these cases a null pointer will be returned.

Dataset

The function raster dataset associated with builder item.

virtual IFunctionRasterDataset Dataset { get; set; }

Returns

IFunctionRasterDataset

DatasetName

The raster dataset name associated with builder item.

virtual IName DatasetName { get; set; }

Returns

IName

Footprint

The footprint geometry of the function raster dataset that defines regions of valid pixels in the dataset. The footprint geometry may have a coordinate system different from the corresponding dataset.

virtual IGeometry Footprint { get; set; }

Returns

IGeometry

HasThumbnail

Indicates whether the builder item has a valid thumbnail.

virtual bool HasThumbnail { get; }

Returns

bool

IBuilderItem2_AddVariable(string, object, bool)

virtual void IBuilderItem2_AddVariable(string VariableName, object vtVariableValue, bool bPrefixWithTag)

Parameters

VariableName string
vtVariableValue object
bPrefixWithTag bool

IBuilderItem2_Category

virtual esriRasterCatalogItemCategory IBuilderItem2_Category { get; set; }

Returns

esriRasterCatalogItemCategory

IBuilderItem2_Dataset

virtual IFunctionRasterDataset IBuilderItem2_Dataset { get; set; }

Returns

IFunctionRasterDataset

IBuilderItem2_Footprint

virtual IGeometry IBuilderItem2_Footprint { get; set; }

Returns

IGeometry

IBuilderItem2_Seamline

virtual IGeometry IBuilderItem2_Seamline { get; set; }

Returns

IGeometry

IBuilderItem2_StereoID

virtual string IBuilderItem2_StereoID { get; set; }

Returns

string

IBuilderItem2_StereoPairs

virtual IStringArray IBuilderItem2_StereoPairs { get; set; }

Returns

IStringArray

IBuilderItem2_URI

virtual IItemURI IBuilderItem2_URI { get; set; }

Returns

IItemURI

IBuilderItem2_Variables

virtual IPropertySet IBuilderItem2_Variables { get; set; }

Returns

IPropertySet

IBuilderItem3_AddVariable(string, object, bool)

virtual void IBuilderItem3_AddVariable(string VariableName, object vtVariableValue, bool bPrefixWithTag)

Parameters

VariableName string
vtVariableValue object
bPrefixWithTag bool

IBuilderItem3_Category

virtual esriRasterCatalogItemCategory IBuilderItem3_Category { get; set; }

Returns

esriRasterCatalogItemCategory

IBuilderItem3_ColorCorrectionProperties

virtual IPropertySet IBuilderItem3_ColorCorrectionProperties { get; set; }

Returns

IPropertySet

IBuilderItem3_Dataset

virtual IFunctionRasterDataset IBuilderItem3_Dataset { get; set; }

Returns

IFunctionRasterDataset

IBuilderItem3_DatasetName

virtual IName IBuilderItem3_DatasetName { get; set; }

Returns

IName

IBuilderItem3_Footprint

virtual IGeometry IBuilderItem3_Footprint { get; set; }

Returns

IGeometry

IBuilderItem3_HasThumbnail

virtual bool IBuilderItem3_HasThumbnail { get; }

Returns

bool

IBuilderItem3_Seamline

virtual IGeometry IBuilderItem3_Seamline { get; set; }

Returns

IGeometry

IBuilderItem3_SeamlineProperties

virtual IPropertySet IBuilderItem3_SeamlineProperties { get; set; }

Returns

IPropertySet

IBuilderItem3_StereoID

virtual string IBuilderItem3_StereoID { get; set; }

Returns

string

IBuilderItem3_StereoPairs

virtual IStringArray IBuilderItem3_StereoPairs { get; set; }

Returns

IStringArray

IBuilderItem3_Thumbnail

virtual object IBuilderItem3_Thumbnail { get; set; }

Returns

object

IBuilderItem3_URI

virtual IItemURI IBuilderItem3_URI { get; set; }

Returns

IItemURI

IBuilderItem3_Variables

virtual IPropertySet IBuilderItem3_Variables { get; set; }

Returns

IPropertySet

IsSupportedAtVersion(esriArcGISVersion)

Is this object valid at the given document version.

virtual bool IsSupportedAtVersion(esriArcGISVersion docVersion)

Parameters

docVersion esriArcGISVersion

Returns

bool

Remarks

Use IsSupportedAtVersion to identify if a particular object should be saved to the ObjectStream.  This result is based on the esriArcGISVersion enumeration.  In some instances, if the object is not supported at a particular ArcGIS version, the object may support conversion to another similar object; use IDocumentVersionSupportGEN::ConvertToSupportedObject to accomplish this.

Seamline

The seamline geometry associated with this builder item.

virtual IGeometry Seamline { get; set; }

Returns

IGeometry

SeamlineProperties

Variables supporting seamline operation.

virtual IPropertySet SeamlineProperties { get; set; }

Returns

IPropertySet

StereoID

The stereo ID associated with this builder item.

virtual string StereoID { get; set; }

Returns

string

StereoPairs

The stereo IDs of all items that can be paired with this builder item.

virtual IStringArray StereoPairs { get; set; }

Returns

IStringArray

Thumbnail

The thumbnail associated with the builder item.

virtual object Thumbnail { get; set; }

Returns

object

URI

The URI object associated with the builder item.

virtual IItemURI URI { get; set; }

Returns

IItemURI

Variables

The collection of variables associated with this item.

virtual IPropertySet Variables { get; set; }

Returns

IPropertySet