omni::str::ReadOnlyCString
Defined in omni/str/IReadOnlyCString.h
-
class ReadOnlyCString : public omni::core::Implements<omni::str::IReadOnlyCString>
Concrete implementation of the IReadOnlyCString interface.
Public Functions
-
inline void acquire() noexcept
See omni::core::IObject::acquire.
-
inline void release() noexcept
See omni::core::IObject::release.
Public Static Functions
-
static inline omni::core::ObjectPtr<IReadOnlyCString> create(const char *str)
Creates a read-only string. The given string is copied and must not be nullptr.
Protected Functions
-
inline virtual void acquire_abi() noexcept override
Increments the object’s reference count.
Objects may have multiple reference counts (e.g. one per interface implemented). As such, it is important that you call omni::core::IObject::release() on the same pointer from which you called omni::core::IObject::acquire().
Do not directly use this method, rather use omni::core::ObjectPtr, which will manage calling omni::core::IObject::acquire() and omni::core::IObject::release() for you.
- Thread Safety
This method is thread safe.
-
inline virtual void release_abi() noexcept override
Decrements the objects reference count.
Most implementations will destroy the object if the reference count reaches 0 (though this is not a requirement).
Objects may have multiple reference counts (e.g. one per interface implemented). As such, it is important that you call omni::core::IObject::release() on the same pointer from which you called omni::core::IObject::acquire().
Do not directly use this method, rather use omni::core::ObjectPtr, which will manage calling omni::core::IObject::acquire() and omni::core::IObject::release() for you.
- Thread Safety
This method is thread safe.
-
inline virtual void *cast_abi(TypeId id) noexcept override
Returns a pointer to the interface defined by the given type id if this object implements the type id’s interface.
Objects can support multiple interfaces, even interfaces that are in different inheritance chains.
The returned object will have omni::core::IObject::acquire() called on it before it is returned, meaning it is up to the caller to call omni::core::IObject::release() on the returned pointer.
The returned pointer can be safely
reinterpret_cast<>to the type id’s C++ class. For example, “omni.windowing.IWindow” can be cast toomni::windowing::IWindow.Do not directly use this method, rather use a wrapper function like omni::core::cast() or omni::core::ObjectPtr::as().
- Thread Safety
This method is thread safe.
-
inline void acquire() noexcept