Composite Class Reference

Component class is a container for CVB objects. More...

#include <cvb/composite.hpp>

Public Member Functions
void *	Handle () const noexcept
	Classic API node handle.
CompositePurpose	Purpose () const noexcept
	Gets the purpose of this Composite.
std::unique_ptr< Driver::GenDcDescriptor >	GenDCFinalDescriptor () const
	If this Composite represents a GenDC container, returns the GenDC final descriptor.
bool	ContainsItem (const CompositeVariant &item) const
	Checks whether item is in this Composite.
int	ItemCount () const noexcept
	Number of variants in the composite.
void	InsertItemAt (int index, const CompositeVariant &item)
	Insert a composite item specified at given index.
void	PushBackItem (const CompositeVariant &item)
	Appends a composite item.
CompositeVariant	ItemAt (int index) const
	Access to a composite item specified by its index.
void	RemoveItemAt (int index)
	Remove a composite item specified by its index.

Static Public Member Functions
static std::unique_ptr< Composite >	Create (CompositePurpose purpose=CompositePurpose::Custom)
	Creates a composite with the given optional parameter.
static std::unique_ptr< Composite >	FromHandle (HandleGuard< Composite > &&guard)
	Creates a composite from a classic API handle.
template<class T>
static CompositePtr	FromObject (std::shared_ptr< T > object)
	Returns a composite object from the given composite compatible object.

Detailed Description

Component class is a container for CVB objects.

Example

CppMultiPartComposite

Member Function Documentation

ContainsItem()

bool ContainsItem ( const CompositeVariant & item ) const

inline

Checks whether item is in this Composite.

Returns

true if item is in this composite; false if not.

Create()

static std::unique_ptr< Composite > Create ( CompositePurpose purpose = CompositePurpose::Custom )

inlinestatic

Creates a composite with the given optional parameter.

Parameters

[in]

purpose

The purpose of this container.

Returns

Pointer to the created composite.

Exceptions

Any	exception derived from std::exception including CvbException.

FromHandle()

static std::unique_ptr< Composite > FromHandle ( HandleGuard< Composite > && guard )

inlinestatic

Creates a composite from a classic API handle.

Parameters

[in]

guard

Life time guard for C-API handle.

Returns

The composite created from the classic API handle.

Exceptions

Any	exception derived from std::exception including CvbException.

The composite takes ownership of the handle, so you must share it before using this function.

FromObject()

template<class T>

static CompositePtr FromObject ( std::shared_ptr< T > object )

static

Returns a composite object from the given composite compatible object.

Parameters

[in]

object

A composite compatible object to share.

Returns

A composite that shares resources with the given object.

GenDCFinalDescriptor()

std::unique_ptr< Driver::GenDcDescriptor > GenDCFinalDescriptor ( ) const

inline

If this Composite represents a GenDC container, returns the GenDC final descriptor.

Returns

The GenDC final descriptor.

Exceptions

Any	exception derived from std::exception including CvbException.

Handle()

void * Handle ( ) const

inlinenoexcept

Classic API node handle.

Returns

Classic API handle.

Exceptions

Does	not throw any exception.

It is normally not necessary to work with this handle.

InsertItemAt()

void InsertItemAt ( int index, const CompositeVariant & item )

inline

Insert a composite item specified at given index.

Parameters

[in]	index	Item index to insert the composite item at given index.
[in]	item	The composite item to insert.

Exceptions

Any	exception derived from std::exception including CvbException.

ItemAt()

CompositeVariant ItemAt ( int index ) const

inline

Access to a composite item specified by its index.

Parameters

[in]

index

Item index of the composite item to access.

Returns

A variant.

Exceptions

Any	exception derived from std::exception including CvbException.

ItemCount()

int ItemCount ( ) const

inlinenoexcept

Number of variants in the composite.

Returns

Number of variants.

Exceptions

Does	not throw any exception.

Purpose()

CompositePurpose Purpose ( ) const

inlinenoexcept

Gets the purpose of this Composite.

Returns

The Cvb::CompositePurpose of this object.

PushBackItem()

void PushBackItem ( const CompositeVariant & item )

inline

Appends a composite item.

Parameters

[in]

item

The composite item to append.

Exceptions

Any	exception derived from std::exception including CvbException.

RemoveItemAt()

void RemoveItemAt ( int index )

inline

Remove a composite item specified by its index.

Parameters

[in]

index

Item index of the composite item to remove.

Exceptions

Any	exception derived from std::exception including CvbException.