FDO .NET API Reference Feature Data Objects

OSGeo::FDO::Commands::UnitOfMeasure Namespace Reference


Classes

interface  ICreateMeasureUnit
 The ICreateMeasureUnit interface defines the CreateMeasureUnit command, which creates or updates a measurement unit. Input to the command includes the abbreviation, name, description, measure type, base unit, and scale factor that defines the measure unit. The update existing flag indicates how the command should behave in the presence of an existing measure unit. If it is false, and the specified measure unit already exists, command execution will fail. If it is true, the command will either create a new measure unit or update an existing one. More...
class  ICreateMeasureUnitImp
 The ICreateMeasureUnitImp class is a concrete implementation of ICreateMeasureUnit. The ICreateMeasureUnit interface defines the CreateMeasureUnit command, which creates or updates a measurement unit. Input to the command includes the abbreviation, name, description, measure type, base unit, and scale factor that defines the measure unit. The update existing flag indicates how the command should behave in the presence of an existing measure unit. If it is false, and the specified measure unit already exists, command execution will fail. If it is true, the command will either create a new measure unit or update an existing one. More...
interface  IDestroyMeasureUnit
 The IDestroyMeasureUnit interface defines the DestroyMeasureUnit command, which deletes a measurement unit. Input to the command is simply the abbreviation of the measure unit to be destroyed. More...
class  IDestroyMeasureUnitImp
 The IDestroyMeasureUnitImp class is a concrete implementation of IDestroyMeasureUnit. The IDestroyMeasureUnit interface defines the DestroyMeasureUnit command, which deletes a measurement unit. Input to the command is simply the abbreviation of the measure unit to be destroyed. More...
interface  IGetMeasureUnits
 The IGetMeasureUnits interface defines the GetMeasureUnits command, which enumerates the existing measurement units. More...
class  IGetMeasureUnitsImp
 The IGetMeasureUnitsImp class is a concrete implementation of IGetMeasureUnits. The IGetMeasureUnits interface defines the GetMeasureUnits command, which enumerates the existing measurement units. More...
interface  IMeasureUnitReader
 The IMeasureUnitReader interface provides forward-only, read-only functionality for enumerating measurement units. A reference to an IMeasureUnitReader interface is returned from the GetMeasureUnits command. The initial position of the IMeasureUnitReader is prior to the first item. Thus, you must call ReadNext to begin accessing any data. More...
class  IMeasureUnitReaderImp
 The IMeasureUnitReaderImp class is a concrete implementation of IMeasureUnitReader. The IMeasureUnitReader interface provides forward-only, read-only functionality for enumerating measurement units. A reference to an IMeasureUnitReader interface is returned from the GetMeasureUnits command. The initial position of the IMeasureUnitReader is prior to the first item. Thus, you must call ReadNext to begin accessing any data. More...

Functions

System::Void Close ()
 Closes the IMeasureUnitReader object, freeing any resources it may be holding.
System::Void Execute ()
 Executes the DestroyMeasureUnit command.
__property OSGeo::FDO::Commands::UnitOfMeasure::BaseUnit get_BaseUnit ()
 Gets the base units that define the measure unit to create or update as an BaseUnit value.
__property System::String * get_Description ()
 Gets the description of the measure unit to create or update as a string.
__property System::String * get_Name ()
 Gets the name of the measure unit to create or update as a string.
__property System::Double get_ScaleFactor ()
 Gets the scale factor to be applied to the base unit in order to get one of the units being defined.
__property System::Boolean get_UpdateExisting ()
 Gets a Boolean flag that indicates how the CreateMeasureUnit command should behave if the measure unit already exists. If update existing is true and a measure unit with the specified abbreviation already exists then it will be updated. If update existing is false and a measure unit with the specified abbreviation already exists, command execution will fail.
OSGeo::FDO::Commands::UnitOfMeasure::BaseUnit GetBaseUnit ()
 Gets the base unit of the measure unit currently being read.
System::String * GetDescription ()
 Gets the description of the measure unit currently being read.
System::String * GetName ()
 Gets the name of the measure unit currently being read.
System::Double GetScaleFactor ()
 Gets the scale factor of the measure unit currently being read.
System::Boolean ReadNext ()
 Advances the reader to the next item. The default position of the reader is prior to the first item. Thus, you must call ReadNext to begin accessing any data.
__property System::Void set_Abbreviation (System::String *value)
 Sets the abbreviation of the measure unit to destroy as a string.
__property System::Void set_BaseUnit (OSGeo::FDO::Commands::UnitOfMeasure::BaseUnit value)
 Sets the base units that define the measure unit to create or update as an BaseUnit value.
__property System::Void set_Description (System::String *value)
 Sets the description of the measure unit to create or update as a string.
__property System::Void set_Name (System::String *value)
 Sets the name of the measure unit to create or update as a string.
__property System::Void set_ScaleFactor (System::Double value)
 Sets the scale factor to be applied to the base unit in order to get one of the units being defined.
__property System::Void set_UpdateExisting (System::Boolean value)
 Sets a Boolean flag that indicates how the CreateMeasureUnit command should behave if the measure unit already exists. If update existing is true and a measure unit of the specified name already exists, it will be updated. If update existing is false and a measure unit of the specified name already exists, command execution will fail.

Variables

public __gc __interface ICreateMeasureUnit
public __gc __interface IDestroyMeasureUnit
public __gc __interface IGetMeasureUnits
public __gc __interface IMeasureUnitReader
public __gc __interface IMeasureUnitReader
public __gc __interface IMeasureUnitReader
public __gc __interface IMeasureUnitReader

Comments or suggestions? Send us feedback.