iprm::CIdParam Class Reference

Implementation of a named object over iprm::INameParam interface. More...

#include <CIdParam.h>

Inheritance diagram for iprm::CIdParam:

Public Member Functions
virtual QByteArray	GetId () const override
	Get the object ID.
virtual void	SetId (const QByteArray &id) override
	Set the object ID.
virtual bool	Serialize (iser::IArchive &archive) override
	Load or store state of this object as a archive stream.
virtual int	GetSupportedOperations () const override
	Get set of flags for supported operations.
virtual bool	CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS) override
virtual bool	IsEqual (const IChangeable &object) const override
virtual istd::IChangeableUniquePtr	CloneMe (istd::IChangeable::CompatibilityMode mode=istd::IChangeable::CM_WITHOUT_REFS) const override
	Make a copy of this object.
virtual bool	ResetData (CompatibilityMode mode=CM_WITHOUT_REFS) override
	Reset data to its default state.
Public Member Functions inherited from iser::ISerializable
virtual quint32	GetMinimalVersion (int versionId) const
	Get minimal needed version to correct storing of this data.
Public Member Functions inherited from istd::IChangeable
virtual bool	CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS)
	Copy this object from another one.
virtual bool	IsEqual (const IChangeable &object) const
	Compare this object with another object.
virtual void	BeginChanges (const ChangeSet &changeSet)
	Starts the change transaction.
virtual void	EndChanges (const ChangeSet &changeSet)
	Ends the change transaction.
virtual void	BeginChangeGroup (const ChangeSet &changeSet)
	Starts group of changes.
virtual void	EndChangeGroup (const ChangeSet &changeSet)
	Ends group of changes.
Public Member Functions inherited from istd::IPolymorphic
virtual	~IPolymorphic ()

Protected Attributes
QByteArray	m_id

Additional Inherited Members
Public Types inherited from istd::IChangeable
enum	ChangeFlags {   CF_ACF_INTERNAL = 0 , CF_ALL_DATA , CF_ANY , CF_DESTROYING ,   CF_DELEGATED , CF_NO_UNDO }
	Data model change notification flags. More...
enum	SupportedOperations {   SO_NONE = 0 , SO_OBSERVE = 1 << 0 , SO_COPY = 1 << 1 , SO_CLONE = 1 << 2 ,   SO_COMPARE = 1 << 3 , SO_RESET = 1 << 4 }
	Flags for supported operations. More...
enum	CompatibilityMode { CM_STRICT , CM_WITHOUT_REFS , CM_WITH_REFS , CM_CONVERT }
	Control how relationship betweeen objects are interpreted. More...
typedef QMultiMap< QByteArray, QVariant >	ChangeInfoMap
Static Public Member Functions inherited from istd::IChangeable
static const ChangeSet &	GetNoChanges ()
	Get empty set of changes.
static const ChangeSet &	GetAnyChange ()
	Get anonymous change set.
static const ChangeSet &	GetAllChanges ()
	Get anonymous change set.
static const ChangeSet &	GetDelegatedChanges ()
	Get delegated change set.
Protected Member Functions inherited from istd::IChangeable
virtual void	OnBeginChanges ()
	Callback function for begin change event.
virtual void	OnEndChanges (const ChangeSet &changeSet)
	Callback function for end change event.

Detailed Description

Implementation of a named object over iprm::INameParam interface.

Definition at line 16 of file CIdParam.h.

Member Function Documentation

CloneMe()

virtual istd::IChangeableUniquePtr iprm::CIdParam::CloneMe ( istd::IChangeable::CompatibilityMode  mode = istd::IChangeable::CM_WITHOUT_REFS ) const

overridevirtual

Make a copy of this object.

Returns

new instance or NULL, if this operation is not supported.

Reimplemented from istd::IChangeable.

CopyFrom()

virtual bool iprm::CIdParam::CopyFrom ( const IChangeable &  object, CompatibilityMode  mode = CM_WITHOUT_REFS  )

overridevirtual

GetId()

virtual QByteArray iprm::CIdParam::GetId ( ) const

overridevirtual

Get the object ID.

Returns

The current ID as QByteArray.

QByteArray id = idParam.GetId();
if (!id.isEmpty())
{
    qDebug() << "ID:" << id;
}

See also

SetId

Implements iprm::IIdParam.

GetSupportedOperations()

virtual int iprm::CIdParam::GetSupportedOperations ( ) const

overridevirtual

Get set of flags for supported operations.

See also

SupportedOperations

Reimplemented from istd::IChangeable.

IsEqual()

virtual bool iprm::CIdParam::IsEqual ( const IChangeable &  object ) const

overridevirtual

ResetData()

virtual bool iprm::CIdParam::ResetData ( CompatibilityMode  mode = CM_WITHOUT_REFS )

overridevirtual

Reset data to its default state.

Default implementation in istd::IChangeable does nothing.

Returns

true if the operation was successful, and false otherwise.

Reimplemented from istd::IChangeable.

Serialize()

virtual bool iprm::CIdParam::Serialize ( iser::IArchive &  archive )

overridevirtual

Load or store state of this object as a archive stream.

Type of operation is depending on archive type.

See also

iser::IArchive

Implements iser::ISerializable.

SetId()

virtual void iprm::CIdParam::SetId ( const QByteArray &  id )

overridevirtual

Set the object ID.

Changes the identifier value.

Parameters

id	New ID value. Can be empty or contain binary data.

// Set text-based ID
idParam.SetId("entity_42");
 
// Set binary ID
QByteArray binaryId = QByteArray::fromHex("1234abcd");
idParam.SetId(binaryId);
 
// Clear ID
idParam.SetId(QByteArray());

See also

GetId

Implements iprm::IIdParam.

Member Data Documentation

m_id

QByteArray iprm::CIdParam::m_id

protected

Definition at line 34 of file CIdParam.h.

---

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

• Acf/Include/iprm/CIdParam.h