Public Types | Public Member Functions | List of all members
ibase::IObjectQueue Class Referenceabstract

Interface allowing to manage queue of some objects. More...

#include <IObjectQueue.h>

Inheritance diagram for ibase::IObjectQueue:
istd::IChangeable istd::IPolymorphic ibase::CObjectQueueComp

Public Types

typedef QVector
< istd::IChangeable * > 
ObjectList
 
- 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...
 

Public Member Functions

virtual int GetObjectsCount (const QByteArray *typeIdPtr=NULL) const =0
 Get number of objects in this queue. More...
 
virtual void ClearQueue ()=0
 Remove all objects from queue. More...
 
virtual istd::IChangeableCreateFrontObject (int offsetPos=0, const QByteArray *typeIdPtr=NULL)=0
 Create object at the front of this queue. More...
 
virtual istd::IChangeableCreateBackObject (int offsetPos=0, const QByteArray *typeIdPtr=NULL)=0
 Create object at the end of this queue. More...
 
virtual void RemoveFrontObject (int offsetPos=0, const QByteArray *typeIdPtr=NULL)=0
 Remove object at the front of this queue. More...
 
virtual void RemoveBackObject (int offsetPos=0, const QByteArray *typeIdPtr=NULL)=0
 Remove object at the end of this queue. More...
 
virtual istd::IChangeableGetFrontObject (int offsetPos=0, const QByteArray *typeIdPtr=NULL) const =0
 Get object at the front of queue. More...
 
virtual istd::IChangeableGetBackObject (int offsetPos=0, const QByteArray *typeIdPtr=NULL) const =0
 Get object at the end of queue. More...
 
virtual void SelectObjects (ObjectList &result, bool doAppend=false, int offsetPos=0, const QByteArray *typeIdPtr=NULL) const =0
 Find set of objects. More...
 
virtual istd::IChangeablePopFrontObject (int offsetPos=0, const QByteArray *typeIdPtr=NULL)=0
 Get object at the front of queue and remove it from queue. More...
 
virtual istd::IChangeablePopBackObject (int offsetPos=0, const QByteArray *typeIdPtr=NULL)=0
 Get object at the end of queue and remove it from queue. More...
 
- Public Member Functions inherited from istd::IChangeable
virtual int GetSupportedOperations () const
 Get set of flags for supported operations. More...
 
virtual bool CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS)
 Copy this object from another one. More...
 
virtual bool IsEqual (const IChangeable &object) const
 Compare this object with another object. More...
 
virtual IChangeableCloneMe (CompatibilityMode mode=CM_WITHOUT_REFS) const
 Make a copy of this object. More...
 
virtual bool ResetData (CompatibilityMode mode=CM_WITHOUT_REFS)
 Reset data to its default state. More...
 
virtual void BeginChanges (const ChangeSet &changeSet)
 Starts the change transaction. More...
 
virtual void EndChanges (const ChangeSet &changeSet)
 Ends the change transaction. More...
 
virtual void BeginChangeGroup (const ChangeSet &changeSet)
 Starts group of changes. More...
 
virtual void EndChangeGroup (const ChangeSet &changeSet)
 Ends group of changes. More...
 
- Public Member Functions inherited from istd::IPolymorphic
virtual ~IPolymorphic ()
 

Additional Inherited Members

- Static Public Member Functions inherited from istd::IChangeable
static const ChangeSetGetNoChanges ()
 Get empty set of changes. More...
 
static const ChangeSetGetAnyChange ()
 Get anonymous change set. More...
 
static const ChangeSetGetAllChanges ()
 Get anonymous change set. More...
 
static const ChangeSetGetDelegatedChanges ()
 Get delegated change set. More...
 
- Protected Member Functions inherited from istd::IChangeable
virtual void OnBeginChanges ()
 Callback function for begin change event. More...
 
virtual void OnEndChanges (const ChangeSet &changeSet)
 Callback function for end change event. More...
 

Detailed Description

Interface allowing to manage queue of some objects.

Definition at line 20 of file IObjectQueue.h.

Member Typedef Documentation

Definition at line 23 of file IObjectQueue.h.

Member Function Documentation

virtual void ibase::IObjectQueue::ClearQueue ( )
pure virtual

Remove all objects from queue.

Implemented in ibase::CObjectQueueComp.

virtual istd::IChangeable* ibase::IObjectQueue::CreateBackObject ( int  offsetPos = 0,
const QByteArray *  typeIdPtr = NULL 
)
pure virtual

Create object at the end of this queue.

This object belongs to queue, and will be by the queue removed from memory.

Parameters
offsetPosposition from the end, where the object should be placed.
typeIdPtroptional object ID, if many of object types are supported.

Implemented in ibase::CObjectQueueComp.

virtual istd::IChangeable* ibase::IObjectQueue::CreateFrontObject ( int  offsetPos = 0,
const QByteArray *  typeIdPtr = NULL 
)
pure virtual

Create object at the front of this queue.

This object belongs to queue, and will be by the queue removed from memory.

Parameters
offsetPosposition from the front, where the object should be placed.
typeIdPtroptional object ID, if many of object types are supported.

Implemented in ibase::CObjectQueueComp.

virtual istd::IChangeable* ibase::IObjectQueue::GetBackObject ( int  offsetPos = 0,
const QByteArray *  typeIdPtr = NULL 
) const
pure virtual

Get object at the end of queue.

Parameters
offsetPosposition from the end.
typeIdPtroptional object ID, if many of object types are supported.

Implemented in ibase::CObjectQueueComp.

virtual istd::IChangeable* ibase::IObjectQueue::GetFrontObject ( int  offsetPos = 0,
const QByteArray *  typeIdPtr = NULL 
) const
pure virtual

Get object at the front of queue.

Parameters
offsetPosposition from the front.
typeIdPtroptional object ID, if many of object types are supported.

Implemented in ibase::CObjectQueueComp.

virtual int ibase::IObjectQueue::GetObjectsCount ( const QByteArray *  typeIdPtr = NULL) const
pure virtual

Get number of objects in this queue.

Parameters
typeIdPtroptional object ID, if many of object types are supported.

Implemented in ibase::CObjectQueueComp.

virtual istd::IChangeable* ibase::IObjectQueue::PopBackObject ( int  offsetPos = 0,
const QByteArray *  typeIdPtr = NULL 
)
pure virtual

Get object at the end of queue and remove it from queue.

It means, this object will be overtaken by caller.

Parameters
offsetPosposition from the end.
typeIdPtroptional object ID, if many of object types are supported.

Implemented in ibase::CObjectQueueComp.

virtual istd::IChangeable* ibase::IObjectQueue::PopFrontObject ( int  offsetPos = 0,
const QByteArray *  typeIdPtr = NULL 
)
pure virtual

Get object at the front of queue and remove it from queue.

It means, this object will be overtaken by caller.

Parameters
offsetPosposition from the front.
typeIdPtroptional object ID, if many of object types are supported.

Implemented in ibase::CObjectQueueComp.

virtual void ibase::IObjectQueue::RemoveBackObject ( int  offsetPos = 0,
const QByteArray *  typeIdPtr = NULL 
)
pure virtual

Remove object at the end of this queue.

The object must not be physically removed from memory at this moment.

Parameters
offsetPosposition from the end.
typeIdPtroptional object ID, if many of object types are supported.

Implemented in ibase::CObjectQueueComp.

virtual void ibase::IObjectQueue::RemoveFrontObject ( int  offsetPos = 0,
const QByteArray *  typeIdPtr = NULL 
)
pure virtual

Remove object at the front of this queue.

The object must not be physically removed from memory at this moment.

Parameters
offsetPosposition from the front.
typeIdPtroptional object ID, if many of object types are supported.

Implemented in ibase::CObjectQueueComp.

virtual void ibase::IObjectQueue::SelectObjects ( ObjectList result,
bool  doAppend = false,
int  offsetPos = 0,
const QByteArray *  typeIdPtr = NULL 
) const
pure virtual

Find set of objects.

Implemented in ibase::CObjectQueueComp.


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

© 2007-2017 Witold Gantzke and Kirill Lepskiy