#include <itkVideoIOFactory.h>

Detailed Description

Create instances of VideoIO objects using an object factory.

This class will create a VideoIO instance that can read/write to/from the desired file or camera. In order for a specific VideoIO type to be considered, it must be registered with the ITK ObjectFactoryBase.

Definition at line 60 of file itkVideoIOFactory.h.

Inheritance diagram for itk::VideoIOFactory:

Collaboration diagram for itk::VideoIOFactory:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	IOModeEnum = VideoIOFactoryEnums::IOMode

using	Pointer = SmartPointer< Self >

using	Self = VideoIOFactory

using	Superclass = Object

Public Types inherited from itk::Object
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = Object

using	Superclass = LightObject

Public Types inherited from itk::LightObject
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = LightObject

Public Member Functions
const char *	GetNameOfClass () const override

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *cmd) const

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const

LightObject::Pointer	CreateAnother () const override

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag) const

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexcept override

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
Pointer	Clone () const

virtual void	Delete ()

virtual int	GetReferenceCount () const

void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static VideoIOBase::Pointer	CreateVideoIO (IOModeEnum mode, const char *arg)

Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool val)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Protected Member Functions
	VideoIOFactory ()

	~VideoIOFactory () override

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

void	PrintSelf (std::ostream &os, Indent indent) const override

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

	~Object () 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	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Additional Inherited Members
Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Member Typedef Documentation

◆ ConstPointer

using itk::VideoIOFactory::ConstPointer = SmartPointer<const Self>

Definition at line 69 of file itkVideoIOFactory.h.

◆ IOModeEnum

using itk::VideoIOFactory::IOModeEnum = VideoIOFactoryEnums::IOMode

Definition at line 71 of file itkVideoIOFactory.h.

◆ Pointer

using itk::VideoIOFactory::Pointer = SmartPointer<Self>

Definition at line 68 of file itkVideoIOFactory.h.

◆ Self

using itk::VideoIOFactory::Self = VideoIOFactory

Standard class type aliases.

Definition at line 66 of file itkVideoIOFactory.h.

◆ Superclass

using itk::VideoIOFactory::Superclass = Object

Definition at line 67 of file itkVideoIOFactory.h.

Constructor & Destructor Documentation

◆ VideoIOFactory()

itk::VideoIOFactory::VideoIOFactory ( )

protected

◆ ~VideoIOFactory()

itk::VideoIOFactory::~VideoIOFactory ( )

overrideprotected

Member Function Documentation

◆ CreateVideoIO()

static VideoIOBase::Pointer itk::VideoIOFactory::CreateVideoIO	(	IOModeEnum	mode,
		const char *	arg
	)

static

Create the appropriate ImageIO depending on the particulars of the file. Note: arg can either be a path for reading/writing from/to a file or a a string containing an integer to use for a cameraID if reading from a camera

◆ GetNameOfClass()

const char* itk::VideoIOFactory::GetNameOfClass ( ) const

overridevirtual

Runtime type information (and related methods).

Reimplemented from itk::Object.

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

itkVideoIOFactory.h