Files
pilotclient/src/blackmisc/identifier.h
2017-09-25 05:23:58 +02:00

134 lines
4.2 KiB
C++

/* Copyright (C) 2014
* swift Project Community / Contributors
*
* This file is part of swift project. It is subject to the license terms in the LICENSE file found in the top-level
* directory of this distribution and at http://www.swift-project.org/license.html. No part of swift project,
* including this file, may be copied, modified, propagated, or distributed except according to the terms
* contained in the LICENSE file.
*/
//! \file
#ifndef BLACKMISC_IDENTIFIER_H
#define BLACKMISC_IDENTIFIER_H
#include "blackmisc/blackmiscexport.h"
#include "blackmisc/metaclass.h"
#include "blackmisc/propertyindex.h"
#include "blackmisc/timestampbased.h"
#include "blackmisc/valueobject.h"
#include "blackmisc/variant.h"
#include <QByteArray>
#include <QMetaType>
#include <QString>
#include <QUuid>
#include <QtGlobal>
namespace BlackMisc
{
/*!
* Value object encapsulating information identifying a component of a modular distributed swift process (core, GUI, audio)
*/
class BLACKMISC_EXPORT CIdentifier :
public CValueObject<CIdentifier>,
public ITimestampBased
{
public:
//! Properties by index
enum ColumnIndex
{
IndexName = BlackMisc::CPropertyIndex::GlobalIndexCIdentifier,
IndexMachineId,
IndexMachineIdBase64,
IndexMachineName,
IndexProcessId,
IndexProcessName,
IndexIsFromLocalMachine,
IndexIsFromSameProcess,
IndexIsFromSameProcessName
};
//! Constructor.
CIdentifier(const QString &name = QString());
//! Returns an anonymous identifier.
static CIdentifier anonymous();
//! Returns a fake identifier.
static CIdentifier fake();
//! Produces a UUID generated from the identifier.
QUuid toUuid() const;
//! UUID string
QString toUuidString() const;
//! Name
QString getName() const { return m_name; }
//! Has name
bool hasName() const { return !m_name.isEmpty(); }
//! Get machine id
QByteArray getMachineId() const;
//! Machine 64 base64 encoded
QString getMachineIdBase64() const { return m_machineIdBase64; }
//! Machine name
QString getMachineName() const { return m_machineName; }
//! Get process id
qint64 getProcessId() const {return m_processId;}
//! Get process name
QString getProcessName() const {return m_processName;}
//! Check if originating from the same local machine
bool isFromLocalMachine() const;
//! Check if other identifier is from the same machine
bool isFromSameMachine(const CIdentifier &other) const;
//! Check if originating from the same process id
bool isFromSameProcess() const;
//! Check if originating from the same process name
bool isFromSameProcessName() const;
//! Check if it is anonymous identifier
bool isAnonymous() const;
//! \copydoc BlackMisc::Mixin::String::toQString
QString convertToQString(bool i18n = false) const;
//! \copydoc BlackMisc::Mixin::Index::propertyByIndex
CVariant propertyByIndex(const BlackMisc::CPropertyIndex &index) const;
//! \copydoc BlackMisc::Mixin::Index::setPropertyByIndex
void setPropertyByIndex(const BlackMisc::CPropertyIndex &index, const CVariant &variant);
private:
QString m_name; //!< object name
QString m_machineIdBase64; //!< base 64 encoded machine id
QString m_machineName; //!< human readable machine name
QString m_processName; //!< process name
qint64 m_processId; //!< PID
BLACK_METACLASS(
CIdentifier,
BLACK_METAMEMBER(name),
BLACK_METAMEMBER(machineIdBase64),
BLACK_METAMEMBER(machineName, 0, DisabledForComparison | DisabledForHashing),
BLACK_METAMEMBER(processName),
BLACK_METAMEMBER(processId),
BLACK_METAMEMBER(timestampMSecsSinceEpoch, 0, DisabledForComparison | DisabledForHashing)
);
};
} // namespace
Q_DECLARE_METATYPE(BlackMisc::CIdentifier)
#endif // guard