Information about an Integra Module interface. More...

Public Member Functions
virtual const string &	get_name () const =0
	Get interface's name. More...

virtual const string &	get_label () const =0
	Get more human-readable version of interface's name, with spaces between words. More...

virtual const string &	get_description () const =0
	Retrieve the interface's inbuilt documentation. More...

virtual const string_set &	get_tags () const =0
	Get interface's set of tags. More...

virtual const string &	get_author () const =0
	Get name of module's author.

virtual const struct tm &	get_created_date () const =0
	Timestamp of when the module's origin id was generated.

virtual const struct tm &	get_modified_date () const =0
	Timestamp of when the module's module id was last regenerated (last modification)

Detailed Description

Information about an Integra Module interface.

Member Function Documentation

virtual const string& integra_api::IInterfaceInfo::get_description ( ) const

pure virtual

Retrieve the interface's inbuilt documentation.

Interface documentation can use markdown format (http://en.wikipedia.org/wiki/Markdown)

virtual const string& integra_api::IInterfaceInfo::get_label ( ) const

pure virtual

Get more human-readable version of interface's name, with spaces between words.

virtual const string& integra_api::IInterfaceInfo::get_name ( ) const

pure virtual

Get interface's name.

Interface names are upper camel case, with no spaces

virtual const string_set& integra_api::IInterfaceInfo::get_tags ( ) const

pure virtual

Get interface's set of tags.

Tags are used to describe the interface, so that guis can provide useful filtering

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