ot::BasicEntityInformation Class Reference

#include "BasicEntityInformation.h"

Inheritance diagram for ot::BasicEntityInformation:

Public Member Functions
	BasicEntityInformation ()
	BasicEntityInformation (const std::string &_entityName)
	BasicEntityInformation (const std::string &_entityName, UID _entityId, UID _entityVersion)
	BasicEntityInformation (const BasicEntityInformation &_other)
virtual	~BasicEntityInformation ()
BasicEntityInformation &	operator= (const BasicEntityInformation &_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	setEntityName (const std::string &_entityName)
const std::string &	getEntityName (void) const
void	setEntityID (UID _entityId)
UID	getEntityID (void) const
void	setEntityVersion (UID _entityVersion)
UID	getEntityVersion (void) const
Public Member Functions inherited from ot::Serializable
	Serializable ()
virtual	~Serializable ()

Constructor & Destructor Documentation

BasicEntityInformation() [1/4]

ot::BasicEntityInformation::BasicEntityInformation

(

)

BasicEntityInformation() [2/4]

ot::BasicEntityInformation::BasicEntityInformation

(

const std::string &

_entityName

)

BasicEntityInformation() [3/4]

ot::BasicEntityInformation::BasicEntityInformation	(	const std::string &	_entityName,
		UID	_entityId,
		UID	_entityVersion )

BasicEntityInformation() [4/4]

ot::BasicEntityInformation::BasicEntityInformation

(

const BasicEntityInformation &

_other

)

~BasicEntityInformation()

ot::BasicEntityInformation::~BasicEntityInformation ( )

virtual

Member Function Documentation

addToJsonObject()

void ot::BasicEntityInformation::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.

Reimplemented in ot::TableCfg, ot::TextEditorCfg, and ot::WidgetViewBase.

getEntityID()

UID ot::BasicEntityInformation::getEntityID ( void ) const

inline

getEntityName()

const std::string & ot::BasicEntityInformation::getEntityName ( void ) const

inline

getEntityVersion()

UID ot::BasicEntityInformation::getEntityVersion ( void ) const

inline

operator=()

ot::BasicEntityInformation & ot::BasicEntityInformation::operator=

(

const BasicEntityInformation &

_other

)

setEntityID()

void ot::BasicEntityInformation::setEntityID ( UID _entityId )

inline

setEntityName()

void ot::BasicEntityInformation::setEntityName ( const std::string & _entityName )

inline

setEntityVersion()

void ot::BasicEntityInformation::setEntityVersion ( UID _entityVersion )

inline

setFromJsonObject()

void ot::BasicEntityInformation::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.

Reimplemented in ot::TableCfg, ot::TextEditorCfg, and ot::WidgetViewBase.

---

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

• Libraries/OTCore/include/OTCore/BasicEntityInformation.h
• Libraries/OTCore/src/BasicEntityInformation.cpp