class libfwbuilder::FWObject

This class represents base class for all objects we are dealing with.

Inheritance:

Public Methods

DECLARE_FWOBJECT_SUBTYPE(FWObject)

virtual void fromXML(xmlNodePtr xml_parent_node)

virtual xmlNodePtr toXML(xmlNodePtr xml_parent_node)

void setXMLName(const string &)

Rarely used feature: we can change the name of XML element represented by the class derived from FWObject if we want to.

virtual ~FWObject()

int ref()

int unref()

virtual FWObject& operator=(const FWObject &)

This method copies content of object 'x' to object 'this', including ID.

virtual FWObject& duplicate(const FWObject* obj)

this method copies content of object 'x' in the object 'this' preserving object's 'this' ID

void Show()

void Hide()

FWObject* getParent()

void setParent(FWObject* p)

bool exists(const string &name) const

void remStr(const string &name)

const string& getStr(const string& name) const

void setStr(const string &name, const string &val)

int getInt(const string &name) const

void setInt(const string &name, int val)

bool getBool(const string &name) const

void setBool(const string &name, bool val)

void setBool(const string &name, const string &val)

const string& getName() const

void setName(const string& n)

const string& getComment() const

void setComment(const string& c)

const string& getLibrary() const

void setLibrary(const string& c)

const string& getId() const

void setId(const string& c)

void addAt(const string& where_id, FWObject* obj)

virtual void add(FWObject* obj)

virtual void insert_before(FWObject* o1, FWObject* obj)

virtual void insert_after(FWObject* o1, FWObject* obj)

virtual void swapObjects(FWObject* o1, FWObject* o2)

In direct children of 'this' swaps all references to o1 with o2 and vice versa

virtual bool GUISortOrder(const FWObject* a, const FWObject* b)

virtual void sortChildren()

virtual void remove(FWObject* obj, bool delete_if_last=true)

Finds first instance of 'obj' in children of this object and removes if.

virtual void removeAllInstances(FWObject* obj)

Finds and removes instances of 'obj' recursively in the whole tree under this object

virtual void addRef(FWObject* obj)

Adds reference object pointing to 'obj' as a child of 'this'

virtual void removeRef(FWObject* obj)

Removes reference to given object among children of 'this'

virtual void removeAllReferences(FWObject* obj)

Removes all references to 'obj' recursively in the whole tree under 'this'

virtual FWReference* createRef( FWObject* obj )

virtual bool validateChild(FWObject* o)

void clearChildren()

void clearChildren(const string &type_name)

int getChildrenCount()

virtual void dump(bool recursive, bool brief, int offset=0)

virtual void dump(std::ofstream &f, bool recursive, bool brief, int offset=0)

FWObject* getRoot()

Returns root of the objects tree this object is part of

virtual FWObject* getById(const string &id, bool recursive=false, bool dereference=false)

Returns object with given ID.

virtual vector<FWObject*> getByType(const string &type_name)

Returns list of direct children of current object whose getTypeName() same as given.

virtual FWObject* getFirstByType(const string &type_name)

Returns first of direct children of current object whose getTypeName() same as given or NULL if not found

void setDirty(bool f, bool recursive=false)

bool isDirty(bool recursive)

map<string, string> ::iterator dataBegin()

map<string, string> ::iterator dataEnd()

Protected Fields

string xml_name

map<string, string> data

Protected Methods

void _adopt(FWObject* obj)

FWObject* _find(const string& name)

Finds direct child of this object with given name

FWObject()

FWObject(FWObject &copy)

FWObject(FWObject* parent)

Documentation

This class represents base class for all objects we are dealing with.

FWObject can have children, that is other objects of the same class or derived classes which are included in this one

string xml_name

map<string, string> data

void _adopt(FWObject* obj)

FWObject* _find(const string& name)

Finds direct child of this object with given name

FWObject()

FWObject(FWObject &copy)

FWObject(FWObject* parent)

DECLARE_FWOBJECT_SUBTYPE(FWObject)

virtual void fromXML(xmlNodePtr xml_parent_node)

virtual xmlNodePtr toXML(xmlNodePtr xml_parent_node)

void setXMLName(const string &)

Rarely used feature: we can change the name of XML element represented by the class derived from FWObject if we want to. For example, used in all "Any" objects so we did not have to create extra classes

virtual ~FWObject()

int ref()

int unref()

virtual FWObject& operator=(const FWObject &)

This method copies content of object 'x' to object 'this', including ID. Resultant object is identical copy of 'x'. This is mostly used for creating scratchpad copies

virtual FWObject& duplicate(const FWObject* obj)

this method copies content of object 'x' in the object 'this' preserving object's 'this' ID

Thus, what we get in the end is still unique object, but its content is the same as that of the object 'x'

void Show()

void Hide()

FWObject* getParent()

void setParent(FWObject* p)

bool exists(const string &name) const

void remStr(const string &name)

const string& getStr(const string& name) const

void setStr(const string &name, const string &val)

int getInt(const string &name) const

void setInt(const string &name, int val)

bool getBool(const string &name) const

void setBool(const string &name, bool val)

void setBool(const string &name, const string &val)

const string& getName() const

void setName(const string& n)

const string& getComment() const

void setComment(const string& c)

const string& getLibrary() const

void setLibrary(const string& c)

const string& getId() const

void setId(const string& c)

void addAt(const string& where_id, FWObject* obj)

virtual void add(FWObject* obj)

virtual void insert_before(FWObject* o1, FWObject* obj)

virtual void insert_after(FWObject* o1, FWObject* obj)

virtual void swapObjects(FWObject* o1, FWObject* o2)

In direct children of 'this' swaps all references to o1 with o2 and vice versa

virtual bool GUISortOrder(const FWObject* a, const FWObject* b)

virtual void sortChildren()

virtual void remove(FWObject* obj, bool delete_if_last=true)

Finds first instance of 'obj' in children of this object and removes if. If 'obj' reference counter reaches 0 it is also deleted.

virtual void removeAllInstances(FWObject* obj)

Finds and removes instances of 'obj' recursively in the whole tree under this object

virtual void addRef(FWObject* obj)

Adds reference object pointing to 'obj' as a child of 'this'

virtual void removeRef(FWObject* obj)

Removes reference to given object among children of 'this'

virtual void removeAllReferences(FWObject* obj)

Removes all references to 'obj' recursively in the whole tree under 'this'

virtual FWReference* createRef( FWObject* obj )

virtual bool validateChild(FWObject* o)

void clearChildren()

void clearChildren(const string &type_name)

int getChildrenCount()

virtual void dump(bool recursive, bool brief, int offset=0)

virtual void dump(std::ofstream &f, bool recursive, bool brief, int offset=0)

FWObject* getRoot()

Returns root of the objects tree this object is part of

virtual FWObject* getById(const string &id, bool recursive=false, bool dereference=false)

Returns object with given ID. If recursive is 'false' search is restricted to direct children of given object and itslef. If it is true, method proceeds to all chidren of all objects starting from current one.

If dereference is 'false', references are treated as regular objects (that is, ID of FWReference object itself is compared with id). If dereference is 'true' then ID of the object pointed at by the reference is compared with id

virtual vector<FWObject*> getByType(const string &type_name)

Returns list of direct children of current object whose getTypeName() same as given. If not found, empty list is returned.

virtual FWObject* getFirstByType(const string &type_name)

Returns first of direct children of current object whose getTypeName() same as given or NULL if not found

void setDirty(bool f, bool recursive=false)

bool isDirty(bool recursive)

map<string, string> ::iterator dataBegin()

map<string, string> ::iterator dataEnd()

Direct child classes:

UDPService
TCPService
RuleSet
RuleElement
Network
Interval
Interface
IPService
ICMPService
Host
Group
FWReference
FWOptions
FWObjectDatabase
CustomService

Alphabetic index HTML hierarchy of classes or Java