XmlAPI Class Reference

Implements ScriptAPI (and by definition, ModuleAPI) in the xml programming language. More...

#include <XmlAPI.h>

Inheritance diagram for XmlAPI:

Collaboration diagram for XmlAPI:

Public Member Functions
virtual	~XmlAPI ()
virtual MissionNode *	loadMissionFile (const char *filename, Logger &logger, Syslog::Severity severity)
	Load the mission with the indicated filename In case of error, log message with indicated severity. More...
Public Member Functions inherited from MissionAPI
virtual	~MissionAPI ()
	Destructor. More...

Static Public Member Functions
static MissionNode *	LoadMissionFile (const char *filename, Logger &logger, Syslog::Severity severity)
	Static function to load the mission with the indicated filename In case of error, log message with indicated severity. More...
static MissionNode *	ParseMission (const char *xmlString, Logger &logger, Syslog::Severity severity)
	Static function to parse the mission from the provided xml string. More...

Private Member Functions
	XmlAPI ()
	Private constructor for singleton. More...

Static Private Attributes
static XmlAPI	Instance_

Additional Inherited Members
Protected Member Functions inherited from MissionAPI
	MissionAPI (const char *name, const char *extension)
	Protected constructor for abstract base class;. More...

Detailed Description

Implements ScriptAPI (and by definition, ModuleAPI) in the xml programming language.

A wrapper for the xml programming language interface. Allows scripted modules and components to share much of the same API as c++ modules and components. Works closely with Tethys.xml code.

Constructor & Destructor Documentation

XmlAPI::~XmlAPI ( )

virtual

XmlAPI::XmlAPI ( )

private

Private constructor for singleton.

Member Function Documentation

MissionNode * XmlAPI::loadMissionFile ( const char *  filename, Logger &  logger, Syslog::Severity  severity  )

virtual

Load the mission with the indicated filename In case of error, log message with indicated severity.

Implements MissionAPI.

References LoadMissionFile().

MissionNode * XmlAPI::LoadMissionFile ( const char *  filename, Logger &  logger, Syslog::Severity  severity  )

static

Static function to load the mission with the indicated filename In case of error, log message with indicated severity.

References Logger::syslog().

Referenced by loadMissionFile().

MissionNode * XmlAPI::ParseMission ( const char *  xmlString, Logger &  logger, Syslog::Severity  severity  )

static

Static function to parse the mission from the provided xml string.

References Logger::syslog().

Referenced by LuaMissionAPI::loadMissionFile().

Member Data Documentation

XmlAPI XmlAPI::Instance_

staticprivate

---

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

• /Volumes/ubuntu_share/lrauv-application/Source/xml/XmlAPI.h
• /Volumes/ubuntu_share/lrauv-application/Source/xml/XmlAPI.cpp