DD::Image::DeepWriter::Description Class Reference

#include <DeepWriter.h>

Inheritance diagram for DD::Image::DeepWriter::Description:

Public Types
typedef DeepWriter *(*	Constructor) (DeepWriterOwner *)
Public Types inherited from DD::Image::Description
typedef Node *(*	NodeBuilder) (void *)
typedef std::vector< Description * >	DescriptionList

Public Member Functions
	Description (const char *n, const char *l, Constructor c, License *f=nullptr)
	Description (const char *n, Constructor c, License *f=nullptr)

Static Public Member Functions
static const Description *	find (int i)
static const Description *	find (const char *name)

Public Attributes
const char *	names
const char *	label
Constructor	constructor
Public Attributes inherited from DD::Image::Description
const char *	compiled
const char *	plugin
License *	license

Additional Inherited Members
Protected Member Functions inherited from DD::Image::Description
void	ctor (void(*f)(Description *))
void	ctor (void(*f)(Description *), NodeBuilder nodeBuilder)

Detailed Description

Class for keeping track of the various available DeepWriters

Constructor & Destructor Documentation

Description() [1/2]

DD::Image::DeepWriter::Description::Description ( const char *  n, const char *  l, Constructor  c, License *  f = nullptr  )

inline

Constructor that fills all fields and allows a license check.

Description() [2/2]

DD::Image::DeepWriter::Description::Description ( const char *  n, Constructor  c, License *  f = nullptr  )

inline

Simpler constructor that sets names and label to same value.

Member Function Documentation

find() [1/2]

const DeepWriter::Description * DD::Image::DeepWriter::Description::find ( int  i )

static

Return the i'th Writer::Description known about, or return a null pointer for the last one.

find() [2/2]

const DeepWriter::Description * DD::Image::DeepWriter::Description::find ( const char *  name )

static

Search all the defined DeepWriter::Descriptions for one whose name matches the passed string, or return NULL if none. This will also try to plugin_load("xyzWriterDeep") (where xyz is id) in order to find external file writing code.

If this returns null, then plugin_error() will contain an error.

References DD::Image::plugin_load().

Member Data Documentation

names

const char* DD::Image::DeepWriter::Description::names

Null separated list (as in "sgi\0rgb\0") of identifiers for this file type.

If "xyz" in in this list then a filename of "*.xyz" or "xyz:*" is considered to be this type.

label

const char* DD::Image::DeepWriter::Description::label

User-friendly version of the name.

constructor

Constructor DD::Image::DeepWriter::Description::constructor

Make an instance of the writer. This cannot fail, instead the execute() method should try to open the output file and produce any error messages.