Slicer  4.11
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Friends
vtkStreamingVolumeCodecFactory Class Reference

Class that can create compresion device for streaming volume instances. More...

#include <Libs/vtkAddon/vtkStreamingVolumeCodecFactory.h>

Inheritance diagram for vtkStreamingVolumeCodecFactory:
Inheritance graph
[legend]
Collaboration diagram for vtkStreamingVolumeCodecFactory:
Collaboration graph
[legend]

Public Types

typedef vtkObject Superclass
 

Public Member Functions

vtkStreamingVolumeCodecCreateCodecByClassName (const std::string &codecClassName)
 
vtkStreamingVolumeCodecCreateCodecByFourCC (const std::string codecFourCC)
 
virtual const char * GetClassName ()
 
const std::vector< std::string > GetStreamingCodecClassNames ()
 Returns a list of all registered Codecs. More...
 
std::vector< std::string > GetStreamingCodecFourCCs ()
 Get FourCCs for all registered Codecs. More...
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
bool RegisterStreamingCodec (vtkSmartPointer< vtkStreamingVolumeCodec > codec)
 
bool UnRegisterStreamingCodecByClassName (const std::string &codecClassName)
 

Static Public Member Functions

static vtkStreamingVolumeCodecFactoryGetInstance ()
 Return the singleton instance with no reference counting. More...
 
static int IsTypeOf (const char *type)
 
static vtkStreamingVolumeCodecFactoryNew ()
 
static vtkStreamingVolumeCodecFactorySafeDownCast (vtkObject *o)
 

Protected Types

typedef vtkStreamingVolumeCodecFactory Self
 

Protected Member Functions

void operator= (const vtkStreamingVolumeCodecFactory &)
 
 vtkStreamingVolumeCodecFactory ()
 
 vtkStreamingVolumeCodecFactory (const vtkStreamingVolumeCodecFactory &)
 
 ~vtkStreamingVolumeCodecFactory () override
 

Static Protected Member Functions

static void classFinalize ()
 
static void classInitialize ()
 

Protected Attributes

std::vector< vtkSmartPointer< vtkStreamingVolumeCodec > > RegisteredCodecs
 Registered codec classes. More...
 

Friends

class vtkStreamingVolumeCodecFactoryInitialize
 

Detailed Description

Class that can create compresion device for streaming volume instances.

This singleton class is a repository of all compression codecs for compressing volume. Singleton pattern adopted from vtkEventBroker class.

Definition at line 40 of file vtkStreamingVolumeCodecFactory.h.

Member Typedef Documentation

◆ Self

Definition at line 92 of file vtkStreamingVolumeCodecFactory.h.

◆ Superclass

Definition at line 44 of file vtkStreamingVolumeCodecFactory.h.

Constructor & Destructor Documentation

◆ vtkStreamingVolumeCodecFactory() [1/2]

vtkStreamingVolumeCodecFactory::vtkStreamingVolumeCodecFactory ( )
protected

◆ ~vtkStreamingVolumeCodecFactory()

vtkStreamingVolumeCodecFactory::~vtkStreamingVolumeCodecFactory ( )
overrideprotected

◆ vtkStreamingVolumeCodecFactory() [2/2]

vtkStreamingVolumeCodecFactory::vtkStreamingVolumeCodecFactory ( const vtkStreamingVolumeCodecFactory )
protected

Member Function Documentation

◆ classFinalize()

static void vtkStreamingVolumeCodecFactory::classFinalize ( )
staticprotected

◆ classInitialize()

static void vtkStreamingVolumeCodecFactory::classInitialize ( )
staticprotected

◆ CreateCodecByClassName()

vtkStreamingVolumeCodec* vtkStreamingVolumeCodecFactory::CreateCodecByClassName ( const std::string &  codecClassName)

Get pointer to codec new function, or nullptr if the codec type not registered Usage: vtkSmartPointer<vtkStreamingVolumeCodec> codec = GetVolumeCodecNewPointerByType("igtlioVideoDevice")(); Returns nullptr if no matching codec can be found

◆ CreateCodecByFourCC()

vtkStreamingVolumeCodec* vtkStreamingVolumeCodecFactory::CreateCodecByFourCC ( const std::string  codecFourCC)

Creates a new codec that matches the specified FourCC code

Parameters
codecFourCCFourCC representing the encoding method See https://www.fourcc.org/codecs.php for an incomplete list Returns nullptr if no matching codec can be found

◆ GetClassName()

virtual const char* vtkStreamingVolumeCodecFactory::GetClassName ( )
virtual

◆ GetInstance()

static vtkStreamingVolumeCodecFactory* vtkStreamingVolumeCodecFactory::GetInstance ( )
static

Return the singleton instance with no reference counting.

◆ GetStreamingCodecClassNames()

const std::vector<std::string> vtkStreamingVolumeCodecFactory::GetStreamingCodecClassNames ( )

Returns a list of all registered Codecs.

◆ GetStreamingCodecFourCCs()

std::vector<std::string> vtkStreamingVolumeCodecFactory::GetStreamingCodecFourCCs ( )

Get FourCCs for all registered Codecs.

◆ IsA()

virtual int vtkStreamingVolumeCodecFactory::IsA ( const char *  type)
virtual

◆ IsTypeOf()

static int vtkStreamingVolumeCodecFactory::IsTypeOf ( const char *  type)
static

◆ New()

static vtkStreamingVolumeCodecFactory* vtkStreamingVolumeCodecFactory::New ( )
static

This is a singleton pattern New. There will only be ONE reference to a vtkStreamingVolumeCodecFactory object per process. Clients that call this must call Delete on the object so that the reference counting will work. The single instance will be unreferenced when the program exits.

◆ operator=()

void vtkStreamingVolumeCodecFactory::operator= ( const vtkStreamingVolumeCodecFactory )
protected

◆ PrintSelf()

void vtkStreamingVolumeCodecFactory::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
override

◆ RegisterStreamingCodec()

bool vtkStreamingVolumeCodecFactory::RegisterStreamingCodec ( vtkSmartPointer< vtkStreamingVolumeCodec codec)

Registers a new video compression codec

Parameters
newCodecPointerFunction pointer to the codec type new function (e.g. (PointerToCodecBaseNew)&vtkStreamingVolumeCodec::New )

◆ SafeDownCast()

static vtkStreamingVolumeCodecFactory* vtkStreamingVolumeCodecFactory::SafeDownCast ( vtkObject *  o)
static

◆ UnRegisterStreamingCodecByClassName()

bool vtkStreamingVolumeCodecFactory::UnRegisterStreamingCodecByClassName ( const std::string &  codecClassName)

Removes a codec from the factory This does not affect codecs that have already been instantiated

Parameters
codecClassNamefull name of the codec class that is being unregistered Returns true if the codec is successfully unregistered

Friends And Related Function Documentation

◆ vtkStreamingVolumeCodecFactoryInitialize

Definition at line 91 of file vtkStreamingVolumeCodecFactory.h.

Member Data Documentation

◆ RegisteredCodecs

std::vector< vtkSmartPointer<vtkStreamingVolumeCodec> > vtkStreamingVolumeCodecFactory::RegisteredCodecs
protected

Registered codec classes.

Definition at line 99 of file vtkStreamingVolumeCodecFactory.h.


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