ot::ProjectTemplateInformation Class Reference

#include "ProjectTemplateInformation.h"

Inheritance diagram for ot::ProjectTemplateInformation:

Public Member Functions
	ProjectTemplateInformation ()
	ProjectTemplateInformation (const ProjectTemplateInformation &_other)
virtual	~ProjectTemplateInformation ()
ProjectTemplateInformation &	operator= (const ProjectTemplateInformation &_other)
virtual void	addToJsonObject (ot::JsonValue &_object, ot::JsonAllocator &_allocator) const override
	Add the object contents to the provided JSON object.
virtual void	setFromJsonObject (const ot::ConstJsonObject &_object) override
	Set the object contents from the provided JSON object.
void	setName (const std::string &_name)
const std::string &	getName (void) const
void	setProjectType (const std::string &_type)
const std::string &	getProjectType (void) const
void	setBriefDescription (const std::string &_description)
const std::string &	getBriefDescription (void) const
void	setDescription (const StyledTextBuilder &_description)
const StyledTextBuilder &	getDescription (void) const
void	setIsDefault (bool _isDefault)
bool	getIsDefault (void) const
Public Member Functions inherited from ot::Serializable
	Serializable ()
virtual	~Serializable ()

Constructor & Destructor Documentation

ProjectTemplateInformation() [1/2]

ot::ProjectTemplateInformation::ProjectTemplateInformation

(

)

ProjectTemplateInformation() [2/2]

ot::ProjectTemplateInformation::ProjectTemplateInformation

(

const ProjectTemplateInformation &

_other

)

~ProjectTemplateInformation()

ot::ProjectTemplateInformation::~ProjectTemplateInformation ( )

virtual

Member Function Documentation

addToJsonObject()

void ot::ProjectTemplateInformation::addToJsonObject ( ot::JsonValue & _object, ot::JsonAllocator & _allocator ) const

overridevirtual

Add the object contents to the provided JSON object.

Parameters

_object	Json object reference to write the data to.
_allocator	Allocator.

Implements ot::Serializable.

getBriefDescription()

const std::string & ot::ProjectTemplateInformation::getBriefDescription ( void ) const

inline

getDescription()

const StyledTextBuilder & ot::ProjectTemplateInformation::getDescription ( void ) const

inline

getIsDefault()

bool ot::ProjectTemplateInformation::getIsDefault ( void ) const

inline

getName()

const std::string & ot::ProjectTemplateInformation::getName ( void ) const

inline

getProjectType()

const std::string & ot::ProjectTemplateInformation::getProjectType ( void ) const

inline

operator=()

ot::ProjectTemplateInformation & ot::ProjectTemplateInformation::operator=

(

const ProjectTemplateInformation &

_other

)

setBriefDescription()

void ot::ProjectTemplateInformation::setBriefDescription ( const std::string & _description )

inline

setDescription()

void ot::ProjectTemplateInformation::setDescription ( const StyledTextBuilder & _description )

inline

setFromJsonObject()

void ot::ProjectTemplateInformation::setFromJsonObject ( const ot::ConstJsonObject & _object )

overridevirtual

Set the object contents from the provided JSON object.

Parameters

_object

The JSON object containing the information.

Exceptions

May	throw an exception if the provided object is not valid (members missing or invalid types).

Implements ot::Serializable.

setIsDefault()

void ot::ProjectTemplateInformation::setIsDefault ( bool _isDefault )

inline

setName()

void ot::ProjectTemplateInformation::setName ( const std::string & _name )

inline

setProjectType()

void ot::ProjectTemplateInformation::setProjectType ( const std::string & _type )

inline

---

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

• Libraries/OTGui/include/OTGui/ProjectTemplateInformation.h
• Libraries/OTGui/src/ProjectTemplateInformation.cpp