swift
Public Types | Public Member Functions | Static Public Member Functions | List of all members
swift::core::data::CGlobalSetup Class Reference

Global settings for readers, debug flags, etc. More...

Inheritance diagram for swift::core::data::CGlobalSetup:
[legend]

Public Types

enum  ColumnIndex {
  IndexDbRootDirectory = swift::misc::CPropertyIndexRef::GlobalIndexCGlobalSetup , IndexDbHttpsPort , IndexDbLoginService , IndexVatsimStatus ,
  IndexVatsimMetars , IndexVatsimData , IndexVatsimServer , IndexVatsimHttpFsd ,
  IndexOnlineHelpUrl , IndexSharedUrl , IndexMappingMinimumVersion , IndexPredefinedServers ,
  IndexAfvApiServerUrl , IndexAfvMapUrl
}
 Properties by index.
 
- Public Types inherited from swift::misc::CValueObject< CGlobalSetup >
using base_type = CEmpty
 Base class.
 
- Public Types inherited from swift::misc::CEmpty
using base_type = CEmpty
 Base class is alias of itself.
 
- Public Types inherited from swift::misc::mixin::Index< Derived >
enum  ColumnIndex { IndexPixmap = 10 , IndexIcon , IndexString }
 Base class enums.
 

Public Member Functions

 CGlobalSetup ()
 Default constructor.
 
int getDbHttpsPort () const
 Https port.
 
bool dbDebugFlag () const
 Debug flag.
 
void setServerDebugFlag (bool debug)
 Set debug flag.
 
const swift::misc::network::CUrlgetDbRootDirectoryUrl () const
 Root directory of DB.
 
swift::misc::network::CUrl getDbIcaoReaderUrl () const
 ICAO reader URL. More...
 
swift::misc::network::CUrl getDbModelReaderUrl () const
 Model reader URL. More...
 
swift::misc::network::CUrl getDbAirportReaderUrl () const
 Airport reader URL. More...
 
swift::misc::network::CUrl getDbInfoReaderUrl () const
 Info data reader URL. More...
 
swift::misc::network::CUrl getDbHomePageUrl () const
 Home page url. More...
 
swift::misc::network::CUrl getLegalDirectoryUrl () const
 Legal directory URL. More...
 
swift::misc::network::CUrl getDbLoginServiceUrl () const
 Login service. More...
 
const swift::misc::network::CUrlgetSwiftSharedUrl () const
 Shared URL.
 
const swift::misc::network::CUrlgetVatsimMetarsUrl () const
 VATSIM METAR URL.
 
const swift::misc::network::CUrlgetVatsimStatusFileUrl () const
 VATSIM status file URL.
 
const swift::misc::network::CUrlgetVatsimDataFileUrl () const
 VATSIM data file URL.
 
swift::misc::network::CUrl getVatsimServerFileUrl () const
 VATSIM server file URL.
 
swift::misc::network::CUrl getVatsimFsdHttpUrl () const
 VATSIM server file URL.
 
swift::misc::network::CUrl getHelpPageUrl (const QString &context={}) const
 Help page URL.
 
const swift::misc::network::CServerListgetPredefinedServers () const
 Predefined servers.
 
swift::misc::network::CServerList getPredefinedServersPlusHardcodedServers () const
 Predefined plus hardcoded.
 
const QString & getMappingMinimumVersionString () const
 Creating mappings requires at least this version or higher. More...
 
bool isSwiftVersionMinimumMappingVersion () const
 Meets the minimum mapping version. More...
 
swift::misc::network::CUrl getComNavEquipmentHelpUrl () const
 COM/NAV equipment code help URL.
 
swift::misc::network::CUrl getSsrEquipmentHelpUrl () const
 SSR equipment code help URL.
 
swift::misc::network::CUrl getAfvApiServerUrl () const
 AFV voice server URL.
 
swift::misc::network::CUrl getAfvMapUrl () const
 AFV map URL.
 
swift::misc::network::CUrl getVatsimAuthUrl () const
 VATSIM auth URL.
 
QString convertToQString (bool i18n=false) const
 Cast as QString. More...
 
QString convertToQString (const QString &separator, bool i18n=false) const
 To string with separator.
 
swift::misc::network::CUrl getSharedDbDataDirectoryUrl ()
 Get shared DB data directory URL.
 
QVariant propertyByIndex (swift::misc::CPropertyIndexRef index) const
 Property by index. More...
 
void setPropertyByIndex (swift::misc::CPropertyIndexRef index, const QVariant &variant)
 Set property by index. More...
 
- Public Member Functions inherited from swift::misc::mixin::MetaType< Derived >
int getMetaTypeId () const
 Returns the Qt meta type ID of this object. More...
 
QString getClassName () const
 Class name.
 
bool isA (int metaTypeId) const
 Returns true if this object is an instance of the class with the given meta type ID, or one of its subclasses.
 
- Public Member Functions inherited from swift::misc::mixin::DBusByMetaClass< Derived, Tags >
void marshallToDbus (QDBusArgument &arg, Tags...) const
 Marshall without begin/endStructure, for when composed within another object.
 
void unmarshallFromDbus (const QDBusArgument &arg, Tags...)
 Unmarshall without begin/endStructure, for when composed within another object.
 
- Public Member Functions inherited from swift::misc::mixin::DataStreamByMetaClass< Derived >
void marshalToDataStream (QDataStream &stream) const
 Marshal a value to a QDataStream.
 
void unmarshalFromDataStream (QDataStream &stream)
 Unmarshal a value from a QDataStream.
 
- Public Member Functions inherited from swift::misc::mixin::JsonByMetaClass< Derived >
QJsonObject toJson () const
 Cast to JSON object.
 
QString toJsonString (QJsonDocument::JsonFormat format=QJsonDocument::Indented) const
 Convenience function JSON as string.
 
void convertFromJson (const QJsonObject &json)
 Assign from JSON object.
 
void convertFromJson (const QString &jsonString, bool acceptCacheFormat=false)
 Assign from JSON object string.
 
- Public Member Functions inherited from swift::misc::mixin::String< Derived >
QString toQString (bool i18n=false) const
 Cast as QString.
 
std::string toStdString (bool i18n=false) const
 To std string.
 
QString stringForStreaming () const
 String for streaming operators.
 
- Public Member Functions inherited from swift::misc::mixin::Index< Derived >
CPropertyIndexList apply (const CPropertyIndexVariantMap &indexMap, bool skipEqualValues=false)
 Update by variant map. More...
 
void setPropertyByIndex (CPropertyIndexRef index, const QVariant &variant)
 Set property by index.
 
QVariant propertyByIndex (CPropertyIndexRef index) const
 Property by index.
 
int comparePropertyByIndex (CPropertyIndexRef index, const Derived &compareValue) const
 Compare for index.
 
bool equalsPropertyByIndex (const QVariant &compareValue, CPropertyIndexRef index) const
 Is given variant equal to value of property index?
 
- Public Member Functions inherited from swift::misc::mixin::Icon< Derived, IconIndex >
CIcons::IconIndex toIcon () const
 As icon, not implemented by all classes.
 
- Public Member Functions inherited from swift::misc::CIdentifiable
const CIdentifieridentifier () const
 Get identifier.
 
void setIdentifier (const CIdentifier &identifier)
 Set identifier, allows to set an external identifier.
 
bool isMyIdentifier (const CIdentifier &otherIdentifier) const
 My identifier?
 

Static Public Member Functions

static const QString & schemaVersionString ()
 Schema version (shared files, bootstrap file)
 
- Static Public Member Functions inherited from swift::misc::mixin::MetaType< Derived >
static void registerMetadata ()
 Register metadata.
 
- Static Public Member Functions inherited from swift::misc::mixin::JsonByMetaClass< Derived >
template<class DerivedObj = Derived>
static DerivedObj fromJson (const QJsonObject &json)
 Get object from QJsonObject.
 
template<class DerivedObj = Derived>
static DerivedObj fromJson (const QString &jsonString, bool acceptCacheJson=false)
 Get object from JSON string.
 
template<class DerivedObj = Derived>
static DerivedObj fromJsonNoThrow (const QString &jsonString, bool acceptCacheJson, bool &success, QString &errMsg)
 Get object from JSON string.
 

Additional Inherited Members

- Protected Member Functions inherited from swift::misc::CValueObject< CGlobalSetup >
 CValueObject ()=default
 Default constructor.
 
 CValueObject (const CValueObject &)=default
 Copy constructor.
 
CValueObjectoperator= (const CValueObject &)=default
 Copy assignment operator.
 
 ~CValueObject ()=default
 Destructor.
 
 CEmpty ()=default
 Inheriting constructors.
 
 CEmpty (const CEmpty &)=default
 Inheriting constructors.
 
- Protected Member Functions inherited from swift::misc::CEmpty
 CEmpty ()=default
 Protected default constructor.
 
 CEmpty (const CEmpty &)=default
 Protected copy constructor.
 
CEmptyoperator= (const CEmpty &)=default
 Protected copy assignment operator.
 
 ~CEmpty ()=default
 Non-virtual protected destructor.
 
- Protected Member Functions inherited from swift::misc::CIdentifiable
 CIdentifiable (const QString &objectName)
 Use literal based object name.
 
 CIdentifiable (QObject *nameProvider)
 Connect with QObject providing the name.
 
 CIdentifiable ()
 Construct without a name.
 
 ~CIdentifiable ()
 Destructor.
 
 CIdentifiable (const CIdentifiable &)=default
 Copy constructor.
 
CIdentifiableoperator= (const CIdentifiable &)=default
 Copy assignment operator.
 

Detailed Description

Global settings for readers, debug flags, etc.

Note
also called the bootstrap file as it is required once to get information where all the data are located

Definition at line 28 of file globalsetup.h.

Member Function Documentation

◆ convertToQString()

QString swift::core::data::CGlobalSetup::convertToQString ( bool  i18n = false) const

Cast as QString.

Definition at line 92 of file globalsetup.cpp.

◆ getDbAirportReaderUrl()

CUrl swift::core::data::CGlobalSetup::getDbAirportReaderUrl ( ) const

Airport reader URL.

Remarks
based on getDbRootDirectoryUrl

Definition at line 37 of file globalsetup.cpp.

◆ getDbHomePageUrl()

CUrl swift::core::data::CGlobalSetup::getDbHomePageUrl ( ) const

Home page url.

Remarks
based on getDbRootDirectoryUrl

Definition at line 42 of file globalsetup.cpp.

◆ getDbIcaoReaderUrl()

CUrl swift::core::data::CGlobalSetup::getDbIcaoReaderUrl ( ) const

ICAO reader URL.

Remarks
based on getDbRootDirectoryUrl

Definition at line 33 of file globalsetup.cpp.

◆ getDbInfoReaderUrl()

CUrl swift::core::data::CGlobalSetup::getDbInfoReaderUrl ( ) const

Info data reader URL.

Remarks
based on getDbRootDirectoryUrl

Definition at line 39 of file globalsetup.cpp.

◆ getDbLoginServiceUrl()

CUrl swift::core::data::CGlobalSetup::getDbLoginServiceUrl ( ) const

Login service.

Remarks
based on getDbRootDirectoryUrl

Definition at line 61 of file globalsetup.cpp.

◆ getDbModelReaderUrl()

CUrl swift::core::data::CGlobalSetup::getDbModelReaderUrl ( ) const

Model reader URL.

Remarks
based on getDbRootDirectoryUrl

Definition at line 35 of file globalsetup.cpp.

◆ getLegalDirectoryUrl()

CUrl swift::core::data::CGlobalSetup::getLegalDirectoryUrl ( ) const

Legal directory URL.

Remarks
based on getDbRootDirectoryUrl

Definition at line 59 of file globalsetup.cpp.

◆ getMappingMinimumVersionString()

const QString& swift::core::data::CGlobalSetup::getMappingMinimumVersionString ( ) const
inline

Creating mappings requires at least this version or higher.

Remarks
only valid if wasLoaded() is true

Definition at line 124 of file globalsetup.h.

◆ isSwiftVersionMinimumMappingVersion()

bool swift::core::data::CGlobalSetup::isSwiftVersionMinimumMappingVersion ( ) const

Meets the minimum mapping version.

Remarks
only valid if wasLoaded() is true

Definition at line 85 of file globalsetup.cpp.

◆ propertyByIndex()

QVariant swift::core::data::CGlobalSetup::propertyByIndex ( swift::misc::CPropertyIndexRef  index) const

Property by index.

Definition at line 119 of file globalsetup.cpp.

◆ setPropertyByIndex()

void swift::core::data::CGlobalSetup::setPropertyByIndex ( swift::misc::CPropertyIndexRef  index,
const QVariant &  variant 
)

Set property by index.

Definition at line 144 of file globalsetup.cpp.


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