btk::CollectionAssembly< T > Class Template Reference

Group together a set of collections of the same type. More...

#include <btkCollectionAssembly.h>

Inheritance diagram for btk::CollectionAssembly< T >:

Public Types
typedef Collection< T > ::ConstPointer	CollectionConstPointer
typedef Collection< T >::Pointer	CollectionPointer
typedef btkSharedPtr< const CollectionAssembly >	ConstPointer
typedef btkSharedPtr < CollectionAssembly >	Pointer
Public Types inherited from btk::ProcessObject
typedef btkSharedPtr< const ProcessObject >	ConstPointer
typedef btkSharedPtr < ProcessObject >	Pointer
Public Types inherited from btk::Object
typedef btkSharedPtr< const Object >	ConstPointer
typedef btkSharedPtr< Object >	Pointer

Public Member Functions
CollectionPointer	GetInput (int idx)
CollectionPointer	GetOutput ()
void	SetInput (int idx, CollectionPointer input)
virtual	~CollectionAssembly ()
Public Member Functions inherited from btk::ProcessObject
int	GetInputNumber () const
int	GetOutputNumber () const
int	GetValidInputNumber () const
void	ResetState ()
void	Update ()
Public Member Functions inherited from btk::Object
unsigned long int	GetTimestamp () const

Static Public Member Functions
static Pointer	New ()

Protected Member Functions
	CollectionAssembly ()
virtual void	GenerateData ()
CollectionPointer	GetOutput (int idx)
virtual DataObject::Pointer	MakeOutput (int idx)
Protected Member Functions inherited from btk::ProcessObject
int	GetInputIndex (DataObject::Pointer input)
DataObject::Pointer	GetNthInput (int idx)
DataObject::ConstPointer	GetNthInput (int idx) const
DataObject::Pointer	GetNthOutput (int idx)
DataObject::ConstPointer	GetNthOutput (int idx) const
int	GetOutputIndex (DataObject::Pointer output)
bool	IsModified () const
void	Modified ()
	ProcessObject ()
void	SetInputNumber (int num)
virtual void	SetNthInput (int idx, DataObject::Pointer input)
virtual void	SetNthOutput (int idx, DataObject::Pointer output)
void	SetOutputNumber (int num)
virtual	~ProcessObject ()
Protected Member Functions inherited from btk::Object
	Object ()
	Object (const Object &toCopy)
virtual	~Object ()

Additional Inherited Members
Protected Attributes inherited from btk::Object
unsigned long int	m_Timestamp

Detailed Description

template<class T>
class btk::CollectionAssembly< T >

Group together a set of collections of the same type.

Template Parameters

T	Must be a class inheriting of btk::Collection

Member Typedef Documentation

template<class T >

btk::CollectionAssembly< T >::CollectionConstPointer

Smart pointer associated with a const Collection<T> object.

template<class T >

btk::CollectionAssembly< T >::CollectionPointer

Smart pointer associated with a Collection<T> object.

template<class T >

btk::CollectionAssembly< T >::ConstPointer

Smart pointer associated with a const CollectionAssembly object.

template<class T >

btk::CollectionAssembly< T >::Pointer

Smart pointer associated with a CollectionAssembly object.

Constructor & Destructor Documentation

template<class T >

template< class T > virtual btk::CollectionAssembly< T >::~CollectionAssembly ( )

inlinevirtual

Empty destructor.

template<class T >

btk::CollectionAssembly< T >::CollectionAssembly ( )

protected

Constructor. Sets the number of inputs to 2 (extendable) and outputs to 1.

Member Function Documentation

template<class T >

void btk::CollectionAssembly< T >::GenerateData ( )

protectedvirtual

Generates the outputs' data.

Implements btk::ProcessObject.

template<class T >

template< class T > CollectionPointer btk::CollectionAssembly< T >::GetInput ( int  idx )

inline

Gets the input registered with this process at the index idx.

template<class T >

template< class T > CollectionPointer btk::CollectionAssembly< T >::GetOutput ( )

inline

Gets the output created with this process.

template<class T >

template< class T > ItemPointer btk::CollectionAssembly< T >::GetOutput ( int  idx )

inlineprotected

Returns the output at the index idx.

template<class T >

DataObject::Pointer btk::CollectionAssembly< T >::MakeOutput ( int  idx )

protectedvirtual

Creates a T:Pointer object and return it as a DataObject::Pointer.

Implements btk::ProcessObject.

template<class T >

template< class T > static Pointer btk::CollectionAssembly< T >::New ( )

inlinestatic

Creates a smart pointer associated with a CollectionAssembly<T> object.

template<class T >

template< class T > void btk::CollectionAssembly< T >::SetInput ( int  idx, CollectionPointer  input  )

inline

Sets the input required with this process at the index idx.