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::ICreateMeasureUnitImp Class Reference

Inherits OSGeo::FDO::Commands::ICommandImp, and OSGeo::FDO::Commands::UnitOfMeasure::OSGeo::FDO::Commands::UnitOfMeasure::ICreateMeasureUnit.

Inheritance diagram for OSGeo::FDO::Commands::UnitOfMeasure::ICreateMeasureUnitImp:

[legend]
List of all members.

Detailed Description

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.


Public Member Functions

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 System::String * get_Abbreviation ()
 Gets 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 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.
__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.

Member Function Documentation

System::Void OSGeo::FDO::Commands::UnitOfMeasure::ICreateMeasureUnitImp::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 System::String* OSGeo::FDO::Commands::UnitOfMeasure::ICreateMeasureUnitImp::get_Abbreviation  ) 
 

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

Returns:
Returns the abbreviation for the measure unit

__property OSGeo ::FDO ::Commands ::UnitOfMeasure ::BaseUnit OSGeo::FDO::Commands::UnitOfMeasure::ICreateMeasureUnitImp::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* OSGeo::FDO::Commands::UnitOfMeasure::ICreateMeasureUnitImp::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* OSGeo::FDO::Commands::UnitOfMeasure::ICreateMeasureUnitImp::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 OSGeo::FDO::Commands::UnitOfMeasure::ICreateMeasureUnitImp::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 OSGeo::FDO::Commands::UnitOfMeasure::ICreateMeasureUnitImp::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

__property System::Void OSGeo::FDO::Commands::UnitOfMeasure::ICreateMeasureUnitImp::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 OSGeo::FDO::Commands::UnitOfMeasure::ICreateMeasureUnitImp::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 OSGeo::FDO::Commands::UnitOfMeasure::ICreateMeasureUnitImp::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 OSGeo::FDO::Commands::UnitOfMeasure::ICreateMeasureUnitImp::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 OSGeo::FDO::Commands::UnitOfMeasure::ICreateMeasureUnitImp::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 OSGeo::FDO::Commands::UnitOfMeasure::ICreateMeasureUnitImp::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

Comments or suggestions? Send us feedback.