FDO .NET API Reference Feature Data Objects
Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

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


Classes

class  OSGeo::FDO::Commands::UnitOfMeasure::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...
class  OSGeo::FDO::Commands::UnitOfMeasure::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...
class  OSGeo::FDO::Commands::UnitOfMeasure::IGetMeasureUnitsImp
 The IGetMeasureUnitsImp class is a concrete implementation of IGetMeasureUnits. The IGetMeasureUnits interface defines the GetMeasureUnits command, which enumerates the existing measurement units. More...
class  OSGeo::FDO::Commands::UnitOfMeasure::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...
interface  OSGeo::FDO::Commands::UnitOfMeasure::OSGeo::FDO::Commands::UnitOfMeasure::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  OSGeo::FDO::Commands::UnitOfMeasure::OSGeo::FDO::Commands::UnitOfMeasure::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  OSGeo::FDO::Commands::UnitOfMeasure::OSGeo::FDO::Commands::UnitOfMeasure::IGetMeasureUnits
 The IGetMeasureUnits interface defines the GetMeasureUnits command, which enumerates the existing measurement units. More...
interface  OSGeo::FDO::Commands::UnitOfMeasure::OSGeo::FDO::Commands::UnitOfMeasure::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...

Enumerations

enum  BaseUnit {
  BaseUnit_None = FdoBaseUnit_None,
  BaseUnit_Meters = FdoBaseUnit_Meters,
  BaseUnit_Radians = FdoBaseUnit_Radians
}
 The BaseUnit enumeration defines the well known base unit used to establish a measure unit. More...

Functions

System::Void Close ()
 Closes the IMeasureUnitReader object, freeing any resources it may be holding.
System::Void Execute ()
 Executes the CreateMeasureUnit command. If the measure unit already exists and the update existing flag is set to false, an exception is thrown.
__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 create or update as a string. Abbreviations must be unique because they define the identity of a measurement unit.
__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

Enumeration Type Documentation

enum BaseUnit
 

The BaseUnit enumeration defines the well known base unit used to establish a measure unit.

Enumeration values:
BaseUnit_None  Represents an unspecified base unit, it can be used to create an unknown or unspecified unit of measure.
BaseUnit_Meters  The base unit for linear, area, and volume measurement units represented by meters, meters squared, or meters cubed respectively.
BaseUnit_Radians  The base unit for the angular measurement units represented by radians.

Function Documentation

System::Void Close  ) 
 

Closes the IMeasureUnitReader object, freeing any resources it may be holding.

Returns:
Returns nothing

System::Void Execute  ) 
 

Executes the CreateMeasureUnit command. If the measure unit already exists and the update existing flag is set to false, an exception is thrown.

Returns:
Returns nothing

__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.

Returns:
Returns the base units

__property System::String* get_Description  ) 
 

Gets the description of the measure unit to create or update as a string.

Returns:
Returns the description for the measure unit

__property System::String* get_Name  ) 
 

Gets the name of the measure unit to create or update as a string.

Returns:
Returns the name for the measure unit

__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.

Returns:
Returns the scale factor

__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.

Returns:
Returns true if the existing measure unit can be updated

OSGeo ::FDO ::Commands ::UnitOfMeasure ::BaseUnit GetBaseUnit  ) 
 

Gets the base unit of the measure unit currently being read.

Returns:
Returns the base unit

System::String* GetDescription  ) 
 

Gets the description of the measure unit currently being read.

Returns:
Returns the description of the measure unit

System::String* GetName  ) 
 

Gets the name of the measure unit currently being read.

Returns:
Returns the name of the measure unit

System::Double GetScaleFactor  ) 
 

Gets the scale factor of the measure unit currently being read.

Returns:
Returns the scale factor of the measure unit

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.

Returns:
Returns true if there is a next item

__property System::Void set_Abbreviation System::String *  value  ) 
 

Sets the abbreviation of the measure unit to create or update as a string. Abbreviations must be unique because they define the identity of a measurement unit.

Parameters:
value Input the abbreviation for the measure unit
Returns:
Returns nothing

__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.

Parameters:
value Input the base units
Returns:
Returns nothing

__property System::Void set_Description System::String *  value  ) 
 

Sets the description of the measure unit to create or update as a string.

Parameters:
value Input the description for the measure unit
Returns:
Returns nothing

__property System::Void set_Name System::String *  value  ) 
 

Sets the name of the measure unit to create or update as a string.

Parameters:
value Input the name for the measure unit
Returns:
Returns nothing

__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.

Parameters:
value Input the scale factor
Returns:
Returns nothing

__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.

Parameters:
value Input Indicates if the existing measure unit can be updated
Returns:
Returns nothing

Variable Documentation

public __gc __interface OSGeo::FDO::Commands::UnitOfMeasure::ICreateMeasureUnit
 

public __gc __interface OSGeo::FDO::Commands::UnitOfMeasure::IDestroyMeasureUnit
 

public __gc __interface OSGeo::FDO::Commands::UnitOfMeasure::IGetMeasureUnits
 

public __gc __interface OSGeo::FDO::Commands::UnitOfMeasure::IMeasureUnitReader
 


Comments or suggestions? Send us feedback.