DABC (Data Acquisition Backbone Core)  2.9.9
Public Member Functions | Protected Member Functions | Protected Attributes | Friends
dabc::RecordContainer Class Reference

Container for records fields. More...

#include <dabc/Record.h>

Inheritance diagram for dabc::RecordContainer:
dabc::Object dabc::CommandContainer dabc::HierarchyContainer dabc::HistoryIterContainer dabc::ParameterContainer dabc::ConnectionObject

Public Member Functions

virtual const char * ClassName () const
 Returns class name of the object instance. More...
 
RecordFieldsMapFields () const
 
virtual void Print (int lvl=0)
 Print object content on debug output. More...
 
virtual ~RecordContainer ()
 
- Public Member Functions inherited from dabc::Object
bool AddChild (Object *child, bool withmutex=true) throw ()
 Add object to list of child objects, thread safe More...
 
bool AddChildAt (Object *child, unsigned pos, bool withmutex=true)
 Add object to list of child objects at specified position. More...
 
virtual void BuildFieldsMap (RecordFieldsMap *cont)
 Fill fields map, which is relevant for the object Objects hierarchy produced from dabc::Manager. More...
 
virtual bool Find (ConfigIO &cfg)
 Method to locate object in xml file. More...
 
ObjectFindChild (const char *name) const
 returns pointer on child object with given name More...
 
Reference FindChildRef (const char *name, bool force=false) const throw ()
 returns reference on child object with given name More...
 
bool GetAllChildRef (ReferencesVector *vect) const
 
ObjectGetChild (unsigned n) const
 returns pointer on child object More...
 
Reference GetChildRef (unsigned n) const
 returns reference on child object More...
 
Reference GetFolder (const std::string &name, bool force=false) throw ()
 Return folder of specified name, no special symbols allowed. More...
 
const char * GetName () const
 Returns name of the object, thread safe More...
 
ObjectGetParent () const
 Returns pointer on parent object, thread safe More...
 
Reference GetParentRef () const
 
bool IsChildsHidden () const
 Return true if object wants to hide childs from hierarchy scan, thread safe More...
 
bool IsHidden () const
 Return true if object wants to be hidden from hierarchy scan, thread safe More...
 
bool IsLogging () const
 Return true if object selected for logging, thread safe More...
 
bool IsName (const char *str) const
 Checks if object name is same as provided string, thread safe More...
 
bool IsName (const char *str, int len) const
 Checks if object name is same as provided, thread safe More...
 
bool IsName (const std::string &str) const
 Checks if object name is same as provided string, thread safe More...
 
bool IsNameMatch (const std::string &mask) const
 Check if object name match to the mask. More...
 
bool IsOwner () const
 Returns true if object is owner of its children, thread safe More...
 
bool IsParent (Object *obj) const
 Checks if specified argument is in the list of object parents. More...
 
bool IsTopXmlLevel () const
 Return true if object should be searched in the top level of the xml file, thread safe More...
 
std::string ItemName (bool compact=true) const
 Produce string, which can be used as name argument in dabc::mgr.FindItem(name) call. More...
 
unsigned NumChilds () const
 returns number of child objects More...
 
 Object (const std::string &name, unsigned flags=flIsOwner)
 Resolve problem with child-parent mutex locking. More...
 
 Object (Reference parent, const std::string &name, unsigned flags=flIsOwner)
 
bool RemoveChild (Object *child, bool cleanup=true) throw ()
 Detach child from parent object If cleanup==true and parent is owner of child, child will be destroyed. More...
 
bool RemoveChildAt (unsigned n, bool cleanup=true) throw ()
 Detach child object from parent at specified position If cleanup==true and object is owner of child, child will be destroyed. More...
 
bool RemoveChilds (bool cleanup=true)
 Remove all childs. More...
 
void SetLogging (bool on=true)
 Sets logging flag, thread safe More...
 
virtual ~Object ()
 

Protected Member Functions

virtual std::string FieldName (unsigned cnt) const
 
virtual RecordField GetField (const std::string &name) const
 
virtual bool HasField (const std::string &name) const
 
virtual unsigned NumFields () const
 
 RecordContainer (const std::string &name, unsigned flags=flIsOwner)
 
 RecordContainer (Reference parent, const std::string &name, unsigned flags=flIsOwner)
 
virtual bool RemoveField (const std::string &name)
 
virtual bool SaveTo (HStore &store, bool create_node=true)
 
virtual bool SetField (const std::string &name, const RecordField &v)
 
void SetFieldsMap (RecordFieldsMap *newmap)
 Replaces existing fields map. More...
 
RecordFieldsMapTakeFieldsMap ()
 Remove map and returns to the user. More...
 
- Protected Member Functions inherited from dabc::Object
virtual void _ChildsChanged ()
 Method called when new childs are add or old are removed. More...
 
virtual bool _DoDeleteItself ()
 This method is called at the moment when DecReference think that object can be destroyed and wants to return true. More...
 
bool _IsNormalState ()
 Same as IsNormalState() but without mutex lock - user should lock mutex himself. More...
 
virtual ObjectCreateInstance (const std::string &name)
 Method used to create new item to be placed as child of the object. More...
 
void DeleteThis ()
 Method should be used by the object to delete itself. More...
 
virtual bool DestroyByOwnThread ()
 Internal DABC method, used to activate object cleanup via object thread Returns: false - object cannot be cleanup by the thread, true - thread guarantees that DestroyCalledFromOwnThread() will be called from thread context. More...
 
bool DestroyCalledFromOwnThread ()
 Internal DABC method, should be called by thread which was requested to destroy object. More...
 
void FillFullName (std::string &fullname, Object *upto, bool exclude_top_parent=false) const
 Method used to produce full item name,. More...
 
bool GetFlag (unsigned fl) const
 Return value of selected flag, not thread safe
More...
 
bool IsNormalState ()
 Return true if object is in normal state. More...
 
unsigned NumReferences ()
 Return number of references on the object. More...
 
 Object (const ConstructorPair &pair, unsigned flags=flIsOwner)
 
virtual void ObjectCleanup ()
 User method to cleanup object content before it will be destroyed Main motivation is to release any references on other objects to avoid any cross-references and as result deadlocks in objects cleanup. More...
 
virtual void ObjectDestroyed (Object *)
 Method called by the manager when registered dependent object is destroyed Should be used in user class to clear all references on the object to let destroy it. More...
 
MutexObjectMutex () const
 Returns mutex, used for protection of Object data members. More...
 
void SetAutoDestroy (bool on=true)
 Set autodestroy flag for the object Once enabled, object will be destroyed when last reference will be cleared. More...
 
void SetFlag (unsigned fl, bool on=true)
 Change value of selected flag, not thread safe
More...
 
void SetName (const char *name)
 Changes object name. More...
 
void SetNameDirect (const char *name)
 Changes object name disregard of existing references. More...
 
void SetOwner (bool on=true)
 Specifies if object will be owner of its new childs. More...
 

Protected Attributes

RecordFieldsMapfFields
 
- Protected Attributes inherited from dabc::Object
int fObjectBlock
 counter for blocking calls, as long as non-zero, non of child can be removed More...
 
ReferencesVectorfObjectChilds
 list of the child objects More...
 
unsigned fObjectFlags
 flag, protected by the mutex More...
 
MutexfObjectMutex
 mutex protects all private property of the object More...
 
std::string fObjectName
 object name More...
 
Reference fObjectParent
 reference on the parent object More...
 
int fObjectRefCnt
 accounts how many references existing on the object, thread safe More...
 

Friends

class ConfigIO
 
class Record
 
class RecordField
 
class RecordFieldsMap
 

Additional Inherited Members

- Static Public Member Functions inherited from dabc::Object
static void Destroy (Object *obj) throw ()
 User method for object destroyment. More...
 
static void InspectGarbageCollector ()
 \ brief Methods to inspect how many objects pointers are remained More...
 
static bool NameMatch (const std::string &name, const std::string &mask)
 Check if name matches to specified mask. More...
 
static bool NameMatchM (const std::string &name, const std::string &mask)
 Check if name matches to specified mask. More...
 
static unsigned NumInstances ()
 Static variable counts total number of objects instances. More...
 
- Protected Types inherited from dabc::Object
enum  EFlags {
  flStateMask = 0x000f , flIsOwner = 0x0010 , flCleanup = 0x0020 , flHasThread = 0x0040 ,
  flAutoDestroy = 0x0080 , flLogging = 0x0100 , flNoMutex = 0x0200 , flHidden = 0x0400 ,
  flChildsHidden = 0x0800 , flTopXmlLevel = 0x1000
}
 
- Static Protected Member Functions inherited from dabc::Object
static ConstructorPair MakePair (const std::string &fullname, bool withmanager=true)
 Internal DABC method, used to produce pair - object parent and object name, which is typically should be used as argument in class constructor. More...
 
static ConstructorPair MakePair (Object *prnt, const std::string &fullname, bool withmanager=true)
 Internal DABC method, used to produce pair - object parent and object name, which is typically should be used as argument in class constructor. More...
 
static ConstructorPair MakePair (Reference prnt, const std::string &fullname, bool withmanager=true)
 Internal DABC method, used to produce pair - object parent and object name, which is typically should be used as argument in class constructor. More...
 

Detailed Description

Container for records fields.

Definition at line 440 of file Record.h.

Constructor & Destructor Documentation

◆ RecordContainer() [1/2]

dabc::RecordContainer::RecordContainer ( const std::string &  name,
unsigned  flags = flIsOwner 
)
protected

Definition at line 1603 of file Record.cxx.

◆ RecordContainer() [2/2]

dabc::RecordContainer::RecordContainer ( Reference  parent,
const std::string &  name,
unsigned  flags = flIsOwner 
)
protected

Definition at line 1609 of file Record.cxx.

◆ ~RecordContainer()

dabc::RecordContainer::~RecordContainer ( )
virtual

Definition at line 1615 of file Record.cxx.

Member Function Documentation

◆ TakeFieldsMap()

dabc::RecordFieldsMap * dabc::RecordContainer::TakeFieldsMap ( )
protected

Remove map and returns to the user.

It is user responsibility to correctly destroy it

Definition at line 1620 of file Record.cxx.

◆ SetFieldsMap()

void dabc::RecordContainer::SetFieldsMap ( RecordFieldsMap newmap)
protected

Replaces existing fields map.

Definition at line 1627 of file Record.cxx.

◆ HasField()

virtual bool dabc::RecordContainer::HasField ( const std::string &  name) const
inlineprotectedvirtual

Reimplemented in dabc::ParameterContainer.

Definition at line 460 of file Record.h.

◆ RemoveField()

virtual bool dabc::RecordContainer::RemoveField ( const std::string &  name)
inlineprotectedvirtual

Reimplemented in dabc::ParameterContainer.

Definition at line 463 of file Record.h.

◆ NumFields()

virtual unsigned dabc::RecordContainer::NumFields ( ) const
inlineprotectedvirtual

Reimplemented in dabc::ParameterContainer.

Definition at line 466 of file Record.h.

◆ FieldName()

virtual std::string dabc::RecordContainer::FieldName ( unsigned  cnt) const
inlineprotectedvirtual

Reimplemented in dabc::ParameterContainer.

Definition at line 469 of file Record.h.

◆ GetField()

virtual RecordField dabc::RecordContainer::GetField ( const std::string &  name) const
inlineprotectedvirtual

Reimplemented in dabc::ParameterContainer.

Definition at line 472 of file Record.h.

◆ SetField()

virtual bool dabc::RecordContainer::SetField ( const std::string &  name,
const RecordField v 
)
inlineprotectedvirtual

Reimplemented in dabc::ParameterContainer.

Definition at line 475 of file Record.h.

◆ SaveTo()

bool dabc::RecordContainer::SaveTo ( HStore store,
bool  create_node = true 
)
protectedvirtual

Reimplemented in dabc::HierarchyContainer.

Definition at line 1645 of file Record.cxx.

◆ ClassName()

virtual const char* dabc::RecordContainer::ClassName ( ) const
inlinevirtual

Returns class name of the object instance.

In some cases class name used to correctly locate object in xml file

Reimplemented from dabc::Object.

Reimplemented in dabc::ParameterContainer, dabc::HierarchyContainer, dabc::ConnectionObject, and dabc::CommandContainer.

Definition at line 484 of file Record.h.

◆ Print()

void dabc::RecordContainer::Print ( int  lvl = 0)
virtual

Print object content on debug output.

Reimplemented from dabc::Object.

Definition at line 1634 of file Record.cxx.

◆ Fields()

RecordFieldsMap& dabc::RecordContainer::Fields ( ) const
inline

Definition at line 488 of file Record.h.

Friends And Related Function Documentation

◆ Record

friend class Record
friend

Definition at line 441 of file Record.h.

◆ RecordField

friend class RecordField
friend

Definition at line 442 of file Record.h.

◆ ConfigIO

friend class ConfigIO
friend

Definition at line 443 of file Record.h.

◆ RecordFieldsMap

friend class RecordFieldsMap
friend

Definition at line 444 of file Record.h.

Field Documentation

◆ fFields

RecordFieldsMap* dabc::RecordContainer::fFields
protected

Definition at line 447 of file Record.h.


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