#include <Parameter.h>

Inheritance diagram for karto::ParameterDescription:

Public Member Functions
const karto::String &	GetDescription () const
const karto::String &	GetDisplayName () const
const karto::String &	GetFieldName (kt_int32u index) const
kt_int32s	GetFlags () const
const karto::String &	GetName () const
kt_int32s	GetNumberOfDecimalPlaces () const
	ParameterDescription (const karto::String &rName, const karto::String &rDisplayName="", const karto::String &rDescription="")
void	SetFieldNames (const karto::String &rX="X", const karto::String &rY="Y", const karto::String &rZ="Z", const karto::String &rW="W")
void	SetFlags (kt_int32s flags)
void	SetNumberOfDecimalPlaces (kt_int32s decimalPlaces)
virtual	~ParameterDescription ()
Private Attributes
karto::String	m_Description
karto::String	m_DisplayName
karto::String	m_FieldNames [4]
kt_int32s	m_Flags
karto::String	m_Name
kt_int32s	m_nDecimalPlaces

Detailed Description

Parameter description contains metadata information for parameters like name, description, display name and so on. This class is primarily used by the KartoViwer application to display parameter information to the user

Definition at line 71 of file Parameter.h.

Constructor & Destructor Documentation

karto::ParameterDescription::ParameterDescription	(	const karto::String &	rName,
		const karto::String &	rDisplayName = `""`,
		const karto::String &	rDescription = `""`
	)

Constructs a description of a parameter with the given name, display string, and description

Parameters:

rName	name of the parameter
rDisplayName	how the parameter name is displayed
rDescription	description of the parameter

Definition at line 33 of file Parameter.cpp.

karto::ParameterDescription::~ParameterDescription ( ) [virtual]

Definition at line 48 of file Parameter.cpp.

Member Function Documentation

const karto::String& karto::ParameterDescription::GetDescription ( ) const [inline]

Gets a description of the parameter

Returns:: description of the parameter

Definition at line 106 of file Parameter.h.

const karto::String& karto::ParameterDescription::GetDisplayName ( ) const [inline]

Gets the display name of the parameter

Returns:: display name of the parameter

Definition at line 97 of file Parameter.h.

const karto::String& karto::ParameterDescription::GetFieldName ( kt_int32u index ) const [inline]

Gets the field name at the given index. Note: ParameterDescription only supports up to 4 field names.

Parameters:

index index

Returns:: name of field

Definition at line 134 of file Parameter.h.

kt_int32s karto::ParameterDescription::GetFlags ( ) const [inline]

Gets the flags of the parameter

Returns:: flags of the parameter

Definition at line 115 of file Parameter.h.

const karto::String& karto::ParameterDescription::GetName ( ) const [inline]

Gets the name of the parameter

Returns:: name of the parameter

Definition at line 88 of file Parameter.h.

kt_int32s karto::ParameterDescription::GetNumberOfDecimalPlaces ( ) const [inline]

Gets the number of decimal places

Returns:: number of decimal places

Definition at line 164 of file Parameter.h.

void karto::ParameterDescription::SetFieldNames	(	const karto::String &	rX = `"X"`,
		const karto::String &	rY = `"Y"`,
		const karto::String &	rZ = `"Z"`,
		const karto::String &	rW = `"W"`
	)		`[inline]`

Sets the field names

Parameters:

rX	name of the X field
rY	name of the Y field
rZ	name of the Z field
rW	name of the W field

Definition at line 152 of file Parameter.h.

void karto::ParameterDescription::SetFlags ( kt_int32s flags ) [inline]

Sets the flags of the parameter

Parameters:

flags flags of the parameter

Definition at line 124 of file Parameter.h.

void karto::ParameterDescription::SetNumberOfDecimalPlaces ( kt_int32s decimalPlaces ) [inline]

Sets the number of decimal places

Parameters:

decimalPlaces new number of decimal places

Definition at line 173 of file Parameter.h.

Member Data Documentation

karto::String karto::ParameterDescription::m_Description [private]

Parameter description

Definition at line 192 of file Parameter.h.

karto::String karto::ParameterDescription::m_DisplayName [private]

Parameter display name, used in UI as "pretty" name for parameter

Definition at line 187 of file Parameter.h.

karto::String karto::ParameterDescription::m_FieldNames[4] [private]

Parameter field names, currently only up to 4 field names are supported. Field names can be used to change the displayed default field names like (x, y, z) to (myX, myY, myZ)

Definition at line 198 of file Parameter.h.

kt_int32s karto::ParameterDescription::m_Flags [private]

Parameter flags

Definition at line 203 of file Parameter.h.

karto::String karto::ParameterDescription::m_Name [private]

Parameter name

Definition at line 182 of file Parameter.h.

kt_int32s karto::ParameterDescription::m_nDecimalPlaces [private]

Number of decimal places displayed in the UI

Definition at line 208 of file Parameter.h.

The documentation for this class was generated from the following files:

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation