TINC
Toolkit for Interactive Computation
Public Member Functions | Public Attributes | Protected Attributes | List of all members
tinc::IdObject Class Reference

Interface to define objects for a TINC network. More...

#include <IdObject.hpp>

Inheritance diagram for tinc::IdObject:
tinc::DataPool tinc::DiskBufferAbstract tinc::ParameterSpace tinc::Processor tinc::DataPoolJson tinc::DataPoolNetCDF tinc::DiskBuffer< NetCDFData > tinc::DiskBuffer< std::string > tinc::DiskBuffer< al::Image > tinc::DiskBuffer< nlohmann::json > tinc::DiskBuffer< DataType > tinc::ProcessorAsyncWrapper tinc::ProcessorCpp tinc::ProcessorGraph tinc::ProcessorScript

Public Member Functions

std::string getId ()
 get this object's id More...
 
void setId (std::string id)
 set this object's id More...
 
std::string getDocumentation () const
 
void setDocumentation (const std::string &documentation)
 

Public Attributes

std::function< void(al::Socket *src)> modified = [](al::Socket * ) {}
 

Protected Attributes

std::string mId
 
std::string mDocumentation
 

Detailed Description

Interface to define objects for a TINC network.

All objects that can be shared over the network using TINC, must have an id, documentation and provide a function to mark them as modified.

Definition at line 50 of file IdObject.hpp.

Member Function Documentation

◆ getDocumentation()

std::string tinc::IdObject::getDocumentation ( ) const

◆ getId()

std::string tinc::IdObject::getId ( )

get this object's id

◆ setDocumentation()

void tinc::IdObject::setDocumentation ( const std::string &  documentation)

◆ setId()

void tinc::IdObject::setId ( std::string  id)

set this object's id

Member Data Documentation

◆ mDocumentation

std::string tinc::IdObject::mDocumentation
protected

Definition at line 69 of file IdObject.hpp.

◆ mId

std::string tinc::IdObject::mId
protected

Definition at line 68 of file IdObject.hpp.

◆ modified

std::function<void(al::Socket *src)> tinc::IdObject::modified = [](al::Socket * ) {}

Definition at line 65 of file IdObject.hpp.

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