A user property array handle is a UTF8 string array property handle that provides operations to serialze the strings to and from values of type T. More...

#include <user_property_array_handle.h>

Inheritance diagram for cppgraph::user_property_array_handle_t< T >:

[legend]

Public Member Functions
	user_property_array_handle_t ()=default
	Default construction.

	user_property_array_handle_t (user_property_array_handle_t const &h_property) noexcept
	Copy construction from a user property array handle. More...

template<typename U , typename = enable_if_is_same< U, T >>
	user_property_array_handle_t (user_property_array_handle_t< U > const &h_property) noexcept
	Copy construction from a user property array handle. More...

	user_property_array_handle_t (user_property_array_handle_t &&h_property) noexcept
	Move construction from a compatible user property array handle. More...

template<typename U , typename = enable_if_is_same< U, T >>
	user_property_array_handle_t (user_property_array_handle_t< U > &&h_property) noexcept
	Move construction from a compatible user property array handle. More...

T	get_user_value (index_t index) const
	Serializes a `T` value from the backing string at a specified index, and returns it. More...

user_property_array_handle_t &	operator= (user_property_array_handle_t const &h_properties) noexcept
	Copy assignment from a user property array handle of type c T. More...

template<typename U , typename = enable_if_is_same< U, T >>
user_property_array_handle_t &	operator= (user_property_array_handle_t< U > const &h_properties) noexcept
	Copy assignment from a compatible user property array handle. More...

user_property_array_handle_t &	operator= (user_property_array_handle_t &&h_properties) noexcept
	Move assignment from a user property array handle of type c T. More...

template<typename U , typename = enable_if_is_same< U, T >>
user_property_array_handle_t &	operator= (user_property_array_handle_t< U > &&h_properties) noexcept
	Move assignment from a compatible user property array handle. More...

void	set_user_value (index_t index, T const &t)
	Serializes a specified `T` value to the backing string. More...

Public Member Functions inherited from cppgraph::property_handle_t< utf8_string_array >
constexpr	property_handle_t () noexcept=default
	Default construction. More...

constexpr	property_handle_t (std::nullptr_t property) noexcept
	Construction from a `nullptr`. More...

	property_handle_t (property *property)
	Construction from a property pointer. More...

	property_handle_t (property_id_t id)
	Construction from a `property_id`. More...

	property_handle_t (property_handle_t const &h_property) noexcept
	Copy construction from a property handle. More...

	property_handle_t (property_handle_t< U > const &h_property) noexcept
	Copy construction from a property handle. More...

	property_handle_t (property_handle_t &&h_property) noexcept
	Move construction from a property handle. More...

	property_handle_t (property_handle_t< U > &&h_property) noexcept
	Move construction from a property handle. More...

	property_handle_t (utf8_string_array const &value) noexcept
	Create a property of the specified type and value and construct a property handle to it. More...

utf8_string_array *	data (error_action_enum error_action_type) const
	De-references this property handle. More...

utf8_string_array &	operator* () const
	Dereferences this property handle. More...

utf8_string_array *	operator-> () const
	De-references this property handle. More...

property_handle_t &	operator= (std::nullptr_t property) noexcept
	Assignment from a `nullptr`. More...

property_handle_t &	operator= (property_id_t id)
	Assignment from a `property_id`. More...

property_handle_t &	operator= (property_handle_t const &h_property) noexcept
	Copy assignment from a property handle. More...

property_handle_t &	operator= (property_handle_t< U > const &h_property) noexcept
	Copy assignment from a property handle. More...

property_handle_t &	operator= (property_handle_t &&h_property) noexcept
	Move assignment from a property handle. More...

property_handle_t &	operator= (property_handle_t< U > &&h_property) noexcept
	Move assignment from a property handle. More...

property_handle_t &	operator= (utf8_string_array const &value) noexcept
	Create a property of the specified type and value and assign it to this property handle. More...

Public Member Functions inherited from cppgraph::property_handle
	property_handle () noexcept=default
	Default construction. More...

	property_handle (std::nullptr_t property) noexcept
	Construction from a `nullptr`. More...

	property_handle (property *property) noexcept
	Construction from a property pointer. More...

	property_handle (property_id_t property_id) noexcept
	Construction from a `property_id`. More...

	property_handle (property_handle const &h_property) noexcept
	Copy construction from a property handle. More...

	property_handle (property_handle &&h_property) noexcept
	Move construction from a property handle. More...

template<typename T , typename = enable_if_is_property< T >>
	property_handle (T const &value) noexcept
	Construction from a property value. More...

	~property_handle ()
	Destruction.

template<typename T >
T *	data (error_action_enum error_action_type) const
	Returns a pointer to this handle's property's value. More...

property *	get_property (error_action_enum error_action_type) const
	De-references this property handle. More...

property_id_t	get_property_id () const noexcept
	Returns the id of the property owned by this property handle. More...

	operator bool () const noexcept
	Returns `true` if this property handle's property pointer is not `nullptr`. More...

property &	operator* () const
	De-references this property handle. More...

property *	operator-> () const
	De-references this property handle. More...

property_handle &	operator= (std::nullptr_t property) noexcept
	Assignment from a `nullptr`. More...

property_handle &	operator= (property_handle const &h_property) noexcept
	Copy assignment from a property handle. More...

property_handle &	operator= (property_handle &&h_property) noexcept
	Move assignment from a property handle. More...

property_handle &	operator= (property *property) noexcept
	Assignment from a property pointer. More...

property_handle &	operator= (property_id_t id) noexcept
	Assignment from a `property_id`. More...

template<typename T , typename = enable_if_is_property< T >>
property_handle &	operator= (T const &value)
	Assignment from a property value. More...

Detailed Description

template<typename T>
struct cppgraph::user_property_array_handle_t< T >

A user property array handle is a UTF8 string array property handle that provides operations to serialze the strings to and from values of type T.

Template Parameters

T	Type of the user property. The following must be declared and defined in T's namespace: std::ostream & operator << ( std::ostream &, T const & ); std::istream & operator >> ( std::istream &, T & );

See also: CPPGRAPH_DECLARE_USER_PROPERTY_ARRAY(), CPPGRAPH_DECLARE_CONST_USER_PROPERTY_ARRAY(), CPPGRAPH_DECLARE_USER_PROPERTY(), CPPGRAPH_DECLARE_CONST_USER_PROPERTY().

Todo:: Need a property_array_handle_t?

Constructor & Destructor Documentation

◆ user_property_array_handle_t() [1/4]

template<typename T >

cppgraph::user_property_array_handle_t< T >::user_property_array_handle_t ( user_property_array_handle_t< T > const & h_property )

noexcept

Copy construction from a user property array handle.

Parameters

h_property A property handle to a user property array whose data type is T.

◆ user_property_array_handle_t() [2/4]

template<typename T >

template<typename U , typename >

cppgraph::user_property_array_handle_t< T >::user_property_array_handle_t ( user_property_array_handle_t< U > const & h_property )

noexcept

Copy construction from a user property array handle.

Template Parameters

U	`T` or `T` const. It is deduced by the compiler and therefore need not be specified.

Parameters

h_property A property handle to a user property array whose data type is U.

◆ user_property_array_handle_t() [3/4]

template<typename T >

cppgraph::user_property_array_handle_t< T >::user_property_array_handle_t ( user_property_array_handle_t< T > && h_property )

noexcept

Move construction from a compatible user property array handle.

Parameters

h_property A property handle to a property whose data type is T.

◆ user_property_array_handle_t() [4/4]

template<typename T >

template<typename U , typename >

cppgraph::user_property_array_handle_t< T >::user_property_array_handle_t ( user_property_array_handle_t< U > && h_property )

noexcept

Move construction from a compatible user property array handle.

Template Parameters

U	`T` or `T` const. It is deduced by the compiler and therefore need not be specified.

Parameters

h_property A property handle to a property whose data type is U.

Member Function Documentation

◆ get_user_value()

template<typename T >

T cppgraph::user_property_array_handle_t< T >::get_user_value ( index_t index ) const

Serializes a T value from the backing string at a specified index, and returns it.

Parameters

index Array index of the desired property.

Returns: The value of the backing string property at index, serialized in to a value of type T.

Exceptions

exception index() is not in the range [0, size() - 1].

◆ operator=() [1/4]

template<typename T >

user_property_array_handle_t& cppgraph::user_property_array_handle_t< T >::operator= ( user_property_array_handle_t< T > const & h_properties )

noexcept

Copy assignment from a user property array handle of type c T.

Parameters

h_properties A handle to a user property array whose data type is T.

Returns: A reference to this instance.

◆ operator=() [2/4]

template<typename T >

template<typename U , typename = enable_if_is_same< U, T >>

user_property_array_handle_t& cppgraph::user_property_array_handle_t< T >::operator= ( user_property_array_handle_t< U > const & h_properties )

noexcept

Copy assignment from a compatible user property array handle.

Template Parameters

U	`T` or `T` const. It is deduced by the compiler and therefore need not be specified.

Parameters

h_properties A handle to a user property array whose data type is U.

Returns: A reference to this instance.

◆ operator=() [3/4]

template<typename T >

user_property_array_handle_t& cppgraph::user_property_array_handle_t< T >::operator= ( user_property_array_handle_t< T > && h_properties )

noexcept

Move assignment from a user property array handle of type c T.

Parameters

h_properties A handle to a user property array whose data type is T.

Returns: A reference to this instance.

◆ operator=() [4/4]

template<typename T >

template<typename U , typename = enable_if_is_same< U, T >>

user_property_array_handle_t& cppgraph::user_property_array_handle_t< T >::operator= ( user_property_array_handle_t< U > && h_properties )

noexcept

Move assignment from a compatible user property array handle.

Template Parameters

U	`T` or `T` const. It is deduced by the compiler and therefore need not be specified.

Parameters

h_properties A handle to a user property array whose data type is U.

Returns: A reference to this instance.

◆ set_user_value()

template<typename T >

void cppgraph::user_property_array_handle_t< T >::set_user_value	(	index_t	index,
		T const &	t
	)

Serializes a specified T value to the backing string.

Parameters

index	Array index of the desired property.
t	A value of type `T`.

Exceptions

exception index() is not in the range [0, size() - 1].

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

c:/cppgraph/lib/cppgraph/graph/properties/user_property_array_handle.h

Public Member Functions

Detailed Description

template<typename T> struct cppgraph::user_property_array_handle_t< T >

Constructor & Destructor Documentation

◆ user_property_array_handle_t() [1/4]

◆ user_property_array_handle_t() [2/4]

◆ user_property_array_handle_t() [3/4]

◆ user_property_array_handle_t() [4/4]

Member Function Documentation

◆ get_user_value()

◆ operator=() [1/4]

◆ operator=() [2/4]

◆ operator=() [3/4]

◆ operator=() [4/4]

◆ set_user_value()

template<typename T>
struct cppgraph::user_property_array_handle_t< T >