Addon Class Reference

#include <Addon.hxx>

Inherits SGReferenced.

Classes
class	Metadata
class	MetadataParser

Public Member Functions
	Addon (std::string id, AddonVersion version=AddonVersion(), SGPath basePath=SGPath(), std::string minFGVersionRequired="", std::string maxFGVersionRequired="", SGPropertyNode *addonNode=nullptr)
std::string	getId () const
std::string	getName () const
void	setName (const std::string &addonName)
AddonVersionRef	getVersion () const
void	setVersion (const AddonVersion &addonVersion)
std::vector< AuthorRef >	getAuthors () const
void	setAuthors (const std::vector< AuthorRef > &addonAuthors)
std::vector< MaintainerRef >	getMaintainers () const
void	setMaintainers (const std::vector< MaintainerRef > &addonMaintainers)
std::string	getShortDescription () const
void	setShortDescription (const std::string &addonShortDescription)
std::string	getLongDescription () const
void	setLongDescription (const std::string &addonLongDescription)
std::string	getLicenseDesignation () const
void	setLicenseDesignation (const std::string &addonLicenseDesignation)
SGPath	getLicenseFile () const
void	setLicenseFile (const SGPath &addonLicenseFile)
std::string	getLicenseUrl () const
void	setLicenseUrl (const std::string &addonLicenseUrl)
std::vector< std::string >	getTags () const
void	setTags (const std::vector< std::string > &addonTags)
SGPath	getBasePath () const
void	setBasePath (const SGPath &addonBasePath)
SGPath	getStoragePath () const
SGPath	createStorageDir () const
std::string	resourcePath (const std::string &relativePath) const
std::string	getMinFGVersionRequired () const
void	setMinFGVersionRequired (const std::string &minFGVersionRequired)
std::string	getMaxFGVersionRequired () const
void	setMaxFGVersionRequired (const std::string &maxFGVersionRequired)
std::string	getHomePage () const
void	setHomePage (const std::string &addonHomePage)
std::string	getDownloadUrl () const
void	setDownloadUrl (const std::string &addonDownloadUrl)
std::string	getSupportUrl () const
void	setSupportUrl (const std::string &addonSupportUrl)
std::string	getCodeRepositoryUrl () const
void	setCodeRepositoryUrl (const std::string &addonCodeRepositoryUrl)
std::string	getTriggerProperty () const
void	setTriggerProperty (const std::string &addonTriggerProperty)
SGPropertyNode_ptr	getAddonNode () const
void	setAddonNode (SGPropertyNode *addonNode)
naRef	getAddonPropsNode () const
SGPropertyNode_ptr	getLoadedFlagNode () const
int	getLoadSequenceNumber () const
void	setLoadSequenceNumber (int num)
std::multimap< UrlType, QualifiedUrl >	getUrls () const
std::vector< SGPropertyNode_ptr >	getMenubarNodes () const
void	setMenubarNodes (const std::vector< SGPropertyNode_ptr > &menubarNodes)
void	addToFGMenubar () const
std::string	str () const
void	retranslate ()
	update string values (description, etc) based on the active locale

Static Public Member Functions
static Addon	fromAddonDir (const SGPath &addonPath)
template<class T>
static T	fromAddonDir (const SGPath &addonPath)
static void	setupGhost (nasal::Hash &addonsModule)

Detailed Description

Definition at line 78 of file Addon.hxx.

Constructor & Destructor Documentation

Addon()

flightgear::addons::Addon::Addon	(	std::string	id,
		AddonVersion	version = AddonVersion(),
		SGPath	basePath = SGPath(),
		std::string	minFGVersionRequired = "",
		std::string	maxFGVersionRequired = "",
		SGPropertyNode *	addonNode = nullptr )

Definition at line 90 of file Addon.cxx.

Member Function Documentation

addToFGMenubar()

void flightgear::addons::Addon::addToFGMenubar

(

)

const

Definition at line 341 of file Addon.cxx.

createStorageDir()

SGPath flightgear::addons::Addon::createStorageDir

(

)

const

Definition at line 187 of file Addon.cxx.

fromAddonDir() [1/2]

Addon flightgear::addons::Addon::fromAddonDir ( const SGPath & addonPath )

static

Definition at line 374 of file Addon.cxx.

fromAddonDir() [2/2]

template<class T>

static T flightgear::addons::Addon::fromAddonDir ( const SGPath & addonPath )

inlinestatic

Definition at line 93 of file Addon.hxx.

getAddonNode()

SGPropertyNode_ptr flightgear::addons::Addon::getAddonNode

(

)

const

Definition at line 285 of file Addon.cxx.

getAddonPropsNode()

naRef flightgear::addons::Addon::getAddonPropsNode

(

)

const

Definition at line 291 of file Addon.cxx.

getAuthors()

std::vector< AuthorRef > flightgear::addons::Addon::getAuthors

(

)

const

Definition at line 130 of file Addon.cxx.

getBasePath()

SGPath flightgear::addons::Addon::getBasePath

(

)

const

Definition at line 178 of file Addon.cxx.

getCodeRepositoryUrl()

std::string flightgear::addons::Addon::getCodeRepositoryUrl

(

)

const

Definition at line 273 of file Addon.cxx.

getDownloadUrl()

std::string flightgear::addons::Addon::getDownloadUrl

(

)

const

Definition at line 261 of file Addon.cxx.

getHomePage()

std::string flightgear::addons::Addon::getHomePage

(

)

const

Definition at line 255 of file Addon.cxx.

getId()

std::string flightgear::addons::Addon::getId

(

)

const

Definition at line 112 of file Addon.cxx.

getLicenseDesignation()

std::string flightgear::addons::Addon::getLicenseDesignation

(

)

const

Definition at line 154 of file Addon.cxx.

getLicenseFile()

SGPath flightgear::addons::Addon::getLicenseFile

(

)

const

Definition at line 160 of file Addon.cxx.

getLicenseUrl()

std::string flightgear::addons::Addon::getLicenseUrl

(

)

const

Definition at line 166 of file Addon.cxx.

getLoadedFlagNode()

SGPropertyNode_ptr flightgear::addons::Addon::getLoadedFlagNode

(

)

const

Definition at line 297 of file Addon.cxx.

getLoadSequenceNumber()

int flightgear::addons::Addon::getLoadSequenceNumber

(

)

const

Definition at line 302 of file Addon.cxx.

getLongDescription()

std::string flightgear::addons::Addon::getLongDescription

(

)

const

Definition at line 148 of file Addon.cxx.

getMaintainers()

std::vector< MaintainerRef > flightgear::addons::Addon::getMaintainers

(

)

const

Definition at line 136 of file Addon.cxx.

getMaxFGVersionRequired()

std::string flightgear::addons::Addon::getMaxFGVersionRequired

(

)

const

Definition at line 243 of file Addon.cxx.

getMenubarNodes()

std::vector< SGPropertyNode_ptr > flightgear::addons::Addon::getMenubarNodes

(

)

const

Definition at line 335 of file Addon.cxx.

getMinFGVersionRequired()

std::string flightgear::addons::Addon::getMinFGVersionRequired

(

)

const

Definition at line 237 of file Addon.cxx.

getName()

std::string flightgear::addons::Addon::getName

(

)

const

Definition at line 115 of file Addon.cxx.

getShortDescription()

std::string flightgear::addons::Addon::getShortDescription

(

)

const

Definition at line 142 of file Addon.cxx.

getStoragePath()

SGPath flightgear::addons::Addon::getStoragePath

(

)

const

Definition at line 184 of file Addon.cxx.

getSupportUrl()

std::string flightgear::addons::Addon::getSupportUrl

(

)

const

Definition at line 267 of file Addon.cxx.

getTags()

std::vector< std::string > flightgear::addons::Addon::getTags

(

)

const

Definition at line 172 of file Addon.cxx.

getTriggerProperty()

std::string flightgear::addons::Addon::getTriggerProperty

(

)

const

Definition at line 279 of file Addon.cxx.

getUrls()

std::multimap< UrlType, QualifiedUrl > flightgear::addons::Addon::getUrls

(

)

const

Definition at line 308 of file Addon.cxx.

getVersion()

AddonVersionRef flightgear::addons::Addon::getVersion

(

)

const

Definition at line 121 of file Addon.cxx.

resourcePath()

std::string flightgear::addons::Addon::resourcePath

(

const std::string &

relativePath

)

const

Definition at line 226 of file Addon.cxx.

retranslate()

void flightgear::addons::Addon::retranslate

(

)

update string values (description, etc) based on the active locale

Definition at line 471 of file Addon.cxx.

setAddonNode()

void flightgear::addons::Addon::setAddonNode

(

SGPropertyNode *

addonNode

)

Definition at line 288 of file Addon.cxx.

setAuthors()

void flightgear::addons::Addon::setAuthors

(

const std::vector< AuthorRef > &

addonAuthors

)

Definition at line 133 of file Addon.cxx.

setBasePath()

void flightgear::addons::Addon::setBasePath

(

const SGPath &

addonBasePath

)

Definition at line 181 of file Addon.cxx.

setCodeRepositoryUrl()

void flightgear::addons::Addon::setCodeRepositoryUrl

(

const std::string &

addonCodeRepositoryUrl

)

Definition at line 276 of file Addon.cxx.

setDownloadUrl()

void flightgear::addons::Addon::setDownloadUrl

(

const std::string &

addonDownloadUrl

)

Definition at line 264 of file Addon.cxx.

setHomePage()

void flightgear::addons::Addon::setHomePage

(

const std::string &

addonHomePage

)

Definition at line 258 of file Addon.cxx.

setLicenseDesignation()

void flightgear::addons::Addon::setLicenseDesignation

(

const std::string &

addonLicenseDesignation

)

Definition at line 157 of file Addon.cxx.

setLicenseFile()

void flightgear::addons::Addon::setLicenseFile

(

const SGPath &

addonLicenseFile

)

Definition at line 163 of file Addon.cxx.

setLicenseUrl()

void flightgear::addons::Addon::setLicenseUrl

(

const std::string &

addonLicenseUrl

)

Definition at line 169 of file Addon.cxx.

setLoadSequenceNumber()

void flightgear::addons::Addon::setLoadSequenceNumber

(

int

num

)

Definition at line 305 of file Addon.cxx.

setLongDescription()

void flightgear::addons::Addon::setLongDescription

(

const std::string &

addonLongDescription

)

Definition at line 151 of file Addon.cxx.

setMaintainers()

void flightgear::addons::Addon::setMaintainers

(

const std::vector< MaintainerRef > &

addonMaintainers

)

Definition at line 139 of file Addon.cxx.

setMaxFGVersionRequired()

void flightgear::addons::Addon::setMaxFGVersionRequired

(

const std::string &

maxFGVersionRequired

)

Definition at line 246 of file Addon.cxx.

setMenubarNodes()

void flightgear::addons::Addon::setMenubarNodes

(

const std::vector< SGPropertyNode_ptr > &

menubarNodes

)

Definition at line 338 of file Addon.cxx.

setMinFGVersionRequired()

void flightgear::addons::Addon::setMinFGVersionRequired

(

const std::string &

minFGVersionRequired

)

Definition at line 240 of file Addon.cxx.

setName()

void flightgear::addons::Addon::setName

(

const std::string &

addonName

)

Definition at line 118 of file Addon.cxx.

setShortDescription()

void flightgear::addons::Addon::setShortDescription

(

const std::string &

addonShortDescription

)

Definition at line 145 of file Addon.cxx.

setSupportUrl()

void flightgear::addons::Addon::setSupportUrl

(

const std::string &

addonSupportUrl

)

Definition at line 270 of file Addon.cxx.

setTags()

void flightgear::addons::Addon::setTags

(

const std::vector< std::string > &

addonTags

)

Definition at line 175 of file Addon.cxx.

setTriggerProperty()

void flightgear::addons::Addon::setTriggerProperty

(

const std::string &

addonTriggerProperty

)

Definition at line 282 of file Addon.cxx.

setupGhost()

void flightgear::addons::Addon::setupGhost ( nasal::Hash & addonsModule )

static

Definition at line 480 of file Addon.cxx.

setVersion()

void flightgear::addons::Addon::setVersion

(

const AddonVersion &

addonVersion

)

Definition at line 124 of file Addon.cxx.

str()

std::string flightgear::addons::Addon::str

(

)

const

Definition at line 351 of file Addon.cxx.

---

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

• Addon.hxx
• Addon.cxx