prtx::AnnotationBuilder Class Reference

#include <AnnotationBuilder.h>

Inheritance diagram for prtx::AnnotationBuilder:

Public Member Functions
void	addArgument (const prt::AnnotationArgument *arg)
void	addBool (const std::wstring &key, bool val)
void	addFloat (const std::wstring &key, double val)
void	addString (const std::wstring &key, const std::wstring &val)
	AnnotationBuilder (const AnnotationBuilder &)=delete
virtual const prt::Annotation *	create (std::wstring *warnings=0) const
virtual const prt::Annotation *	createAndReset (std::wstring *warnings=0)
AnnotationBuilder &	operator= (const AnnotationBuilder &)=delete
void	setName (const std::wstring &name)
Public Member Functions inherited from prtx::Builder< const prt::Annotation >
	Builder (const Builder &)=delete
Builder &	operator= (const Builder &)=delete

Static Public Member Functions
static const prt::Annotation *	createAnnotation (const std::wstring &name)
static const prt::Annotation *	createAnnotation (const std::wstring &name, const std::wstring &key, const std::wstring &val)
static const prt::Annotation *	createAnnotation (const std::wstring &name, const std::wstring &key, double val)
static const prt::Annotation *	createAnnotation (const std::wstring &name, const std::wstring &key, bool val)

Detailed Description

Use this builder class to annotate attributes or encoder options.

Member Function Documentation

addArgument()

void prtx::AnnotationBuilder::addArgument

(

const prt::AnnotationArgument *

arg

)

Adds any annotation argument created by the AnnotationArgumentBuilder.

addBool()

void prtx::AnnotationBuilder::addBool	(	const std::wstring &	key,
		bool	val
	)

Convenience member function to add a bool annotation argument.

addFloat()

void prtx::AnnotationBuilder::addFloat	(	const std::wstring &	key,
		double	val
	)

Convenience member function to add a double annotation argument.

addString()

void prtx::AnnotationBuilder::addString	(	const std::wstring &	key,
		const std::wstring &	val
	)

Convenience member function to add a string annotation argument.

create()

virtual const prt::Annotation* prtx::AnnotationBuilder::create ( std::wstring *  warnings = 0 ) const

virtual

Creates an annotation instance but does not change the state of the builder.

Implements prtx::Builder< const prt::Annotation >.

createAndReset()

virtual const prt::Annotation* prtx::AnnotationBuilder::createAndReset ( std::wstring *  warnings = 0 )

virtual

Creates an annotation instance and resets the builder.

Implements prtx::Builder< const prt::Annotation >.

createAnnotation() [1/4]

static const prt::Annotation* prtx::AnnotationBuilder::createAnnotation ( const std::wstring &  name )

static

Convenience member function to create an annotation without any parameters.

createAnnotation() [2/4]

static const prt::Annotation* prtx::AnnotationBuilder::createAnnotation ( const std::wstring &  name, const std::wstring &  key, const std::wstring &  val  )

static

Convenience member function to create an annotation with a single string parameter.

createAnnotation() [3/4]

static const prt::Annotation* prtx::AnnotationBuilder::createAnnotation ( const std::wstring &  name, const std::wstring &  key, double  val  )

static

Convenience member function to create an annotation with a single double parameter.

createAnnotation() [4/4]

static const prt::Annotation* prtx::AnnotationBuilder::createAnnotation ( const std::wstring &  name, const std::wstring &  key, bool  val  )

static

Convenience member function to create an annotation with a single boolean parameter.

setName()

void prtx::AnnotationBuilder::setName

(

const std::wstring &

name

)

Sets the annotation name.

---

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

• AnnotationBuilder.h