omOptions Class Reference
[GENERIC LIBRARY classes]

#include <omOptions.h>

Inheritance diagram for omOptions:

Public Member Functions
	omOptions ()
virtual void	Init ()
bool	SetParameter (wxString, wxString)
wxString	GetParameter (wxString)
wxString	GenerateOptionsXMLString ()
Data Fields
wxString	hostName
int	port

---

Detailed Description

This class contains all generic options in a maialike application. The class can be extended and a subclass can be used instead of it.

All generic objects in the api structure use this class to store options.

---

Constructor & Destructor Documentation

omOptions::omOptions (   )

---

Member Function Documentation

wxString omOptions::GenerateOptionsXMLString (   )

Generate a string containting an XML rapresantation of the options stored in the structure. Returns: The XML String Reimplemented in omUIOptions, and maiaOptions.

wxString omOptions::GetParameter (  wxString  name  )

Get value of a parameter specified by its name. Parameters: name  Name of the parameter. Returns: value of the parameter as wxString Reimplemented in omUIOptions.

void omOptions::Init (   )  [virtual]

Initialize the class. This function is called after that all objects are istantiated Reimplemented from omObject. Reimplemented in omUIOptions.

bool omOptions::SetParameter (  wxString  name, wxString  value )

Set a parameter value. Parameters: name  Parameter Name value  Parameter value. Returns: true if this class has a parameter called 'name', false if not. Reimplemented in omUIOptions.

---

Field Documentation

wxString omOptions::hostName

Name of the host that run the openmaia server

int omOptions::port

openmaia server listen port

---

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

• omOptions.h
• omOptions.cpp

 

Created with doxygen on: Tue Jun 8 13:59:50 2004 Copyright © by Luca Clivio