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

#include "CopyEntityInformation.h"

Inheritance diagram for ot::CopyEntityInformation:
ot::Serializable

Public Member Functions

 CopyEntityInformation ()
 
 CopyEntityInformation (const ConstJsonObject &_jsonObject)
 
 CopyEntityInformation (UID _uid, const std::string &_name, const std::string &_rawData=std::string())
 
 CopyEntityInformation (const CopyEntityInformation &)=default
 
 CopyEntityInformation (CopyEntityInformation &&)=default
 
 ~CopyEntityInformation ()=default
 
CopyEntityInformationoperator= (const CopyEntityInformation &)=default
 
CopyEntityInformationoperator= (CopyEntityInformation &&)=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.
 
void setUid (UID _uid)
 
UID getUid (void) const
 
void setName (const std::string &_name)
 
const std::string & getName (void) const
 
void setRawData (const std::string &_data)
 
const std::string & getRawData (void) const
 
- Public Member Functions inherited from ot::Serializable
 Serializable ()
 
virtual ~Serializable ()
 

Constructor & Destructor Documentation

◆ CopyEntityInformation() [1/5]

ot::CopyEntityInformation::CopyEntityInformation ( )

◆ CopyEntityInformation() [2/5]

ot::CopyEntityInformation::CopyEntityInformation ( const ConstJsonObject & _jsonObject)

◆ CopyEntityInformation() [3/5]

ot::CopyEntityInformation::CopyEntityInformation ( UID _uid,
const std::string & _name,
const std::string & _rawData = std::string() )

◆ CopyEntityInformation() [4/5]

ot::CopyEntityInformation::CopyEntityInformation ( const CopyEntityInformation & )
default

◆ CopyEntityInformation() [5/5]

ot::CopyEntityInformation::CopyEntityInformation ( CopyEntityInformation && )
default

◆ ~CopyEntityInformation()

ot::CopyEntityInformation::~CopyEntityInformation ( )
default

Member Function Documentation

◆ addToJsonObject()

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

◆ getName()

const std::string & ot::CopyEntityInformation::getName ( void ) const
inline

◆ getRawData()

const std::string & ot::CopyEntityInformation::getRawData ( void ) const
inline

◆ getUid()

UID ot::CopyEntityInformation::getUid ( void ) const
inline

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

◆ setFromJsonObject()

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

◆ setName()

void ot::CopyEntityInformation::setName ( const std::string & _name)
inline

◆ setRawData()

void ot::CopyEntityInformation::setRawData ( const std::string & _data)
inline

◆ setUid()

void ot::CopyEntityInformation::setUid ( UID _uid)
inline

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