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

#include "EntityInformation.h"

Inheritance diagram for ot::EntityInformation:
ot::BasicEntityInformation ot::Serializable

Public Member Functions

 EntityInformation ()
 
 EntityInformation (EntityBase *_entity)
 
 EntityInformation (const EntityInformation &)=default
 
virtual ~EntityInformation ()
 
EntityInformationoperator= (const EntityInformation &)=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 setEntityType (std::string _type)
 
const std::string & getEntityType (void) const
 
- Public Member Functions inherited from ot::BasicEntityInformation
 BasicEntityInformation ()
 
 BasicEntityInformation (const std::string &_entityName)
 
 BasicEntityInformation (const std::string &_entityName, UID _entityId, UID _entityVersion)
 
 BasicEntityInformation (const BasicEntityInformation &_other)
 
virtual ~BasicEntityInformation ()
 
BasicEntityInformationoperator= (const BasicEntityInformation &_other)
 
void setEntityName (const std::string &_entityName)
 
const std::string & getEntityName (void) const
 
void setEntityID (UID _entityId)
 
UID getEntityID (void) const
 
void setEntityVersion (UID _entityVersion)
 
UID getEntityVersion (void) const
 
- Public Member Functions inherited from ot::Serializable
 Serializable ()
 
virtual ~Serializable ()
 

Constructor & Destructor Documentation

◆ EntityInformation() [1/3]

ot::EntityInformation::EntityInformation ( )

◆ EntityInformation() [2/3]

ot::EntityInformation::EntityInformation ( EntityBase * _entity)

◆ EntityInformation() [3/3]

ot::EntityInformation::EntityInformation ( const EntityInformation & )
default

◆ ~EntityInformation()

ot::EntityInformation::~EntityInformation ( )
virtual

Member Function Documentation

◆ addToJsonObject()

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

◆ getEntityType()

const std::string & ot::EntityInformation::getEntityType ( void ) const
inline

◆ operator=()

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

◆ setEntityType()

void ot::EntityInformation::setEntityType ( std::string _type)
inline

◆ setFromJsonObject()

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


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