vtkDICOMUIDGenerator Class Reference

Generate UIDs for written DICOM files. More...

#include <vtkDICOMUIDGenerator.h>

Inheritance diagram for vtkDICOMUIDGenerator:

Collaboration diagram for vtkDICOMUIDGenerator:

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
vtkDICOMUIDGenerator *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) VTK_DICOM_OVERRIDE
	Print information about this object.
void	SetUIDPrefix (const char *prefix)
	Set a UID prefix to use when generating UIDs. More...
const char *	GetUIDPrefix ()
	Get the current UID prefix. More...
virtual std::string	GenerateUID (vtkDICOMTag tag)
	Generate a UID for the provided tag.
virtual void	GenerateUIDs (vtkDICOMTag tag, vtkStringArray *uids)
	Generate a series of UIDs, sorted from low to high. More...
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool debugFlag)
virtual void	Modified ()
virtual vtkMTimeType	GetMTime ()
void	PrintSelf (ostream &os, vtkIndent indent) VTK_OVERRIDE
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommand *	GetCommand (unsigned long tag)
void	RemoveObserver (vtkCommand *)
void	RemoveObservers (unsigned long event, vtkCommand *)
void	RemoveObservers (const char *event, vtkCommand *)
int	HasObserver (unsigned long event, vtkCommand *)
int	HasObserver (const char *event, vtkCommand *)
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
int	HasObserver (unsigned long event)
int	HasObserver (const char *event)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int	InvokeEvent (unsigned long event, void *callData)
int	InvokeEvent (const char *event, void *callData)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
virtual void	Delete ()
virtual void	FastDelete ()
void	InitializeObjectBase ()
void	Print (ostream &os)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
virtual void	Register (vtkObjectBase *o)
virtual void	UnRegister (vtkObjectBase *o)
int	GetReferenceCount ()
void	SetReferenceCount (int)
void	PrintRevisions (ostream &)

Static Public Member Functions
static vtkDICOMUIDGenerator *	New ()
	Static method for construction.
static vtkTypeBool	IsTypeOf (const char *type)
static vtkDICOMUIDGenerator *	SafeDownCast (vtkObjectBase *o)
static void	SetDefault (vtkDICOMUIDGenerator *uidgen)
	Set the default UID generator. More...
static vtkDICOMUIDGenerator *	GetDefault ()
	Get the default UID generator.
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
Protected Member Functions inherited from vtkObject
void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void	InternalReleaseFocus ()
Protected Member Functions inherited from vtkObjectBase
virtual void	CollectRevisions (ostream &)
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
char *	UIDPrefix
char	UIDPrefixStore [64]
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Static Protected Attributes
static vtkDICOMUIDGenerator *	Default

Friends
class	vtkDICOMUIDGeneratorInitializer

Detailed Description

Generate UIDs for written DICOM files.

This class generates UIDs that begin with a specified prefix, and are are followed by a sequence of digits that are sufficiently random that the possibility of UID collisions is vanishingly small. The default prefix 2.25. (which can be used by anyone) is followed by a 128-bit random number. Other prefixes (which can only be used by a designated organization) are followed by a 128-bit random number if the prefix is shorter than 24 chars, or a 96-bit random number if the prefix is 24 chars or longer.

Member Function Documentation

GenerateUIDs()

virtual void vtkDICOMUIDGenerator::GenerateUIDs ( vtkDICOMTag  tag, vtkStringArray *  uids  )

virtual

Generate a series of UIDs, sorted from low to high.

Before passing the string array, call SetNumberOfValues() on the array to specify the number of UIDs that you want to be stored in it. The stored UIDs will be sorted, low to high. Generating a batch of UIDs is more efficient than calling GenerateUID() repeatedly.

GetUIDPrefix()

const char* vtkDICOMUIDGenerator::GetUIDPrefix

(

)

Get the current UID prefix.

If no prefix was set, then this will return the same value as vtkDICOMUtilities::GetUIDPrefix().

IsA()

virtual vtkTypeBool vtkDICOMUIDGenerator::IsA ( const char *  name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObjectBase.

SetDefault()

static void vtkDICOMUIDGenerator::SetDefault ( vtkDICOMUIDGenerator *  uidgen )

static

Set the default UID generator.

This can be used to set an application-wide UID generator.

SetUIDPrefix()

void vtkDICOMUIDGenerator::SetUIDPrefix

(

const char *

prefix

)

Set a UID prefix to use when generating UIDs.

If this is not set, or if it is set to NULL, then the default prefix set via vtkDICOMUtilities::SetUIDPrefix() will be used. Its default is the 2.25. prefix.

---

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

• vtkDICOMUIDGenerator.h