Modeler Extensions Framework
HostHelper Class Reference

Public Member Functions

XMLDocument getHostInformation (CLEMEXTErrorCode *errorCode)
 
XMLDocument createNew (const char *root_element_name)
 
XMLDocument createFromContents (const char *contents)
 

Static Public Member Functions

static HostHelpercreate (CLEMEXTHostHandle handle)
 

Detailed Description

A simple C++ class to wrap a CLEMEXT host

Definition at line 28 of file HostHelper.h.

Member Function Documentation

static HostHelper* create ( CLEMEXTHostHandle  handle)
static

create and return a new host helper

Parameters
handlethe CLEMEXT-API object representing the host and its callbacks
Returns
new HostHelper instance
XMLDocument createFromContents ( const char *  contents)

create a new XML document from a contents string

Parameters
contentsthe contents of the document
Returns
XMLDocument new XML (not valid in event of an error)
XMLDocument createNew ( const char *  root_element_name)

create a new XML document

Parameters
root_element_namethe name of the root element in the new doc
Returns
XMLDocument new XML (not valid in event of an error)
XMLDocument getHostInformation ( CLEMEXTErrorCode errorCode)

get information on the host in the form of an XML doc

Parameters
errorCodedetailed error information if the call fails
Returns
XMLDocument XML describing host (not valid in event of an error)

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