STK::Tool Class Reference

The Tool class specified a tool in FreeMiner's tool box component. More...

#include <STK_Tool.h>

Collaboration diagram for STK::Tool:

List of all members.

Public Types
enum	Type { Default, Custom }
	Type of the Tool. More...
Public Member Functions
	Tool (String const &aname=String(), String const &xml=String(), String const &icon_name=String(), Type atype=Default)
	Constructor.
virtual	~Tool ()
	Desctructor.
String const &	name () const
	Give the name of the Tool.
void	setName (String const &aname)
	Set the name of the Tool.
String const &	getDomXml () const
	Give the xml description of the Tool.
void	setDomXml (String const &xml)
	Set the xml description of the Tool.
String const &	getIconName () const
	Give the name of the Icon of the Tool.
void	setIconName (String const &icon_name)
	Set the name of the Icon of the Tool.
Type	type () const
	Give the Type of the Tool.
void	setType (Type atype)
	Set the type of the Tool.
bool	isNull () const
	return true if the name of the Tool is empty
Private Attributes
String	name_
	name of the Tool
String	xml_
	xml description of the Tool
String	icon_name_
	name of the icon of the tool
Type	type_
	type of the Tool

---

Detailed Description

The Tool class specified a tool in FreeMiner's tool box component.

Definition at line 57 of file STK_Tool.h.

---

Member Enumeration Documentation

enum STK::Tool::Type

Type of the Tool.

Enumerator:

Default	Default tool provided by FreeMiner.
Custom	Custom tool provided by the user.

Definition at line 63 of file STK_Tool.h.

    {
      Default,
      Custom 
    };

---

Constructor & Destructor Documentation

STK::Tool::Tool	(	String const &	aname = String(),
		String const &	xml = String(),
		String const &	icon_name = String(),
		Type	atype = Default
	)

Constructor.

Parameters:

aname	name of the tool
xml	xml descriptio fo the Tool
icon_name	name of the icon of the Tool
atype	Type of the Tool

Returns:

Definition at line 41 of file STK_Tool.cpp.

          : name_(aname), xml_(xml), icon_name_(icon_name), type_(atype)
{ }

STK::Tool::~Tool

(

)

[virtual]

Desctructor.

Definition at line 48 of file STK_Tool.cpp.

{ }

---

Member Function Documentation

String const& STK::Tool::name

(

)

const [inline]

Give the name of the Tool.

Returns:

the name of the Tool

Definition at line 110 of file STK_Tool.h.

References name_.

    { return name_;}

void STK::Tool::setName

(

String const &

aname

)

[inline]

Set the name of the Tool.

Parameters:

aname

the name to set

Definition at line 117 of file STK_Tool.h.

References name_.

    { name_ = aname;}

String const& STK::Tool::getDomXml

(

)

const [inline]

Give the xml description of the Tool.

Returns:

the xml dexcription of the Tool

Definition at line 124 of file STK_Tool.h.

References xml_.

    { return xml_;}

void STK::Tool::setDomXml

(

String const &

xml

)

[inline]

Set the xml description of the Tool.

Parameters:

xml	the xml description of the Tool

Definition at line 131 of file STK_Tool.h.

References xml_.

    { xml_ = xml;}

String const& STK::Tool::getIconName

(

)

const [inline]

Give the name of the Icon of the Tool.

Returns:

the name of the icon of the Tool

Definition at line 138 of file STK_Tool.h.

References icon_name_.

    { return icon_name_;}

void STK::Tool::setIconName

(

String const &

icon_name

)

[inline]

Set the name of the Icon of the Tool.

Parameters:

icon_name

the name of the icon of the Tool

Definition at line 145 of file STK_Tool.h.

References icon_name_.

    { icon_name_ = icon_name;}

Type STK::Tool::type

(

)

const [inline]

Give the Type of the Tool.

Returns:

the Type of the Tool

Definition at line 152 of file STK_Tool.h.

References type_.

    { return type_;}

void STK::Tool::setType

(

Type

atype

)

[inline]

Set the type of the Tool.

Parameters:

atype

the Type of the Tool to set

Definition at line 159 of file STK_Tool.h.

References type_.

    { type_ = atype;}

bool STK::Tool::isNull

(

)

const [inline]

return true if the name of the Tool is empty

Returns:

true if the name of the Tool is empty

Definition at line 166 of file STK_Tool.h.

References name_.

    { return name_.empty();}

---

Member Data Documentation

String STK::Tool::name_ [private]

name of the Tool

Definition at line 73 of file STK_Tool.h.

Referenced by isNull(), name(), and setName().

String STK::Tool::xml_ [private]

xml description of the Tool

Definition at line 77 of file STK_Tool.h.

Referenced by getDomXml(), and setDomXml().

String STK::Tool::icon_name_ [private]

name of the icon of the tool

Definition at line 81 of file STK_Tool.h.

Referenced by getIconName(), and setIconName().

Type STK::Tool::type_ [private]

type of the Tool

Definition at line 85 of file STK_Tool.h.

Referenced by setType(), and type().

---

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

• STK_Tool.h
• STK_Tool.cpp