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

mgICreateMeasureUnit.h File Reference

Include dependency graph for mgICreateMeasureUnit.h:


Namespaces

namespace  OSGeo
namespace  OSGeo::FDO
namespace  OSGeo::FDO::Commands
namespace  OSGeo::FDO::Commands::UnitOfMeasure

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

Variables

public __gc __interface ICreateMeasureUnit

Function Documentation

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

__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
 


Comments or suggestions? Send us feedback.