carto::ReferenceObject< T > Class Template Reference
storage wrapper, derived and instanciable template class More...
#include <cartobase/object/object.h>
Inheritance diagram for carto::ReferenceObject< T >:
Collaboration diagram for carto::ReferenceObject< T >:
Public Member Functions | |
| ReferenceObject (T &x) | |
| virtual | ~ReferenceObject () |
| virtual T & | getValue () |
| virtual Object | clone () const |
| cloning copy | |
 Public Member Functions inherited from carto::TypedObject< T > | |
| TypedObject () | |
| virtual | ~TypedObject () |
| const T & | getValue () const |
| virtual void | setValue (Object val) |
| virtual std::string | type () const |
| type() returns the DataTypeCode::name() of the underlying object type | |
| virtual bool | isScalar () const |
| Returns false if the stored object doesn't actually implement the ScalarInterface API (needed since all GenericObject inherit this interface whatever they actually contain) | |
| virtual double | getScalar () const |
| Obtain a scalar value, possibly after a conversion. | |
| virtual void | setScalar (double) |
| The double value will be converted to the actual storage type before it is set in the contained object. | |
| virtual bool | isString () const |
| Returns false if the stored object doesn't actually implement the StringInterface API (needed since all GenericObject inherit this interface whatever they actually contain) | |
| virtual std::string | getString () const |
| Obtain a string value, possibly after a conversion. | |
| virtual void | setString (const std::string &) |
| The string value may be converted to the actual storage type before it is set in the contained object. | |
| virtual bool | isArray () const |
| Returns false if the stored object doesn't actually implement the ArrayInterface API (needed since all GenericObject inherit this interface whatever they actually contain) | |
| virtual bool | isContiguous () const |
| Tells if array indices are contiguous (as in a vector), contrarily to an int key dictionary. | |
| virtual bool | hasItem (int index) const |
| Tells if array item index actually exists. | |
| virtual Object | getArrayItem (int index) const |
Get the element of index index. | |
| virtual void | setArrayItem (int, Object) |
| virtual size_t | size () const |
| Number of sub-elements. | |
| virtual bool | isDynArray () const |
| Returns false if the stored object doesn't actually implement the DynArrayInterface API (needed since all GenericObject inherit this interface whatever they actually contain) | |
| virtual void | reserveArray (size_t) |
| like the STL vector::reserve(), memory is reserved but no element is stored | |
| virtual void | resizeArray (size_t) |
| resize the array. | |
| virtual void | removeArrayItem (int) |
| removes an element from the array. | |
| virtual void | insertArrayItem (int, Object) |
| inserts an element into the array. | |
| virtual bool | getProperty (const std::string &, Object &) const |
Access the element ok key key. | |
| virtual bool | isDictionary () const |
| Returns false if the stored object doesn't actually implement the DictionaryInterface API (needed since all GenericObject inherit this interface whatever they actually contain) | |
| virtual void | setProperty (const std::string &, Object) |
Set (insert or replace) the element of key key with the value object. | |
| virtual bool | removeProperty (const std::string &) |
| remove an element. | |
| virtual bool | hasProperty (const std::string &) const |
check if an element exists under the key key | |
| virtual void | clearProperties () |
| clear the dictionary | |
| virtual bool | isIterable () const |
| Returns false if the stored object doesn't actually implement the IterableInterface API (needed since all GenericObject inherit this interface whatever they actually contain) | |
| virtual Object | objectIterator () const |
| returns an object implementing the IteratorIntrerface | |
| virtual bool | isIterator () const |
| Returns false if the stored object doesn't actually implement the IteratorInterface API (needed since all GenericObject inherit this interface whatever they actually contain) | |
| virtual bool | isValid () const |
true if the iterator points to a valid value, false when the end of the iterable container has been reached | |
| virtual Object | currentValue () const |
| Access the value of the element pointed to by the iterator. | |
| virtual void | next () |
| Point to the next element of the iterable container. | |
| virtual bool | isKeyIterator () const |
| Returns false if the stored object doesn't actually implement the DictionaryIteratorInterface API (needed since all GenericObject inherit this interface whatever they actually contain) | |
| virtual Object | keyObject () const |
| Access the key of the current element. | |
| virtual bool | isDictionaryIterator () const |
| Returns false if the stored object doesn't actually implement the DictionaryIteratorInterface API (needed since all GenericObject inherit this interface whatever they actually contain) | |
| virtual std::string | key () const |
| Access the key of the current dictionary element. | |
| virtual bool | isIntKeyIterator () const |
| Returns false if the stored object doesn't actually implement the DictionaryIteratorInterface API (needed since all GenericObject inherit this interface whatever they actually contain) | |
| virtual long | intKey () const |
| Access the key of the current dictionary element. | |
| virtual bool | isNone () const |
| Returns false if the stored object doesn't actually implement the NoneInterface API (needed since all GenericObject inherit this interface whatever they actually contain) | |
| virtual bool | operator== (const GenericObject &other) const |
| Object | getProperty (const std::string &) const |
| same as the other getProperty() functions except that the value object is returned. | |
| Object | getProperty (Object key) const |
same as the other getProperty() functions except that the key is contained in the key argument (which must implement the StringInterface). | |
| template<typename T> | |
| bool | getProperty (const std::string &key, T &value) const |
same as the other getProperty() functions except that the value object must be of exact type T and is copied to the value argument. | |
| void | setProperty (const std::string &, const char *) |
| specific specialization: C strings are stored as std::string objects | |
| template<typename T> | |
| void | setProperty (const std::string &, const T &) |
same as the other setProperty() functions except that the value to be set is of the arbitrary type T and will possibly be stored in an Object. | |
| template<> | |
| void | setProperty (const std::string &key, Object const &value) |
| Public Member Functions inherited from carto::GenericObject | |
| virtual | ~GenericObject () |
| template<typename T> | |
| const T & | value () const |
| Retrieve value in object, const reference. | |
| template<typename T> | |
| T & | value () |
| Retrieve value in object, by non-const reference. | |
| template<typename T> | |
| bool | value (T &) const |
| Retrieve value in object, and store it in a variable. | |
| template<typename T> | |
| void | setValue (const T &val) |
| Store value in object by copying it. | |
| template<typename T> | |
| T * | getInterface () |
| Obtain a specific Interface subclass. | |
| template<typename T> | |
| const T * | getInterface () const |
| const access to an interface | |
| virtual bool | operator!= (const GenericObject &other) const |
| Public Member Functions inherited from carto::RCObject | |
| RCObject () | |
| RCObject (const RCObject &) | |
| RCObject & | operator= (const RCObject &) |
| virtual | ~RCObject () |
| Public Member Functions inherited from carto::StringInterface | |
| virtual | ~StringInterface () |
| virtual bool | operator== (const StringInterface &other) const |
| equality test | |
| virtual bool | operator!= (const StringInterface &other) const |
| Public Member Functions inherited from carto::Interface | |
| virtual | ~Interface () |
| Public Member Functions inherited from carto::ScalarInterface | |
| virtual | ~ScalarInterface () |
| virtual bool | operator== (const ScalarInterface &other) const |
| equality test | |
| virtual bool | operator!= (const ScalarInterface &other) const |
| Public Member Functions inherited from carto::DynArrayInterface | |
| virtual | ~DynArrayInterface () |
| Public Member Functions inherited from carto::ArrayInterface | |
| virtual | ~ArrayInterface () |
| Public Member Functions inherited from carto::SizeInterface | |
| virtual | ~SizeInterface () |
| Public Member Functions inherited from carto::IterableInterface | |
| virtual | ~IterableInterface () |
| virtual bool | operator== (const IterableInterface &other) const |
| equality test | |
| virtual bool | operator!= (const IterableInterface &other) const |
| Public Member Functions inherited from carto::DictionaryInterface | |
| virtual | ~DictionaryInterface () |
| Object | getProperty (const std::string &) const |
| same as the other getProperty() functions except that the value object is returned. | |
| Object | getProperty (Object key) const |
same as the other getProperty() functions except that the key is contained in the key argument (which must implement the StringInterface). | |
| template<typename T> | |
| bool | getProperty (const std::string &key, T &value) const |
same as the other getProperty() functions except that the value object must be of exact type T and is copied to the value argument. | |
| void | setProperty (const std::string &, const char *) |
| specific specialization: C strings are stored as std::string objects | |
| template<typename T> | |
| void | setProperty (const std::string &, const T &) |
same as the other setProperty() functions except that the value to be set is of the arbitrary type T and will possibly be stored in an Object. | |
| virtual void | copyProperties (Object source) |
copy all properties of the source object to this object. | |
| virtual bool | operator== (const DictionaryInterface &other) const |
| equality test | |
| virtual bool | operator!= (const DictionaryInterface &other) const |
| template<> | |
| void | setProperty (const std::string &key, Object const &value) |
| template<> | |
| bool | getProperty (const std::string &key, Object &value) const |
| Public Member Functions inherited from carto::IteratorInterface | |
| virtual | ~IteratorInterface () |
| Public Member Functions inherited from carto::KeyIteratorInterface | |
| virtual | ~KeyIteratorInterface () |
| Public Member Functions inherited from carto::DictionaryIteratorInterface | |
| virtual | ~DictionaryIteratorInterface () |
| Public Member Functions inherited from carto::IntKeyIteratorInterface | |
| virtual | ~IntKeyIteratorInterface () |
| Public Member Functions inherited from carto::NoneInterface | |
| virtual | ~NoneInterface () |
Additional Inherited Members | |
| Public Types inherited from carto::RCObject | |
| typedef int | RefCounterType |
Detailed Description
template<typename T>
class carto::ReferenceObject< T >
class carto::ReferenceObject< T >
storage wrapper, derived and instanciable template class
ReferenceObject is a GenericObject that references an external value object. The external object stays at its original location and doesn't belong to the ReferenceObject. So it must not be deleted while any ReferenceObject still uses it.
Constructor & Destructor Documentation
◆ ReferenceObject()
template<typename T>
| carto::ReferenceObject< T >::ReferenceObject | ( | T & | x | ) |
Definition at line 770 of file object_d.h.
◆ ~ReferenceObject()
template<typename T>
|
virtual |
Definition at line 777 of file object_d.h.
Member Function Documentation
◆ clone()
template<typename T>
|
virtual |
◆ getValue()
template<typename T>
|
virtual |
Reimplemented from carto::TypedObject< T >.
Definition at line 784 of file object_d.h.
The documentation for this class was generated from the following files:
- cartobase/object/object.h
- cartobase/object/object_d.h
