btk::DataObjectLabeled Class Reference

DataObject with a label and a description. More...

#include <btkDataObject.h>

Inheritance diagram for btk::DataObjectLabeled:

Public Types
typedef btkSharedPtr< const DataObjectLabeled >	ConstPointer
typedef btkSharedPtr < DataObjectLabeled >	Pointer
Public Types inherited from btk::DataObject
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
const std::string &	GetDescription () const
const std::string &	GetLabel () const
virtual void	SetDescription (const std::string &description)
virtual void	SetLabel (const std::string &label)
Public Member Functions inherited from btk::DataObject
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

Protected Member Functions
	DataObjectLabeled (const std::string &label="", const std::string &description="")
	DataObjectLabeled (const DataObjectLabeled &toCopy)
Protected Member Functions inherited from btk::DataObject
	DataObject ()
	DataObject (const DataObject &toCopy)
virtual	~DataObject ()
Protected Member Functions inherited from btk::Object
	Object ()
	Object (const Object &toCopy)
virtual	~Object ()

Protected Attributes
std::string	m_Description
std::string	m_Label
Protected Attributes inherited from btk::Object
unsigned long int	m_Timestamp

Additional Inherited Members
Static Public Member Functions inherited from btk::DataObject
static NullPointer	Null ()

Detailed Description

DataObject with a label and a description.

Member Typedef Documentation

btk::DataObjectLabeled::ConstPointer

Smart pointer associated with a const DataObjectLabeled object.

btk::DataObjectLabeled::Pointer

Smart pointer associated with a DataObjectLabeled object.

Constructor & Destructor Documentation

btk::DataObjectLabeled::DataObjectLabeled ( const std::string &  label = "", const std::string &  description = ""  )

inlineprotected

Default constructor.

btk::DataObjectLabeled::DataObjectLabeled ( const DataObjectLabeled &  toCopy )

inlineprotected

Copy constructor.

Member Function Documentation

const std::string & btk::DataObjectLabeled::GetDescription ( ) const

inline

Returns the description.

const std::string & btk::DataObjectLabeled::GetLabel ( ) const

inline

Returns the object's label.

void btk::DataObjectLabeled::SetDescription ( const std::string &  description )

virtual

Sets the description.

void btk::DataObjectLabeled::SetLabel ( const std::string &  label )

virtual

Sets the label.

Reimplemented in btk::MetaData.

Member Data Documentation

btk::DataObjectLabeled::m_Description

protected

Description associated with the object.

btk::DataObjectLabeled::m_Label

protected

Label of the object.