swift
Public Types | Public Member Functions | Static Public Member Functions | List of all members
swift::misc::CApplicationInfo Class Reference

Description of a swift application. More...

Inheritance diagram for swift::misc::CApplicationInfo:
[legend]

Public Types

enum  Application {
  Unknown , Launcher , PilotClientCore , PilotClientGui ,
  MappingTool , UnitTest , Sample
}
 Enumeration of application roles.
 
enum  ColumnIndex {
  IndexApplication = CPropertyIndexRef::GlobalIndexCApplicationInfo , IndexApplicationAsString , IndexApplicationDataPath , IndexCompileInfo ,
  IndexExecutablePath , IndexExecutablePathExisting , IndexPlatformInfo , IndexProcessInfo ,
  IndexVersionString , IndexWordSize
}
 Properties by index.
 
- Public Types inherited from swift::misc::CValueObject< CApplicationInfo >
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

 CApplicationInfo ()=default
 Default constructor.
 
 CApplicationInfo (Application app)
 Constructor.
 
void setApplication (Application app)
 Set application.
 
Application getApplication () const
 Get application.
 
const QString & getApplicationAsString () const
 get application as string
 
void setExecutablePath (const QString &exePath)
 Set executable path.
 
const QString & getExecutablePath () const
 Get executable path.
 
bool isExecutablePathExisting () const
 Is the executable path existing? More...
 
void setApplicationDataDirectory (const QString &appDataDir)
 Set application data dir. More...
 
const QString & getApplicationDataDirectory () const
 Set application data dir. More...
 
void setVersionString (const QString &version)
 Set version string.
 
const QString & getVersionString () const
 Get version string.
 
void setProcessInfo (const CProcessInfo &process)
 Set process info.
 
const CProcessInfogetProcessInfo () const
 Get process info.
 
void setPlatformInfo (const QString &platform)
 Set platform.
 
const QString & getPlatform () const
 Get platform.
 
int getWordSize () const
 Word size.
 
void setWordSize (int size)
 Word size.
 
const QString & getCompileInfo () const
 Compile info.
 
void setCompileInfo (const QString &info)
 Compile info.
 
bool isSampleOrUnitTest () const
 Sample or unit test.
 
bool isUnitTest () const
 Unit test.
 
bool isNull () const
 Null object.
 
QString asOtherSwiftVersionString (const QString &separator=" | ") const
 Formatted info.
 
QString convertToQString (bool i18n=false) const
 Cast as QString. More...
 
CIcons::IconIndex toIcon () const
 As icon, not implemented by all classes. More...
 
QVariant propertyByIndex (CPropertyIndexRef index) const
 Property by index. More...
 
void setPropertyByIndex (CPropertyIndexRef index, const QVariant &variant)
 Set property by index. More...
 
int comparePropertyByIndex (CPropertyIndexRef index, const CApplicationInfo &compareValue) const
 Compare for 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.
 

Static Public Member Functions

static const QString & swiftPilotClientGui ()
 Name of pilot client GUI.
 
static const QString & swiftLauncher ()
 Name of swift launcher.
 
static const QString & swiftMappingTool ()
 Name of swift mapping tool.
 
static const QString & swiftCore ()
 Name of swift core.
 
static const CApplicationInfoautoInfo ()
 Info automatically initialized.
 
static const QString & fileName ()
 File name of the application info file.
 
static const CApplicationInfonull ()
 NULL info.
 
- 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< CApplicationInfo >
 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.
 

Detailed Description

Description of a swift application.

This is basically a CValueObject compliant version of CBuildConfig combined with CProcessInfo so we can store the information as JSON and transfer them via DBus.

Definition at line 25 of file applicationinfo.h.

Member Function Documentation

◆ comparePropertyByIndex()

int swift::misc::CApplicationInfo::comparePropertyByIndex ( CPropertyIndexRef  index,
const CApplicationInfo compareValue 
) const

Compare for index.

Definition at line 142 of file applicationinfo.cpp.

◆ convertToQString()

QString swift::misc::CApplicationInfo::convertToQString ( bool  i18n = false) const

Cast as QString.

Definition at line 77 of file applicationinfo.cpp.

◆ getApplicationDataDirectory()

const QString& swift::misc::CApplicationInfo::getApplicationDataDirectory ( ) const
inline

Set application data dir.

Remarks
rootdir of settings, cache and logs

Definition at line 87 of file applicationinfo.h.

◆ isExecutablePathExisting()

bool swift::misc::CApplicationInfo::isExecutablePathExisting ( ) const

Is the executable path existing?

Remarks
this indicates if the swift version is still existing
file check, relatively slow

Definition at line 50 of file applicationinfo.cpp.

◆ propertyByIndex()

QVariant swift::misc::CApplicationInfo::propertyByIndex ( CPropertyIndexRef  index) const

Property by index.

Definition at line 96 of file applicationinfo.cpp.

◆ setApplicationDataDirectory()

void swift::misc::CApplicationInfo::setApplicationDataDirectory ( const QString &  appDataDir)
inline

Set application data dir.

Remarks
rootdir of settings, cache and logs

Definition at line 83 of file applicationinfo.h.

◆ setPropertyByIndex()

void swift::misc::CApplicationInfo::setPropertyByIndex ( CPropertyIndexRef  index,
const QVariant &  variant 
)

Set property by index.

Definition at line 117 of file applicationinfo.cpp.

◆ toIcon()

CIcons::IconIndex swift::misc::CApplicationInfo::toIcon ( ) const

As icon, not implemented by all classes.

Definition at line 83 of file applicationinfo.cpp.


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