string#

Fully qualified name: omni::graph::core::ogn::string

class string : public omni::graph::core::ogn::base_string<char, AttributeDataHandle>#

std::string_view-like class for string output attribute data in the Ogn Database.

It operates by using the Fabric interface to interact with string data it has stored. This non-const version of the string wrapper should be used for output attributes, whose data will be changed.

Public Types

using parent_t = base_string<char, AttributeDataHandle>#: Type of the parent class.

using ConstBaseDataType = const typename std::remove_const<BaseDataType>::type#: const version of the BaseDataType

using this_t = base_array<BaseDataType, HandleType>#: Type definition of this class.

using iterator = typename gsl::span<BaseDataType>::iterator#: Iterator over the array contents.

using reverse_iterator = typename gsl::span<BaseDataType>::reverse_iterator#: Reverse iterator over the array contents.

Public Functions

string() = default#: Default constructor to start pointing to nothing.

inline void resize(size_t newCount)#

Set the size of the array data to a new value.

This may or may not relocate memory. If anything is holding a raw pointer from contents() that pointer should be refreshed by calling contents() again when this method returns.

Parameters:: newCount – [in] New element count of the array.

inline char *data()#

Returns:: Non-const pointer to the raw string data

inline char &operator[](size_t index)#

Access a specific character in the string.

No bounds checking is performed.

Parameters:: index – [in] Element index into the string
Returns:: Reference to the index’th character of the string

inline char &at(size_t index)#

Access a specific character in the string.

Bounds checking is performed.

Parameters:: index – [in] Element index into the string
Returns:: Reference to the index’th character of the string

inline string &assign(char const *dataToCopy, size_t charCount)#

Assignment of a raw sized string to this object, used by all variations.

This will create a duplicate of all string members and reset the references into the Fabric, leaving the context and the handle unchanged.

Parameters:

dataToCopy – [in] The string being copied in
charCount – [in] The number of characters in the string being copied

Returns:

Pointer to this

template<typename StringType> inline string &operator=( StringType &rhs, )#

Generic string assignment operator.

This template handles all compatible string types with a data() and size() method. At minimum ogn::string, ogn::const_string, std::string, const std::string

Parameters:: rhs – [in] The string being copied in
Returns:: Pointer to this

inline string &operator=(const char *rhs)#

const char* assignment operator (avoids alloc, and disambiguates between std::string and ogn::const_string)

This will create a duplicate of all string members and reset the references into the Fabric, leaving the context and the handle unchanged.

Parameters:: rhs – [in] The string being copied in
Returns:: Pointer to this

inline void clear()#

Standard method to clear a string, i.e.

assign the empty string to it. Since the null terminator is not needed in fabric the string truly is empty

inline size_t length() const#

Returns:: The number of elements in the currently managed array

inline operator std::string() const#

Cast the string data to a std::string.

After you do this the string data is now a copy of the original so you can manipulate it without affecting the original, however it means you must reassign it back to a writable ogn::string if you do want to change the string.

Returns:: String containing a copy of the internal raw string data

inline bool operator==(const IterableStringType &rhs) const#

See if two strings are equal.