OpenTwin 0.1
OpenTwin
 
Loading...
Searching...
No Matches
ot::CopyInformation Class Referenceabstract

#include "CopyInformation.h"

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

Public Member Functions

 CopyInformation ()=default
 
 CopyInformation (const CopyInformation &)=default
 
 CopyInformation (CopyInformation &&)=default
 
virtual ~CopyInformation ()=default
 
CopyInformationoperator= (const CopyInformation &)=default
 
CopyInformationoperator= (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.
 
virtual std::string getCopyType (void) const =0
 
virtual int getCopyVersion (void) const =0
 
- Public Member Functions inherited from ot::Serializable
 Serializable ()
 
virtual ~Serializable ()
 

Static Public Member Functions

static std::string getCopyTypeJsonKey (void)
 
static std::string getCopyVersionJsonKey (void)
 

Constructor & Destructor Documentation

◆ CopyInformation() [1/3]

ot::CopyInformation::CopyInformation ( )
default

◆ CopyInformation() [2/3]

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

◆ CopyInformation() [3/3]

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

◆ ~CopyInformation()

virtual ot::CopyInformation::~CopyInformation ( )
virtualdefault

Member Function Documentation

◆ addToJsonObject()

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

Implements ot::Serializable.

Reimplemented in ot::GraphicsCopyInformation.

◆ getCopyType()

virtual std::string ot::CopyInformation::getCopyType ( void ) const
pure virtual

Implemented in ot::GraphicsCopyInformation.

◆ getCopyTypeJsonKey()

std::string ot::CopyInformation::getCopyTypeJsonKey ( void )
static

◆ getCopyVersion()

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

Implemented in ot::GraphicsCopyInformation.

◆ getCopyVersionJsonKey()

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

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

◆ setFromJsonObject()

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

Implements ot::Serializable.

Reimplemented in ot::GraphicsCopyInformation.


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