#include <cproperty.h>
Description
Stores a (NED) property with its (possibly compound) value.
The value consists of key-valuelist pairs; the key might be empty (default key).
Public Member Functions | |
Constructors, destructor, assignment. | |
| cProperty (const char *name=nullptr, const char *index=nullptr) | |
| cProperty (const cProperty &other) | |
| virtual | ~cProperty () |
| cProperty & | operator= (const cProperty &other) |
Redefined cObject functions | |
| virtual void | setName (const char *name) override |
| virtual const char * | getFullName () const override |
| virtual cProperty * | dup () const override |
| virtual std::string | str () const override |
| virtual void | parsimPack (cCommBuffer *buffer) const override |
| virtual void | parsimUnpack (cCommBuffer *buffer) override |
Property getter/setter methods | |
| virtual void | setIndex (const char *index) |
| virtual const char * | getIndex () const |
| virtual void | setIsImplicit (bool b) |
| virtual bool | isImplicit () const |
| virtual const std::vector< const char * > & | getKeys () const |
| virtual bool | containsKey (const char *key) const |
| virtual void | addKey (const char *key) |
| virtual int | getNumValues (const char *key) const |
| virtual void | setNumValues (const char *key, int size) |
| virtual const char * | getValue (const char *key="", int index=0) const |
| virtual void | setValue (const char *key, int index, const char *value) |
| virtual void | erase (const char *key) |
 Public Member Functions inherited from cNamedObject | |
| cNamedObject () | |
| cNamedObject (const char *name, bool namepooling=true) | |
| cNamedObject (const cNamedObject &obj) | |
| virtual | ~cNamedObject () |
| cNamedObject & | operator= (const cNamedObject &o) |
| virtual const char * | getName () const override |
| virtual void | setNamePooling (bool b) |
| virtual bool | getNamePooling () |
| Public Member Functions inherited from cObject | |
| cObject () | |
| cObject (const cObject &other) | |
| virtual | ~cObject () |
| virtual const char * | getClassName () const |
| bool | isName (const char *s) const |
| virtual std::string | getFullPath () const |
| const cObject * | getThisPtr () const |
| virtual _OPPDEPRECATED std::string | info () const |
| virtual _OPPDEPRECATED std::string | detailedInfo () const |
| virtual cObject * | getOwner () const |
| virtual bool | isOwnedObject () const |
| virtual void | forEachChild (cVisitor *v) |
| cObject * | findObject (const char *name, bool deep=true) |
| void | copyNotSupported () const |
Additional Inherited Members | |
| Protected Member Functions inherited from cObject | |
| virtual void | take (cOwnedObject *obj) |
| virtual void | drop (cOwnedObject *obj) |
| void | dropAndDelete (cOwnedObject *obj) |
Constructor & Destructor Documentation
◆ cProperty() [1/2]
|
explicit |
Constructor. The property name should be specified without the "@" mark.
◆ cProperty() [2/2]
◆ ~cProperty()
|
virtual |
Destructor.
Member Function Documentation
◆ operator=()
◆ setName()
|
overridevirtual |
◆ getFullName()
|
overridevirtual |
Redefined to return the property name plus optional index.
Reimplemented from cObject.
◆ dup()
|
inlineoverridevirtual |
Creates and returns an exact copy of this object.
Reimplemented from cObject.
◆ str()
|
overridevirtual |
Produces a one-line description of the object's contents.
Reimplemented from cObject.
◆ parsimPack()
|
overridevirtual |
Serializes the object into a buffer.
Reimplemented from cNamedObject.
◆ parsimUnpack()
|
overridevirtual |
Deserializes the object from a buffer.
Reimplemented from cNamedObject.
◆ setIndex()
|
virtual |
Sets the index of this property; see NED syntax @propname[index](keys-and-values).
◆ getIndex()
|
virtual |
Returns the index of this property; see NED syntax @propname[index](keys-and-values). Returns nullptr if the property has no index (@propname(keys-and-values)).
◆ setIsImplicit()
|
virtual |
Returns the "implicit" flag of this property.
◆ isImplicit()
|
virtual |
Returns whether this property is implicit. Implicit properties are those not spelled out in the NED file, but rather, added automatically during the parsing process or later.
◆ getKeys()
|
virtual |
Returns the list of keys if this property. The default key is listed as "".
◆ containsKey()
|
virtual |
Returns true if the property contains the given key. Specify "" or DEFAULTKEY for the default key.
◆ addKey()
|
virtual |
Adds the given key to the property. Has no effect if the key already exists.
◆ getNumValues()
|
virtual |
Returns the number of values for the given key in the property. Specify "" or DEFAULTKEY for the default key.
Returns 0 if the given key does not exist.
◆ setNumValues()
|
virtual |
Expands or trims the list of values for the given key in the property, by discarding elements or adding "" elements. Specify "" or DEFAULTKEY for the default key. Note that simply setting an element above getNumValues(key) will also expand the list.
Throws an error if the given key does not exist.
◆ getValue()
|
virtual |
Returns the indexth value for the given key in the property. Specify "" or DEFAULTKEY for the default key. If the key does not exist or the index is out of bounds, nullptr is returned.
◆ setValue()
|
virtual |
Replaces a value for the given key in the property. Specify "" or DEFAULTKEY for the default key. cProperty will create its own copy of the string passed. index may be greater than getNumValues(key); that will cause the values list to expand, the new elements filled with "".
Throws an error if the given key does not exist, or the index is negative.
◆ erase()
|
virtual |
Erases the given key and all its values.
The documentation for this class was generated from the following file:
