OpenTwin 0.1
OpenTwin
 
Loading...
Searching...
No Matches
ot::GraphicsCopyInformation Class Reference

#include "GraphicsCopyInformation.h"

Inheritance diagram for ot::GraphicsCopyInformation:
ot::CopyInformation ot::Serializable

Classes

struct  ItemInformation
 

Public Member Functions

 GraphicsCopyInformation ()=default
 
 GraphicsCopyInformation (const GraphicsCopyInformation &)=default
 
 GraphicsCopyInformation (GraphicsCopyInformation &&)=default
 
virtual ~GraphicsCopyInformation ()=default
 
GraphicsCopyInformationoperator= (const GraphicsCopyInformation &)=default
 
GraphicsCopyInformationoperator= (GraphicsCopyInformation &&)=default
 
virtual std::string getCopyType (void) const override
 
virtual int getCopyVersion (void) const override
 
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 setViewName (const std::string &_name)
 
const std::string & getViewName (void) const
 
void setViewOwner (const BasicServiceInformation &_owner)
 
const BasicServiceInformationgetViewOwner (void) const
 
void addItemInformation (UID _uid, const Point2DD &_pos)
 
void addItemInformation (const ItemInformation &_info)
 
void setItemInformation (const std::list< ItemInformation > &_info)
 
const std::list< ItemInformation > & getItemInformation (void) const
 
void moveItemsToPoint (const Point2DD &_pos)
 Move all items to this point by keeping the relative item positions.
 
void moveItemsBy (const Point2DD &_dist)
 Move all items by the specified distance.
 
bool isValid (void) const
 
- Public Member Functions inherited from ot::CopyInformation
 CopyInformation ()=default
 
 CopyInformation (const CopyInformation &)=default
 
 CopyInformation (CopyInformation &&)=default
 
virtual ~CopyInformation ()=default
 
CopyInformationoperator= (const CopyInformation &)=default
 
CopyInformationoperator= (CopyInformation &&)=default
 
- Public Member Functions inherited from ot::Serializable
 Serializable ()
 
virtual ~Serializable ()
 

Static Public Member Functions

static std::string getGraphicsCopyInformationType (void)
 
static int getGraphicsCopyInformationVersion (void)
 
- Static Public Member Functions inherited from ot::CopyInformation
static std::string getCopyTypeJsonKey (void)
 
static std::string getCopyVersionJsonKey (void)
 

Constructor & Destructor Documentation

◆ GraphicsCopyInformation() [1/3]

ot::GraphicsCopyInformation::GraphicsCopyInformation ( )
default

◆ GraphicsCopyInformation() [2/3]

ot::GraphicsCopyInformation::GraphicsCopyInformation ( const GraphicsCopyInformation & )
default

◆ GraphicsCopyInformation() [3/3]

ot::GraphicsCopyInformation::GraphicsCopyInformation ( GraphicsCopyInformation && )
default

◆ ~GraphicsCopyInformation()

virtual ot::GraphicsCopyInformation::~GraphicsCopyInformation ( )
virtualdefault

Member Function Documentation

◆ addItemInformation() [1/2]

void ot::GraphicsCopyInformation::addItemInformation ( const ItemInformation & _info)

◆ addItemInformation() [2/2]

void ot::GraphicsCopyInformation::addItemInformation ( UID _uid,
const Point2DD & _pos )

◆ addToJsonObject()

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

Add the object contents to the provided JSON object.

Parameters
_objectJson object reference to write the data to.
_allocatorAllocator.

Reimplemented from ot::CopyInformation.

◆ getCopyType()

virtual std::string ot::GraphicsCopyInformation::getCopyType ( void ) const
inlineoverridevirtual

Implements ot::CopyInformation.

◆ getCopyVersion()

virtual int ot::GraphicsCopyInformation::getCopyVersion ( void ) const
inlineoverridevirtual

Implements ot::CopyInformation.

◆ getGraphicsCopyInformationType()

static std::string ot::GraphicsCopyInformation::getGraphicsCopyInformationType ( void )
inlinestatic

◆ getGraphicsCopyInformationVersion()

static int ot::GraphicsCopyInformation::getGraphicsCopyInformationVersion ( void )
inlinestatic

◆ getItemInformation()

const std::list< ItemInformation > & ot::GraphicsCopyInformation::getItemInformation ( void ) const
inline

◆ getViewName()

const std::string & ot::GraphicsCopyInformation::getViewName ( void ) const
inline

◆ getViewOwner()

const BasicServiceInformation & ot::GraphicsCopyInformation::getViewOwner ( void ) const
inline

◆ isValid()

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

◆ moveItemsBy()

void ot::GraphicsCopyInformation::moveItemsBy ( const Point2DD & _dist)

Move all items by the specified distance.

◆ moveItemsToPoint()

void ot::GraphicsCopyInformation::moveItemsToPoint ( const Point2DD & _pos)

Move all items to this point by keeping the relative item positions.

◆ operator=() [1/2]

GraphicsCopyInformation & ot::GraphicsCopyInformation::operator= ( const GraphicsCopyInformation & )
default

◆ operator=() [2/2]

GraphicsCopyInformation & ot::GraphicsCopyInformation::operator= ( GraphicsCopyInformation && )
default

◆ setFromJsonObject()

void ot::GraphicsCopyInformation::setFromJsonObject ( const ot::ConstJsonObject & _object)
overridevirtual

Set the object contents from the provided JSON object.

Parameters
_objectThe JSON object containing the information.
Exceptions
Maythrow an exception if the provided object is not valid (members missing or invalid types).

Reimplemented from ot::CopyInformation.

◆ setItemInformation()

void ot::GraphicsCopyInformation::setItemInformation ( const std::list< ItemInformation > & _info)
inline

◆ setViewName()

void ot::GraphicsCopyInformation::setViewName ( const std::string & _name)
inline

◆ setViewOwner()

void ot::GraphicsCopyInformation::setViewOwner ( const BasicServiceInformation & _owner)
inline

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