SmartSoft Component-Developer API
Public Member Functions | List of all members
Smart::ICommunicationObject Class Referenceabstract

This is the base-class for all communication-objects. More...

#include <smartICommunicationObject.h>

Public Member Functions

virtual ~ICommunicationObject ()=default
 Default destructor. More...
 
virtual std::string getName () const =0
 The ASCII name of the communication-object. More...
 

Detailed Description

This is the base-class for all communication-objects.

At the moment, the only required API for each communication-object is to provide a method called getName(). In the future, further default methods might be introduced.

Constructor & Destructor Documentation

◆ ~ICommunicationObject()

virtual Smart::ICommunicationObject::~ICommunicationObject ( )
virtualdefault

Default destructor.

Member Function Documentation

◆ getName()

virtual std::string Smart::ICommunicationObject::getName ( ) const
pure virtual

The ASCII name of the communication-object.

The communication-object name should be a fully-qualified name including the repository-name where a communication-object is modeled. This increases uniqueness of the communication-object-name.

Returns
communication-object name as an ASCII string

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