ITK  6.0.0
Insight Toolkit
Public Types | Public Member Functions | Protected Member Functions | Private Member Functions | Friends | List of all members
itk::MetaDataObjectBase Class Referenceabstract

#include <itkMetaDataObjectBase.h>

Detailed Description

The common interface for MetaDataObject's.

This class is intended as the value part of the (key,value) pair to be stored in a MetaDataDictionary

Author
Hans J. Johnson

Definition at line 47 of file itkMetaDataObjectBase.h.

+ Inheritance diagram for itk::MetaDataObjectBase:
+ Collaboration diagram for itk::MetaDataObjectBase:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = MetaDataObjectBase
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

virtual const std::type_info & GetMetaDataObjectTypeInfo () const
 
virtual const char * GetMetaDataObjectTypeName () const
 
const char * GetNameOfClass () const override
 
virtual void Print (std::ostream &os) const
 
- Public Member Functions inherited from itk::LightObject
Pointer Clone () const
 
virtual Pointer CreateAnother () const
 
virtual void Delete ()
 
virtual const char * GetNameOfClass () const
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 
virtual void Register () const
 
virtual void SetReferenceCount (int)
 
virtual void UnRegister () const noexcept
 

Protected Member Functions

 MetaDataObjectBase ()
 
 ~MetaDataObjectBase () override
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintSelf (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Member Functions

virtual bool Equal (const MetaDataObjectBase &) const =0
 

Friends

bool operator!= (const Self &lhs, const Self &rhs)
 
bool operator== (const Self &lhs, const Self &rhs)
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ ConstPointer

Definition at line 56 of file itkMetaDataObjectBase.h.

◆ Pointer

Definition at line 55 of file itkMetaDataObjectBase.h.

◆ Self

Smart pointer type alias support

Definition at line 53 of file itkMetaDataObjectBase.h.

◆ Superclass

Definition at line 54 of file itkMetaDataObjectBase.h.

Constructor & Destructor Documentation

◆ MetaDataObjectBase()

itk::MetaDataObjectBase::MetaDataObjectBase ( )
protected

◆ ~MetaDataObjectBase()

itk::MetaDataObjectBase::~MetaDataObjectBase ( )
overrideprotected

Member Function Documentation

◆ Equal()

virtual bool itk::MetaDataObjectBase::Equal ( const MetaDataObjectBase ) const
privatepure virtual

◆ GetMetaDataObjectTypeInfo()

virtual const std::type_info & itk::MetaDataObjectBase::GetMetaDataObjectTypeInfo ( ) const
virtual
Author
Hans J. Johnson
Returns
A constant reference to a std::type_info object

Reimplemented in itk::MetaDataObject< MetaDataObjectType >.

◆ GetMetaDataObjectTypeName()

virtual const char * itk::MetaDataObjectBase::GetMetaDataObjectTypeName ( ) const
virtual
Author
Hans J. Johnson
Returns
A pointer to a const char array containing the unique type name.

Reimplemented in itk::MetaDataObject< MetaDataObjectType >.

◆ GetNameOfClass()

const char * itk::MetaDataObjectBase::GetNameOfClass ( ) const
overridevirtual
See also
LightObject::GetNameOfClass()

Reimplemented from itk::LightObject.

◆ Print()

virtual void itk::MetaDataObjectBase::Print ( std::ostream &  os) const
virtual

Defines the default behavior for printing out this element

Parameters
osAn output stream

Reimplemented in itk::MetaDataObject< MetaDataObjectType >.

Friends And Related Function Documentation

◆ operator!=

bool operator!= ( const Self lhs,
const Self rhs 
)
friend

Returns (metaDataBase1 != metaDataBase2).

Definition at line 84 of file itkMetaDataObjectBase.h.

◆ operator==

bool operator== ( const Self lhs,
const Self rhs 
)
friend

Returns (metaDataBase1 == metaDataBase2).

Definition at line 77 of file itkMetaDataObjectBase.h.


The documentation for this class was generated from the following file: