MRConstChildren.h File Reference

#include <MRCMisc/exports.h>
#include <stdbool.h>
#include <stddef.h>

Go to the source code of this file.

Typedefs
typedef struct MR_std_shared_ptr_const_MR_Object	MR_std_shared_ptr_const_MR_Object
typedef struct MR_std_vector_std_shared_ptr_MR_Object	MR_std_vector_std_shared_ptr_MR_Object
typedef struct MR_std_vector_std_shared_ptr_MR_Object_const_iterator	MR_std_vector_std_shared_ptr_MR_Object_const_iterator
typedef struct MR_ConstChildren_Iterator	MR_ConstChildren_Iterator

Functions
MRC_API MR_ConstChildren *	MR_ConstChildren_ConstructFromAnother (const MR_ConstChildren *_other)
MRC_API const MR_ConstChildren *	MR_ConstChildren_OffsetPtr (const MR_ConstChildren *ptr, ptrdiff_t i)
MRC_API MR_ConstChildren *	MR_ConstChildren_OffsetMutablePtr (MR_ConstChildren *ptr, ptrdiff_t i)
MRC_API MR_ConstChildren *	MR_ConstChildren_Construct (const MR_std_vector_std_shared_ptr_MR_Object *children)
MRC_API void	MR_ConstChildren_Destroy (const MR_ConstChildren *_this)
	Destroys a heap-allocated instance of MR_ConstChildren. Does nothing if the pointer is null.
MRC_API void	MR_ConstChildren_DestroyArray (const MR_ConstChildren *_this)
	Destroys a heap-allocated array of MR_ConstChildren. Does nothing if the pointer is null.
MRC_API MR_ConstChildren_Iterator *	MR_ConstChildren_begin (const MR_ConstChildren *_this)
MRC_API MR_ConstChildren_Iterator *	MR_ConstChildren_end (const MR_ConstChildren *_this)
MRC_API bool	MR_ConstChildren_empty (const MR_ConstChildren *_this)
MRC_API size_t	MR_ConstChildren_size (const MR_ConstChildren *_this)
MRC_API MR_std_shared_ptr_const_MR_Object *	MR_ConstChildren_index (const MR_ConstChildren *_this, size_t i)
MRC_API MR_ConstChildren_Iterator *	MR_ConstChildren_Iterator_DefaultConstruct (void)
MRC_API MR_ConstChildren_Iterator *	MR_ConstChildren_Iterator_DefaultConstructArray (size_t num_elems)
MRC_API const MR_ConstChildren_Iterator *	MR_ConstChildren_Iterator_OffsetPtr (const MR_ConstChildren_Iterator *ptr, ptrdiff_t i)
MRC_API MR_ConstChildren_Iterator *	MR_ConstChildren_Iterator_OffsetMutablePtr (MR_ConstChildren_Iterator *ptr, ptrdiff_t i)
MRC_API MR_ConstChildren_Iterator *	MR_ConstChildren_Iterator_ConstructFromAnother (const MR_ConstChildren_Iterator *_other)
MRC_API MR_ConstChildren_Iterator *	MR_ConstChildren_Iterator_Construct (const MR_std_vector_std_shared_ptr_MR_Object_const_iterator *it)
MRC_API void	MR_ConstChildren_Iterator_Destroy (const MR_ConstChildren_Iterator *_this)
	Destroys a heap-allocated instance of MR_ConstChildren_Iterator. Does nothing if the pointer is null.
MRC_API void	MR_ConstChildren_Iterator_DestroyArray (const MR_ConstChildren_Iterator *_this)
	Destroys a heap-allocated array of MR_ConstChildren_Iterator. Does nothing if the pointer is null.
MRC_API MR_ConstChildren_Iterator *	MR_ConstChildren_Iterator_AssignFromAnother (MR_ConstChildren_Iterator *_this, const MR_ConstChildren_Iterator *_other)
MRC_API MR_std_shared_ptr_const_MR_Object *	MR_deref_MR_ConstChildren_Iterator (const MR_ConstChildren_Iterator *_this)
MRC_API MR_ConstChildren_Iterator *	MR_incr_MR_ConstChildren_Iterator (MR_ConstChildren_Iterator *_this)
MRC_API MR_ConstChildren_Iterator *	MR_post_incr_MR_ConstChildren_Iterator (MR_ConstChildren_Iterator *_this)
MRC_API bool	MR_equal_MR_ConstChildren_Iterator (const MR_ConstChildren_Iterator *_this, const MR_ConstChildren_Iterator *_1)

Typedef Documentation

MR_ConstChildren_Iterator

typedef struct MR_ConstChildren_Iterator MR_ConstChildren_Iterator

dereferences to std::shared_ptr<const Object>, constructed on each dereference Generated from class MR::ConstChildren::Iterator. Supported MR_PassBy modes: MR_PassBy_DefaultConstruct, MR_PassBy_Copy, MR_PassBy_Move (and MR_PassBy_DefaultArgument and MR_PassBy_NoObject if supported by the callee).

MR_std_shared_ptr_const_MR_Object

typedef struct MR_std_shared_ptr_const_MR_Object MR_std_shared_ptr_const_MR_Object

Wraps a pointer to a single shared reference-counted heap-allocated const MR::Object. Supported MR_PassBy modes: MR_PassBy_DefaultConstruct, MR_PassBy_Copy, MR_PassBy_Move (and MR_PassBy_DefaultArgument and MR_PassBy_NoObject if supported by the callee).

MR_std_vector_std_shared_ptr_MR_Object

typedef struct MR_std_vector_std_shared_ptr_MR_Object MR_std_vector_std_shared_ptr_MR_Object

Generated from C++ container std::vector<std::shared_ptr<MR::Object>>. Supported MR_PassBy modes: MR_PassBy_DefaultConstruct, MR_PassBy_Copy, MR_PassBy_Move (and MR_PassBy_DefaultArgument and MR_PassBy_NoObject if supported by the callee).

MR_std_vector_std_shared_ptr_MR_Object_const_iterator

typedef struct MR_std_vector_std_shared_ptr_MR_Object_const_iterator MR_std_vector_std_shared_ptr_MR_Object_const_iterator

Read-only iterator for MR_std_vector_std_shared_ptr_MR_Object. Supported MR_PassBy modes: MR_PassBy_DefaultConstruct, MR_PassBy_Copy, MR_PassBy_Move (and MR_PassBy_DefaultArgument and MR_PassBy_NoObject if supported by the callee).

Function Documentation

MR_ConstChildren_begin()

MRC_API MR_ConstChildren_Iterator * MR_ConstChildren_begin

(

const MR_ConstChildren *

_this

)

Generated from method MR::ConstChildren::begin. Parameter _this can not be null. It is a single object. Never returns null. Returns an instance allocated on the heap! Must call MR_ConstChildren_Iterator_Destroy() to free it when you're done using it. The reference to this object might be preserved in the return value.

MR_ConstChildren_Construct()

MRC_API MR_ConstChildren * MR_ConstChildren_Construct

(

const MR_std_vector_std_shared_ptr_MR_Object *

children

)

Generated from constructor MR::ConstChildren::ConstChildren. Parameter children can not be null. It is a single object. The reference to the parameter children might be preserved in the constructed object. Never returns null. Returns an instance allocated on the heap! Must call MR_ConstChildren_Destroy() to free it when you're done using it.

MR_ConstChildren_ConstructFromAnother()

MRC_API MR_ConstChildren * MR_ConstChildren_ConstructFromAnother

(

const MR_ConstChildren *

_other

)

Generated from constructor MR::ConstChildren::ConstChildren. Parameter _other can not be null. It is a single object. The reference to things referred to by the parameter _other (if any) might be preserved in the constructed object. Never returns null. Returns an instance allocated on the heap! Must call MR_ConstChildren_Destroy() to free it when you're done using it.

MR_ConstChildren_Destroy()

MRC_API void MR_ConstChildren_Destroy

(

const MR_ConstChildren *

_this

)

Destroys a heap-allocated instance of MR_ConstChildren. Does nothing if the pointer is null.

MR_ConstChildren_DestroyArray()

MRC_API void MR_ConstChildren_DestroyArray

(

const MR_ConstChildren *

_this

)

Destroys a heap-allocated array of MR_ConstChildren. Does nothing if the pointer is null.

MR_ConstChildren_empty()

MRC_API bool MR_ConstChildren_empty

(

const MR_ConstChildren *

_this

)

Generated from method MR::ConstChildren::empty. Parameter _this can not be null. It is a single object.

MR_ConstChildren_end()

MRC_API MR_ConstChildren_Iterator * MR_ConstChildren_end

(

const MR_ConstChildren *

_this

)

Generated from method MR::ConstChildren::end. Parameter _this can not be null. It is a single object. Never returns null. Returns an instance allocated on the heap! Must call MR_ConstChildren_Iterator_Destroy() to free it when you're done using it. The reference to this object might be preserved in the return value.

MR_ConstChildren_index()

MRC_API MR_std_shared_ptr_const_MR_Object * MR_ConstChildren_index	(	const MR_ConstChildren *	_this,
		size_t	i )

Generated from method MR::ConstChildren::operator[]. Parameter _this can not be null. It is a single object. Never returns null. Returns an instance allocated on the heap! Must call MR_std_shared_ptr_const_MR_Object_Destroy() to free it when you're done using it.

MR_ConstChildren_Iterator_AssignFromAnother()

MRC_API MR_ConstChildren_Iterator * MR_ConstChildren_Iterator_AssignFromAnother	(	MR_ConstChildren_Iterator *	_this,
		const MR_ConstChildren_Iterator *	_other )

Generated from method MR::ConstChildren::Iterator::operator=. Parameter _this can not be null. It is a single object. Parameter _other can not be null. It is a single object. The reference to things referred to by the parameter _other (if any) might be preserved in this object. The returned pointer will never be null. It is non-owning, do NOT destroy it. When this function is called, this object will drop any object references it held previously.

MR_ConstChildren_Iterator_Construct()

MRC_API MR_ConstChildren_Iterator * MR_ConstChildren_Iterator_Construct

(

const MR_std_vector_std_shared_ptr_MR_Object_const_iterator *

it

)

Generated from constructor MR::ConstChildren::Iterator::Iterator. Parameter it can not be null. It is a single object. The reference to the parameter it might be preserved in the constructed object. Never returns null. Returns an instance allocated on the heap! Must call MR_ConstChildren_Iterator_Destroy() to free it when you're done using it.

MR_ConstChildren_Iterator_ConstructFromAnother()

MRC_API MR_ConstChildren_Iterator * MR_ConstChildren_Iterator_ConstructFromAnother

(

const MR_ConstChildren_Iterator *

_other

)

Generated from constructor MR::ConstChildren::Iterator::Iterator. Parameter _other can not be null. It is a single object. The reference to things referred to by the parameter _other (if any) might be preserved in the constructed object. Never returns null. Returns an instance allocated on the heap! Must call MR_ConstChildren_Iterator_Destroy() to free it when you're done using it.

MR_ConstChildren_Iterator_DefaultConstruct()

MRC_API MR_ConstChildren_Iterator * MR_ConstChildren_Iterator_DefaultConstruct

(

void

)

Constructs an empty (default-constructed) instance. Never returns null. Returns an instance allocated on the heap! Must call MR_ConstChildren_Iterator_Destroy() to free it when you're done using it.

MR_ConstChildren_Iterator_DefaultConstructArray()

MRC_API MR_ConstChildren_Iterator * MR_ConstChildren_Iterator_DefaultConstructArray

(

size_t

num_elems

)

Constructs an array of empty (default-constructed) instances, of the specified size. Will never return null. The array must be destroyed using MR_ConstChildren_Iterator_DestroyArray(). Use MR_ConstChildren_Iterator_OffsetMutablePtr() and MR_ConstChildren_Iterator_OffsetPtr() to access the array elements.

MR_ConstChildren_Iterator_Destroy()

MRC_API void MR_ConstChildren_Iterator_Destroy

(

const MR_ConstChildren_Iterator *

_this

)

Destroys a heap-allocated instance of MR_ConstChildren_Iterator. Does nothing if the pointer is null.

MR_ConstChildren_Iterator_DestroyArray()

MRC_API void MR_ConstChildren_Iterator_DestroyArray

(

const MR_ConstChildren_Iterator *

_this

)

Destroys a heap-allocated array of MR_ConstChildren_Iterator. Does nothing if the pointer is null.

MR_ConstChildren_Iterator_OffsetMutablePtr()

MRC_API MR_ConstChildren_Iterator * MR_ConstChildren_Iterator_OffsetMutablePtr	(	MR_ConstChildren_Iterator *	ptr,
		ptrdiff_t	i )

Offsets a pointer to an array element by i positions (not bytes). Use only if you're certain that the pointer points to an array element. The reference to the parameter ptr might be preserved in the return value.

MR_ConstChildren_Iterator_OffsetPtr()

MRC_API const MR_ConstChildren_Iterator * MR_ConstChildren_Iterator_OffsetPtr	(	const MR_ConstChildren_Iterator *	ptr,
		ptrdiff_t	i )

Offsets a pointer to an array element by i positions (not bytes). Use only if you're certain that the pointer points to an array element. The reference to the parameter ptr might be preserved in the return value.

MR_ConstChildren_OffsetMutablePtr()

MRC_API MR_ConstChildren * MR_ConstChildren_OffsetMutablePtr	(	MR_ConstChildren *	ptr,
		ptrdiff_t	i )

Offsets a pointer to an array element by i positions (not bytes). Use only if you're certain that the pointer points to an array element. The reference to the parameter ptr might be preserved in the return value.

MR_ConstChildren_OffsetPtr()

MRC_API const MR_ConstChildren * MR_ConstChildren_OffsetPtr	(	const MR_ConstChildren *	ptr,
		ptrdiff_t	i )

Offsets a pointer to an array element by i positions (not bytes). Use only if you're certain that the pointer points to an array element. The reference to the parameter ptr might be preserved in the return value.

MR_ConstChildren_size()

MRC_API size_t MR_ConstChildren_size

(

const MR_ConstChildren *

_this

)

Generated from method MR::ConstChildren::size. Parameter _this can not be null. It is a single object.

MR_deref_MR_ConstChildren_Iterator()

MRC_API MR_std_shared_ptr_const_MR_Object * MR_deref_MR_ConstChildren_Iterator

(

const MR_ConstChildren_Iterator *

_this

)

Generated from method MR::ConstChildren::Iterator::operator*. Parameter _this can not be null. It is a single object. Never returns null. Returns an instance allocated on the heap! Must call MR_std_shared_ptr_const_MR_Object_Destroy() to free it when you're done using it. The reference to this object might be preserved in the return value.

MR_equal_MR_ConstChildren_Iterator()

MRC_API bool MR_equal_MR_ConstChildren_Iterator	(	const MR_ConstChildren_Iterator *	_this,
		const MR_ConstChildren_Iterator *	_1 )

Generated from method MR::ConstChildren::Iterator::operator==. Parameter _this can not be null. It is a single object. Parameter _1 can not be null. It is a single object.

MR_incr_MR_ConstChildren_Iterator()

MRC_API MR_ConstChildren_Iterator * MR_incr_MR_ConstChildren_Iterator

(

MR_ConstChildren_Iterator *

_this

)

Generated from method MR::ConstChildren::Iterator::operator++. Parameter _this can not be null. It is a single object. The returned pointer will never be null. It is non-owning, do NOT destroy it.

MR_post_incr_MR_ConstChildren_Iterator()

MRC_API MR_ConstChildren_Iterator * MR_post_incr_MR_ConstChildren_Iterator

(

MR_ConstChildren_Iterator *

_this

)

Generated from method MR::ConstChildren::Iterator::operator++. Parameter _this can not be null. It is a single object. Never returns null. Returns an instance allocated on the heap! Must call MR_ConstChildren_Iterator_Destroy() to free it when you're done using it.