prtx::EncodeOptionsAnnotator Class Reference

#include <EncodeOptions.h>

Classes
class	OptionAnnotator

Public Member Functions
	EncodeOptionsAnnotator (EncoderInfoBuilder &infoBuilder)
	EncodeOptionsAnnotator (const EncodeOptionsAnnotator &)=delete
void	flagAsHidden (const std::wstring &optionKey)
void	flagAsMandatory (const std::wstring &optionKey)
void	flagAsPerLayer (const std::wstring &optionKey, const std::wstring &layerDefault)
void	flagAsPerLayer (const std::wstring &optionKey, const double &layerDefault)
void	flagAsPerLayer (const std::wstring &optionKey, const bool &layerDefault)
void	flagAsPerLayer (const std::wstring &optionKey, const int32_t &layerDefault)
void	flagAsPoint2D (const std::wstring &optionKey)
void	flagAsPoint3D (const std::wstring &optionKey)
EncodeOptionsAnnotator &	operator= (const EncodeOptionsAnnotator &)=delete
OptionAnnotator	option (const std::wstring &optionKey)
void	setDescription (const std::wstring &optionKey, const std::wstring &desc)
void	setEnumerants (const std::wstring &optionKey, const StringEnum &items)
void	setGroup (const std::wstring &optionKey, const std::wstring &groupName, const double &order)
void	setLabel (const std::wstring &optionKey, const std::wstring &label)
void	setOrder (const std::wstring &optionKey, const double &order)
void	setRange (const std::wstring &optionKey, double min, double max)

Protected Attributes
AnnotationBuilder	mAnnotationBuilder
EncoderInfoBuilder &	mInfoBuilder

Detailed Description

Helper class to simplify the annotation of encoder options. Note: the default options need to be set on the EncoderInfoBuilder before this class is used. Trying to annotate an non-existing option will throw an exception.

A typical usage example:

prtx::PRTUtils::AttributeMapBuilderPtr amb(prt::AttributeMapBuilder::create());
amb->setInt(L"omg", 666);

prtx::EncoderInfoBuilder eib;
eib.setDefaultOptions(amb->createAttributeMap());

prtx::EncodeOptionsAnnotator eoa(eib);
eoa.option(L"omg").setLabel(L"Oh My God").setDescription(L"An incredible blasphemous option.").flagAsHidden();

prtx::PRTUtils::EncoderInfoPtr info(eib.createInfo());
// ... now use info to create encoder factory ...

See also

prtx::EncoderInfoBuilder

prt::AttributeMapBuilder

Constructor & Destructor Documentation

EncodeOptionsAnnotator()

prtx::EncodeOptionsAnnotator::EncodeOptionsAnnotator

(

EncoderInfoBuilder &

infoBuilder

)

Creates an EncodeOptionsAnnotator instance which operates on infoBuilder.

See also

prtx::EncoderInfoBuilder

Member Function Documentation

flagAsHidden()

void prtx::EncodeOptionsAnnotator::flagAsHidden

(

const std::wstring &

optionKey

)

Adds an Annotations::HIDDEN annotation.

flagAsMandatory()

void prtx::EncodeOptionsAnnotator::flagAsMandatory

(

const std::wstring &

optionKey

)

Adds an Annotations::MANDATORY annotation.

flagAsPerLayer() [1/4]

void prtx::EncodeOptionsAnnotator::flagAsPerLayer	(	const std::wstring &	optionKey,
		const std::wstring &	layerDefault
	)

Adds an Annotations::PERLAYER annotation with a string default value.

flagAsPerLayer() [2/4]

void prtx::EncodeOptionsAnnotator::flagAsPerLayer	(	const std::wstring &	optionKey,
		const double &	layerDefault
	)

Adds an Annotations::PERLAYER annotation with a double default value.

flagAsPerLayer() [3/4]

void prtx::EncodeOptionsAnnotator::flagAsPerLayer	(	const std::wstring &	optionKey,
		const bool &	layerDefault
	)

Adds an Annotations::PERLAYER annotation with bool default value.

flagAsPerLayer() [4/4]

void prtx::EncodeOptionsAnnotator::flagAsPerLayer	(	const std::wstring &	optionKey,
		const int32_t &	layerDefault
	)

Adds an Annotations::PERLAYER annotation with a in32_t default value.

flagAsPoint2D()

void prtx::EncodeOptionsAnnotator::flagAsPoint2D

(

const std::wstring &

optionKey

)

Adds an Annotations::POINT2D annotation.

flagAsPoint3D()

void prtx::EncodeOptionsAnnotator::flagAsPoint3D

(

const std::wstring &

optionKey

)

Adds an Annotations::POINT3D annotation.

option()

OptionAnnotator prtx::EncodeOptionsAnnotator::option

(

const std::wstring &

optionKey

)

Access to member function chaining helper class for one option.`

setDescription()

void prtx::EncodeOptionsAnnotator::setDescription	(	const std::wstring &	optionKey,
		const std::wstring &	desc
	)

Adds an Annotations::DESCRIPTION annotation.

setEnumerants()

void prtx::EncodeOptionsAnnotator::setEnumerants	(	const std::wstring &	optionKey,
		const StringEnum &	items
	)

Adds an Annotations::RANGE annotation with string values (= enumeration).

setGroup()

void prtx::EncodeOptionsAnnotator::setGroup	(	const std::wstring &	optionKey,
		const std::wstring &	groupName,
		const double &	order
	)

Adds an Annotations::GROUP annotation.

setLabel()

void prtx::EncodeOptionsAnnotator::setLabel	(	const std::wstring &	optionKey,
		const std::wstring &	label
	)

Adds an Annotations::LABEL annotation.

setOrder()

void prtx::EncodeOptionsAnnotator::setOrder	(	const std::wstring &	optionKey,
		const double &	order
	)

Adds an Annotations::ORDER annotation.

setRange()

void prtx::EncodeOptionsAnnotator::setRange	(	const std::wstring &	optionKey,
		double	min,
		double	max
	)

Adds an Annotations::RANGE annotation with double values (= numeric range).

---

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

• EncodeOptions.h