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

Value object encapsulating information of a user. More...

Inheritance diagram for swift::misc::network::CUser:
[legend]

Public Types

enum  ColumnIndex {
  IndexEmail = CPropertyIndexRef::GlobalIndexCUser , IndexId , IndexIdInteger , IndexId7Digit ,
  IndexPassword , IndexRealName , IndexCallsign , IndexHomebase
}
 Properties by index.
 
- Public Types inherited from swift::misc::CValueObject< CUser >
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

 CUser ()=default
 Default constructor.
 
 CUser (const aviation::CCallsign &callsign)
 Constructor by callsign.
 
 CUser (const QString &id, const QString &realname, const aviation::CCallsign &callsign)
 Constructor.
 
 CUser (const QString &id, const QString &realname, const QString &email="", const QString &password="", const aviation::CCallsign &callsign={})
 Constructor.
 
const QString & getRealName () const
 Get full name.
 
void setRealName (const QString &realname)
 Set real name.
 
const QString & getPassword () const
 Get password.
 
void setPassword (const QString &pw)
 Set password.
 
bool isValid () const
 Valid user object?
 
bool isNull () const
 Null?
 
bool hasCredentials () const
 Valid credentials?
 
bool hasRealName () const
 Valid real name?
 
bool hasId () const
 Valid id?
 
bool hasValidVatsimId () const
 Has a valid VATSIM id?
 
bool hasCallsign () const
 Has associated callsign?
 
bool hasHomeBase () const
 Has home base?
 
bool hasValidHomeBase () const
 Has valid home base?
 
bool hasValidOrEmptyHomeBase () const
 Has valid or empty home base?
 
QString getRealNameAndHomeBase (const QString &separator=QString(" ")) const
 Real name + homebase.
 
QString getRealNameAndId () const
 Real name and id.
 
CStatusMessageList validate () const
 Validate, provide details about issues.
 
const QString & getEmail () const
 Get email.
 
void setEmail (const QString &email)
 Set email.
 
bool hasValidEmail () const
 Valid email?
 
const QString & getId () const
 Get id.
 
QString get7DigitId () const
 Numeric ids get a leading zeros if required.
 
int getIntegerId () const
 Id as integer if possible, otherwise -1.
 
bool hasNumericId () const
 Has a numeric id?
 
void setId (const QString &id)
 Set id.
 
const aviation::CAirportIcaoCodegetHomeBase () const
 Homebase.
 
void setHomeBase (const aviation::CAirportIcaoCode &homebase)
 Set homebase.
 
const aviation::CCallsigngetCallsign () const
 Get associated callsign.
 
bool setCallsign (const aviation::CCallsign &callsign)
 Set associated callsign.
 
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 CUser &compareValue) const
 Compare for index. More...
 
void synchronizeData (CUser &otherUser)
 This and another user exchange missing data, This user has priority and overrides first.
 
void updateMissingParts (const CUser &otherUser)
 Update missing parts in this object.
 
QString convertToQString (bool i18n=false) const
 Cast as QString. 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 bool isValidVatsimId (const QString &id)
 Valid VATSIM id.
 
static QString beautifyRealName (const QString &realName)
 Beautify real name, e.g. "JOE DoE" -> "Joe Doe";.
 
- 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< CUser >
 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

Value object encapsulating information of a user.

Definition at line 27 of file user.h.

Member Function Documentation

◆ comparePropertyByIndex()

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

Compare for index.

Definition at line 281 of file user.cpp.

◆ convertToQString()

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

Cast as QString.

Definition at line 70 of file user.cpp.

◆ propertyByIndex()

QVariant swift::misc::network::CUser::propertyByIndex ( CPropertyIndexRef  index) const

Property by index.

Definition at line 241 of file user.cpp.

◆ setPropertyByIndex()

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

Set property by index.

Definition at line 259 of file user.cpp.

◆ toIcon()

CIcons::IconIndex swift::misc::network::CUser::toIcon ( ) const
inline

As icon, not implemented by all classes.

Definition at line 146 of file user.h.


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