btk::DataObject Class Reference

Input and output entry for processes in pipelines. More...

#include <btkDataObject.h>

Inheritance diagram for btk::DataObject:

Public Types
typedef btkSharedPtr< const DataObject >	ConstPointer
typedef btkNullPtr< DataObject >	NullPointer
typedef btkSharedPtr< DataObject >	Pointer
Public Types inherited from btk::Object
typedef btkSharedPtr< const Object >	ConstPointer
typedef btkSharedPtr< Object >	Pointer

Public Member Functions
DataObject *	GetParent () const
bool	HasParent () const
void	Modified ()
void	SetParent (DataObject *parent)
void	Update ()
Public Member Functions inherited from btk::Object
unsigned long int	GetTimestamp () const

Static Public Member Functions
static NullPointer	Null ()

Protected Member Functions
	DataObject ()
	DataObject (const DataObject &toCopy)
virtual	~DataObject ()
Protected Member Functions inherited from btk::Object
	Object ()
	Object (const Object &toCopy)
virtual	~Object ()

Friends
class	ProcessObject

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

Detailed Description

Input and output entry for processes in pipelines.

Member Typedef Documentation

btk::DataObject::ConstPointer

Smart pointer associated with a const DataObject object.

btk::DataObject::NullPointer

Special null pointer associated with a DataObject object. This type should be used only internally to test the nullity of a smart pointer. See the static method Null() instead.

btk::DataObject::Pointer

Smart pointer associated with a DataObject object.

Constructor & Destructor Documentation

btk::DataObject::DataObject ( )

inlineprotected

Default constructor.

btk::DataObject::DataObject ( const DataObject &  toCopy )

inlineprotected

Copy constructor.

btk::DataObject::~DataObject ( )

protectedvirtual

Destructor.

Member Function Documentation

DataObject * btk::DataObject::GetParent ( ) const

inline

Return the object's parent.

bool btk::DataObject::HasParent ( ) const

inline

Checks if this DataObject has a parent.

void btk::DataObject::Modified ( )

virtual

Tells to its parent that this DataObject has been modified. This method has to be called each time that the DataObject is modified.

Reimplemented from btk::Object.

static NullPointer btk::DataObject::Null ( )

inlinestatic

Static function to return a null pointer.

Note

This static method should be used only to test if a shared ponter is null or not. It is advised to call the method without parenthesis as special (in)equality operator are implemented to use a function pointer. See the description of the class NullPtr for an example.

void btk::DataObject::SetParent

(

DataObject *

parent

)

Sets the parent.

void btk::DataObject::Update

(

)

Updates the ProcessObject associated with this DataObject.