ot::CopyInformation Class Reference

#include "CopyInformation.h"

Inheritance diagram for ot::CopyInformation:

Public Member Functions
	CopyInformation ()
	CopyInformation (const ConstJsonObject &_jsonObject)
	CopyInformation (const CopyInformation &)=default
	CopyInformation (CopyInformation &&)=default
	~CopyInformation ()=default
CopyInformation &	operator= (const CopyInformation &)=default
CopyInformation &	operator= (CopyInformation &&)=default
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.
int	getCopyVersion (void) const
void	setProjectName (const std::string &_projectName)
const std::string &	getProjectName (void) const
void	setViewName (const std::string &_name)
const std::string &	getViewName (void) const
void	setViewOwner (const BasicServiceInformation &_owner)
const BasicServiceInformation &	getViewOwner (void) const
void	addEntity (UID _uid, const std::string &_name, const std::string &_rawData=std::string())
void	addEntity (const CopyEntityInformation &_entityInfo)
void	setEntities (const std::list< CopyEntityInformation > &_entities)
std::list< CopyEntityInformation > &	getEntities (void)
const std::list< CopyEntityInformation > &	getEntities (void) const
void	setScenePos (const Point2DD &_pos)
const Point2DD &	getScenePos (void) const
bool	getScenePosSet (void) const
virtual bool	isValid (void) const
Public Member Functions inherited from ot::Serializable
	Serializable ()
virtual	~Serializable ()

Static Public Member Functions
static std::string	getCopyVersionJsonKey (void)

Constructor & Destructor Documentation

CopyInformation() [1/4]

ot::CopyInformation::CopyInformation

(

)

CopyInformation() [2/4]

ot::CopyInformation::CopyInformation

(

const ConstJsonObject &

_jsonObject

)

CopyInformation() [3/4]

ot::CopyInformation::CopyInformation ( const CopyInformation & )

default

CopyInformation() [4/4]

ot::CopyInformation::CopyInformation ( CopyInformation && )

default

~CopyInformation()

ot::CopyInformation::~CopyInformation ( )

default

Member Function Documentation

addEntity() [1/2]

void ot::CopyInformation::addEntity ( const CopyEntityInformation & _entityInfo )

inline

addEntity() [2/2]

void ot::CopyInformation::addEntity	(	UID	_uid,
		const std::string &	_name,
		const std::string &	_rawData = std::string() )

addToJsonObject()

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

getCopyVersion()

int ot::CopyInformation::getCopyVersion ( void ) const

inline

getCopyVersionJsonKey()

std::string ot::CopyInformation::getCopyVersionJsonKey ( void )

static

getEntities() [1/2]

std::list< CopyEntityInformation > & ot::CopyInformation::getEntities ( void )

inline

getEntities() [2/2]

const std::list< CopyEntityInformation > & ot::CopyInformation::getEntities ( void ) const

inline

getProjectName()

const std::string & ot::CopyInformation::getProjectName ( void ) const

inline

getScenePos()

const Point2DD & ot::CopyInformation::getScenePos ( void ) const

inline

getScenePosSet()

bool ot::CopyInformation::getScenePosSet ( void ) const

inline

getViewName()

const std::string & ot::CopyInformation::getViewName ( void ) const

inline

getViewOwner()

const BasicServiceInformation & ot::CopyInformation::getViewOwner ( void ) const

inline

isValid()

bool ot::CopyInformation::isValid ( void ) const

virtual

operator=() [1/2]

CopyInformation & ot::CopyInformation::operator= ( const CopyInformation & )

default

operator=() [2/2]

CopyInformation & ot::CopyInformation::operator= ( CopyInformation && )

default

setEntities()

void ot::CopyInformation::setEntities ( const std::list< CopyEntityInformation > & _entities )

inline

setFromJsonObject()

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

setProjectName()

void ot::CopyInformation::setProjectName ( const std::string & _projectName )

inline

setScenePos()

void ot::CopyInformation::setScenePos ( const Point2DD & _pos )

inline

setViewName()

void ot::CopyInformation::setViewName ( const std::string & _name )

inline

setViewOwner()

void ot::CopyInformation::setViewOwner ( const BasicServiceInformation & _owner )

inline

---

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

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