| TerraLib 4.1

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files
- Examples

- Class List
- Class Index
- Class Hierarchy
- Class Members

Public Types | Public Member Functions | Protected Attributes
SPL::slcPluginInfo Class Reference

The plugin information class. More...

`#include <spl_plugininfo.h>`

Inheritance diagram for SPL::slcPluginInfo:

List of all members.

## Public Types

enum | sleFunction { sleFunction_Init = 0, sleFunction_Run, sleFunction_Shutdown }
| Function enumeration for argument lookups. More...

## Public Member Functions

SPL_API | slcPluginInfo (void)
| Default constructor.
SPL_API | slcPluginInfo (const slcPluginInfo &a_pluginInfo)
| Copy constructor.
virtual SPL_API | ~slcPluginInfo (void)
| Default destructor.
void SPL_API | Clear (void)
| Clears the structure.
long SPL_API | GetArgCount (sleFunction a_enuFunc)
| Returns the argument count of the specified function.
string SPL_API | GetArgDescription (sleFunction a_enuFunc, const long a_lIndex)
| Returns an argument's description.
string SPL_API | GetArgName (sleFunction a_enuFunc, const long a_lIndex)
| Returns an argument's name.
string SPL_API | GetName (void)
| Returns the plugin's name.
string SPL_API | GetVendor (void)
| Returns the plugin's vendor.
string SPL_API | GetInfo (void)
| Returns the plugin's information string.
string SPL_API | GetDescription (void)
| Returns the plugin's description.
string SPL_API | GetHomepage (void)
| Returns the plugin's homepage.
string SPL_API | GetEmail (void)
| Returns the plugin's e-mail address.
long SPL_API | GetMajorVersion (void)
| Returns the plugin's major version (e.g. 1.xx).
long SPL_API | GetMinorVersion (void)
| Returns the plugin's minor version (e.g. x.12).
long SPL_API | GetBuildVersion (void)
| Returns the plugin's build version.
string SPL_API | GetUUID (void)
| Returns the plugin's UUID.
bool SPL_API | HasPublicArgs (void)
| Reports whether the plugin has public arguments or not.
slcPluginInfo SPL_API | operator= (const slcPluginInfo &a_pluginInfo)
| Copy operator.

## Protected Attributes

string | m_strName
string | m_strVendor
string | m_strInfo
string | m_strDescription
string | m_strHomepage
string | m_strEmail
long | m_lMajor
long | m_lMinor
long | m_lBuild
string | m_strUUID
bool | m_bPuplicArgInfos
map< long, string > | m_mapInitArgs
map< long, string > | m_mapShutdownArgs
map< long, string > | m_mapRunArgs
map< long, string >::iterator | itmapArgs

## Detailed Description

The plugin information class.

## Member Enumeration Documentation

enum SPL::slcPluginInfo::sleFunction

Function enumeration for argument lookups.

Enumerator:

  sleFunction_Init |
  sleFunction_Run |
  sleFunction_Shutdown |

## Constructor & Destructor Documentation

slcPluginInfo::slcPluginInfo | ( | void |  | ) |

Default constructor.

slcPluginInfo::slcPluginInfo | ( | const slcPluginInfo & | a_pluginInfo | ) |

Copy constructor.

slcPluginInfo::~slcPluginInfo | ( | void |  | ) | `[virtual]`

Default destructor.

## Member Function Documentation

void slcPluginInfo::Clear | ( | void |  | ) |

Clears the structure.

long slcPluginInfo::GetArgCount | ( | sleFunction | a_enuFunc | ) |

Returns the argument count of the specified function.

Parameters:

  a_enuFunc | [in] Function to get the argument count from.

Returns:
  Number of arguments of the specified function.

string slcPluginInfo::GetArgDescription | ( | sleFunction | a_enuFunc,
|  | const long | a_lIndex
| ) |  |

Returns an argument's description.

Parameters:

  a_enuFunc | [in] Function to get the argument description from.
  a_lIndex | [in] Index (0-based) of argument.

Returns:
  The argument's description.

string slcPluginInfo::GetArgName | ( | sleFunction | a_enuFunc,
|  | const long | a_lIndex
| ) |  |

Returns an argument's name.

Parameters:

  a_enuFunc | [in] Function to get the argument description from.
  a_lIndex | [in] Index (0-based) of argument.

Returns:
  The argument's name.

long slcPluginInfo::GetBuildVersion | ( | void |  | ) |

Returns the plugin's build version.

Returns:
  The plugin's build version.

string slcPluginInfo::GetDescription | ( | void |  | ) |

Returns the plugin's description.

Returns:
  The plugin's description.

string slcPluginInfo::GetEmail | ( | void |  | ) |

Returns the plugin's e-mail address.

Returns:
  The plugin's e-mail address.

string slcPluginInfo::GetHomepage | ( | void |  | ) |

Returns the plugin's homepage.

Returns:
  The plugin's homepage.

string slcPluginInfo::GetInfo | ( | void |  | ) |

Returns the plugin's information string.

Returns:
  The plugin's information string.

long slcPluginInfo::GetMajorVersion | ( | void |  | ) |

Returns the plugin's major version (e.g. 1.xx).

Returns:
  The plugin's major version.

long slcPluginInfo::GetMinorVersion | ( | void |  | ) |

Returns the plugin's minor version (e.g. x.12).

Returns:
  The plugin's minor version.

string slcPluginInfo::GetName | ( | void |  | ) |

Returns the plugin's name.

Returns:
  The plugin's name.

string slcPluginInfo::GetUUID | ( | void |  | ) |

Returns the plugin's UUID.

Returns:
  The plugin's UUID.

string slcPluginInfo::GetVendor | ( | void |  | ) |

Returns the plugin's vendor.

Returns:
  The plugin's vendor.

bool slcPluginInfo::HasPublicArgs | ( | void |  | ) |

Reports whether the plugin has public arguments or not.

Returns:
  The method returns one of the following values:

Return values:

  true | | The plugin has public arguments.
  false | | The plugin has no public arguments.

slcPluginInfo slcPluginInfo::operator= | ( | const slcPluginInfo & | a_pluginInfo | ) |

Copy operator.

Parameters:

  a_pluginInfo | [in] Plugin class to copy from.

Returns:
  The new plugin class.

## Member Data Documentation

map< long, string >::iterator SPL::slcPluginInfo::itmapArgs`[protected]`

bool SPL::slcPluginInfo::m_bPuplicArgInfos`[protected]`

long SPL::slcPluginInfo::m_lBuild`[protected]`

long SPL::slcPluginInfo::m_lMajor`[protected]`

long SPL::slcPluginInfo::m_lMinor`[protected]`

map< long, string > SPL::slcPluginInfo::m_mapInitArgs`[protected]`

map< long, string > SPL::slcPluginInfo::m_mapRunArgs`[protected]`

map< long, string > SPL::slcPluginInfo::m_mapShutdownArgs`[protected]`

string SPL::slcPluginInfo::m_strDescription`[protected]`

string SPL::slcPluginInfo::m_strEmail`[protected]`

string SPL::slcPluginInfo::m_strHomepage`[protected]`

string SPL::slcPluginInfo::m_strInfo`[protected]`

string SPL::slcPluginInfo::m_strName`[protected]`

string SPL::slcPluginInfo::m_strUUID`[protected]`

string SPL::slcPluginInfo::m_strVendor`[protected]`

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

- E:/Projetos_Primeiro_Semestre_2012/TerraView/terralib/src/libspl/include/spl_plugininfo.h
- E:/Projetos_Primeiro_Semestre_2012/TerraView/terralib/src/libspl/source/spl_plugininfo.cpp

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines