A copy of a string array element of a PropertyTableProperty. More...

#include <CesiumGltf/PropertyArrayView.h>

Public Member Functions
	PropertyArrayCopy ()
	Constructs an empty array copy.

	PropertyArrayCopy (const std::vector< std::string > &values) noexcept
	Constructs a string array copy from a vector.

	PropertyArrayCopy (PropertyArrayCopy &&)=default
	Default move constructor.

PropertyArrayCopy &	operator= (PropertyArrayCopy &&)=default
	Default move assignment operator.

	PropertyArrayCopy (const PropertyArrayCopy &rhs)
	Copy constructor.

PropertyArrayCopy &	operator= (const PropertyArrayCopy &rhs)
	Copy assignment operator.

std::string_view	operator[] (int64_t index) const noexcept
	Returns the `ElementType` at the given index from this copy.

int64_t	size () const noexcept
	The number of elements in this array.

const PropertyArrayView< std::string_view > &	view () const
	Obtains a PropertyArrayView over the contents of this copy.

PropertyArrayView< std::string_view >	toViewAndExternalBuffer (std::vector< std::byte > &outBuffer) &&
	Obtains a buffer and view from the copied data, leaving this PropertyArrayCopy empty.

	PropertyArrayCopy ()
	Constructs an empty array copy.

	PropertyArrayCopy (const std::vector< std::string_view > &values) noexcept
	Constructs an array copy from a vector.

	PropertyArrayCopy (PropertyArrayCopy &&)=default
	Default move constructor.

	PropertyArrayCopy (std::vector< std::byte > &&buffer) noexcept
	Creates a new PropertyArrayCopy directly from a buffer of bytes, which will be moved into this copy.

	PropertyArrayCopy (const PropertyArrayCopy &rhs)
	Copy constructor.

PropertyArrayCopy &	operator= (PropertyArrayCopy &&)=default
	Default move assignment operator.

PropertyArrayCopy &	operator= (const PropertyArrayCopy &rhs)
	Copy assignment operator.

const std::string_view &	operator[] (int64_t index) const noexcept
	Returns the `ElementType` at the given index from this copy.

int64_t	size () const noexcept
	The number of elements in this array.

auto	begin ()
	The `begin` iterator.

auto	begin () const
	The `begin` iterator.

auto	end ()
	The `end` iterator.

auto	end () const
	The `end` iterator.

const PropertyArrayView< std::string_view > &	view () const
	Obtains a PropertyArrayView over the contents of this copy.

PropertyArrayView< std::string_view >	toViewAndExternalBuffer (std::vector< std::byte > &outBuffer) &&
	Obtains a buffer and view from the copied data, leaving this PropertyArrayCopy empty.

Detailed Description

A copy of a string array element of a PropertyTableProperty.

Whereas PropertyArrayView is a pointer to data stored in a separate place, a PropertyArrayCopy owns the data that it's viewing.

Provides utility to retrieve the data stored in the array of elements via the array index operator.

Definition at line 395 of file PropertyArrayView.h.

Constructor & Destructor Documentation

◆ PropertyArrayCopy() [1/7]

CesiumGltf::PropertyArrayCopy< std::string_view >::PropertyArrayCopy ( )

inline

Constructs an empty array copy.

Definition at line 400 of file PropertyArrayView.h.

◆ PropertyArrayCopy() [2/7]

CesiumGltf::PropertyArrayCopy< std::string_view >::PropertyArrayCopy ( const std::vector< std::string > & values )

inlinenoexcept

Constructs a string array copy from a vector.

Parameters

values The vector containing the values.

Definition at line 407 of file PropertyArrayView.h.

◆ PropertyArrayCopy() [3/7]

CesiumGltf::PropertyArrayCopy< std::string_view >::PropertyArrayCopy ( const PropertyArrayCopy< std::string_view > & rhs )

inline

Copy constructor.

Definition at line 475 of file PropertyArrayView.h.

◆ PropertyArrayCopy() [4/7]

CesiumGltf::PropertyArrayCopy< std::string_view >::PropertyArrayCopy ( )

inline

Constructs an empty array copy.

Definition at line 82 of file PropertyArrayView.h.

◆ PropertyArrayCopy() [5/7]

CesiumGltf::PropertyArrayCopy< std::string_view >::PropertyArrayCopy ( const std::vector< std::string_view > & values )

inlinenoexcept

Constructs an array copy from a vector.

Parameters

values The vector containing the values.

Definition at line 89 of file PropertyArrayView.h.

◆ PropertyArrayCopy() [6/7]

CesiumGltf::PropertyArrayCopy< std::string_view >::PropertyArrayCopy ( std::vector< std::byte > && buffer )

inlinenoexcept

Creates a new PropertyArrayCopy directly from a buffer of bytes, which will be moved into this copy.

Definition at line 109 of file PropertyArrayView.h.

◆ PropertyArrayCopy() [7/7]

CesiumGltf::PropertyArrayCopy< std::string_view >::PropertyArrayCopy ( const PropertyArrayCopy< std::string_view > & rhs )

inline

Copy constructor.

Definition at line 113 of file PropertyArrayView.h.

Member Function Documentation

◆ begin() [1/2]

auto CesiumGltf::PropertyArrayCopy< std::string_view >::begin ( )

inline

The begin iterator.

Definition at line 137 of file PropertyArrayView.h.

◆ begin() [2/2]

auto CesiumGltf::PropertyArrayCopy< std::string_view >::begin ( ) const

inline

The begin iterator.

Definition at line 141 of file PropertyArrayView.h.

◆ end() [1/2]

auto CesiumGltf::PropertyArrayCopy< std::string_view >::end ( )

inline

The end iterator.

Definition at line 139 of file PropertyArrayView.h.

◆ end() [2/2]

auto CesiumGltf::PropertyArrayCopy< std::string_view >::end ( ) const

inline

The end iterator.

Definition at line 143 of file PropertyArrayView.h.

◆ operator=() [1/2]

PropertyArrayCopy & CesiumGltf::PropertyArrayCopy< std::string_view >::operator= ( const PropertyArrayCopy< std::string_view > & rhs )

inline

Copy assignment operator.

Definition at line 117 of file PropertyArrayView.h.

◆ operator=() [2/2]

PropertyArrayCopy & CesiumGltf::PropertyArrayCopy< std::string_view >::operator= ( const PropertyArrayCopy< std::string_view > & rhs )

inline

Copy assignment operator.

Definition at line 490 of file PropertyArrayView.h.

◆ operator[]() [1/2]

const std::string_view & CesiumGltf::PropertyArrayCopy< std::string_view >::operator[] ( int64_t index ) const

inlinenoexcept

Returns the ElementType at the given index from this copy.

Parameters

index The index to obtain.

Returns: The ElementType at that index from the internal view.

Definition at line 129 of file PropertyArrayView.h.

◆ operator[]() [2/2]

std::string_view CesiumGltf::PropertyArrayCopy< std::string_view >::operator[] ( int64_t index ) const

inlinenoexcept

Returns the ElementType at the given index from this copy.

Parameters

index The index to obtain.

Returns: The ElementType at that index from the internal view.

Definition at line 511 of file PropertyArrayView.h.

◆ size() [1/2]

int64_t CesiumGltf::PropertyArrayCopy< std::string_view >::size ( ) const

inlinenoexcept

The number of elements in this array.

Definition at line 134 of file PropertyArrayView.h.

◆ size() [2/2]

int64_t CesiumGltf::PropertyArrayCopy< std::string_view >::size ( ) const

inlinenoexcept

The number of elements in this array.

Definition at line 516 of file PropertyArrayView.h.

◆ toViewAndExternalBuffer() [1/2]

PropertyArrayView< std::string_view > CesiumGltf::PropertyArrayCopy< std::string_view >::toViewAndExternalBuffer ( std::vector< std::byte > & outBuffer ) &&

inline

Obtains a buffer and view from the copied data, leaving this PropertyArrayCopy empty.

Parameters

outBuffer The destination where this copy's internal buffer will be moved to.

Definition at line 158 of file PropertyArrayView.h.

◆ toViewAndExternalBuffer() [2/2]

PropertyArrayView< std::string_view > CesiumGltf::PropertyArrayCopy< std::string_view >::toViewAndExternalBuffer ( std::vector< std::byte > & outBuffer ) &&

inline

Obtains a buffer and view from the copied data, leaving this PropertyArrayCopy empty.

Parameters

outBuffer The destination where this copy's internal buffer will be moved to.

Definition at line 533 of file PropertyArrayView.h.

◆ view() [1/2]

const PropertyArrayView< std::string_view > & CesiumGltf::PropertyArrayCopy< std::string_view >::view ( ) const

inline

Obtains a PropertyArrayView over the contents of this copy.

Definition at line 148 of file PropertyArrayView.h.

◆ view() [2/2]

const PropertyArrayView< std::string_view > & CesiumGltf::PropertyArrayCopy< std::string_view >::view ( ) const

inline

Obtains a PropertyArrayView over the contents of this copy.

Definition at line 521 of file PropertyArrayView.h.

The documentation for this class was generated from the following file:

/home/runner/work/cesium-native/cesium-native/CesiumGltf/include/CesiumGltf/PropertyArrayView.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ PropertyArrayCopy() [1/7]

◆ PropertyArrayCopy() [2/7]

◆ PropertyArrayCopy() [3/7]

◆ PropertyArrayCopy() [4/7]

◆ PropertyArrayCopy() [5/7]

◆ PropertyArrayCopy() [6/7]

◆ PropertyArrayCopy() [7/7]

Member Function Documentation

◆ begin() [1/2]

◆ begin() [2/2]

◆ end() [1/2]

◆ end() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ size() [1/2]

◆ size() [2/2]

◆ toViewAndExternalBuffer() [1/2]

◆ toViewAndExternalBuffer() [2/2]

◆ view() [1/2]

◆ view() [2/2]