ot::GraphicsConnectionPackage Class Reference

#include "GraphicsPackage.h"

Inheritance diagram for ot::GraphicsConnectionPackage:

Public Member Functions
	GraphicsConnectionPackage (const std::string &_editorName=std::string())
virtual	~GraphicsConnectionPackage ()
virtual void	addToJsonObject (JsonValue &_object, JsonAllocator &_allocator) const override
	Add the object contents to the provided JSON object.
virtual void	setFromJsonObject (const ConstJsonObject &_object) override
	Will set the object contents from the provided JSON object.
void	setName (const std::string &_name)
const std::string &	name (void) const
void	addConnection (const ot::UID &_fromUid, const std::string &_fromConnectable, const ot::UID &_toUid, const std::string &_toConnectable)
void	addConnection (const GraphicsConnectionCfg &_info)
const std::list< GraphicsConnectionCfg > &	connections (void) const
Public Member Functions inherited from ot::Serializable
	Serializable ()
virtual	~Serializable ()
virtual void	addToJsonObject (ot::JsonValue &_object, ot::JsonAllocator &_allocator) const =0
	Add the object contents to the provided JSON object.

Constructor & Destructor Documentation

GraphicsConnectionPackage()

ot::GraphicsConnectionPackage::GraphicsConnectionPackage

(

const std::string &

_editorName = std::string()

)

~GraphicsConnectionPackage()

ot::GraphicsConnectionPackage::~GraphicsConnectionPackage ( )

virtual

Member Function Documentation

addConnection() [1/2]

void ot::GraphicsConnectionPackage::addConnection ( const GraphicsConnectionCfg & _info )

inline

addConnection() [2/2]

void ot::GraphicsConnectionPackage::addConnection	(	const ot::UID &	_fromUid,
		const std::string &	_fromConnectable,
		const ot::UID &	_toUid,
		const std::string &	_toConnectable )

addToJsonObject()

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

overridevirtual

Add the object contents to the provided JSON object.

Parameters

_document	The JSON document (used to get the allocator)
_object	The JSON object to add the contents to

connections()

const std::list< GraphicsConnectionCfg > & ot::GraphicsConnectionPackage::connections ( void ) const

inline

name()

const std::string & ot::GraphicsConnectionPackage::name ( void ) const

inline

setFromJsonObject()

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

overridevirtual

Will set the object contents from the provided JSON object.

Parameters

_object

The JSON object containing the information

Exceptions

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

Implements ot::Serializable.

setName()

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

inline

---

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

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