lintel 0.2.0
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Friends | List of all members
lintel::PropertyBase Class Referenceabstract

#include <PropertyBase.h>

Inheritance diagram for lintel::PropertyBase:
lintel::Property< T >

Public Member Functions

 PropertyBase ()=delete
 
virtual ~PropertyBase ()=default
 
virtual std::string toString ()=0
 
virtual std::string getType () const =0
 
const std::string & getName () const
 
const std::string & getInstanceName () const
 
const DataStorage & getDataStorage () const
 
void setDataStorage (const DataStorage &newDataStorage)
 
const std::string & getClassName () const
 
const std::string & getProcessName () const
 
bool isRuntimeChange () const
 
const std::string & getDescription () const
 
const std::string & getIdentifier () const
 
virtual void setValueString (const std::string &value)=0
 
 operator std::string ()
 
bool operator< (const PropertyBase &rhs) const
 

Protected Member Functions

 PropertyBase (std::string name, std::string instanceName, std::string className, std::string processName, std::string description, bool runtimeChange)
 

Friends

std::ostream & operator<< (std::ostream &os, PropertyBase &base)
 

Detailed Description

Abstract base class for all property types

Constructor & Destructor Documentation

◆ PropertyBase() [1/2]

lintel::PropertyBase::PropertyBase ( std::string  name,
std::string  instanceName,
std::string  className,
std::string  processName,
std::string  description,
bool  runtimeChange 
)
inlineprotected
Parameters
nameproperty name
instanceNameinstance name
classNameclass name
processNameprocess name
descriptionproperty description
runtimeChangewhether runtime changes are supported

◆ PropertyBase() [2/2]

lintel::PropertyBase::PropertyBase ( )
delete

◆ ~PropertyBase()

virtual lintel::PropertyBase::~PropertyBase ( )
virtualdefault

Member Function Documentation

◆ getClassName()

const std::string & lintel::PropertyBase::getClassName ( ) const
inline
Returns
class name

◆ getDataStorage()

const DataStorage & lintel::PropertyBase::getDataStorage ( ) const
inline
Returns
data storage information

◆ getDescription()

const std::string & lintel::PropertyBase::getDescription ( ) const
inline
Returns
property description

◆ getIdentifier()

const std::string & lintel::PropertyBase::getIdentifier ( ) const
inline
Returns
unique identifier: name_instanceName_className_processName

◆ getInstanceName()

const std::string & lintel::PropertyBase::getInstanceName ( ) const
inline
Returns
instance name

◆ getName()

const std::string & lintel::PropertyBase::getName ( ) const
inline
Returns
property name

◆ getProcessName()

const std::string & lintel::PropertyBase::getProcessName ( ) const
inline
Returns
process name

◆ getType()

virtual std::string lintel::PropertyBase::getType ( ) const
pure virtual
Returns
type name of the property

Implemented in lintel::Property< T >.

◆ isRuntimeChange()

bool lintel::PropertyBase::isRuntimeChange ( ) const
inline
Returns
true if runtime changes are supported

◆ operator std::string()

lintel::PropertyBase::operator std::string ( )
inline

◆ operator<()

bool lintel::PropertyBase::operator< ( const PropertyBase &  rhs) const
inline

◆ setDataStorage()

void lintel::PropertyBase::setDataStorage ( const DataStorage &  newDataStorage)
inline

Set the data storage information

◆ setValueString()

virtual void lintel::PropertyBase::setValueString ( const std::string &  value)
pure virtual

Set the value from a string representation

Implemented in lintel::Property< T >.

◆ toString()

virtual std::string lintel::PropertyBase::toString ( )
pure virtual
Returns
string representation of the property value

Implemented in lintel::Property< T >.

Friends And Related Symbol Documentation

◆ operator<<

std::ostream & operator<< ( std::ostream &  os,
PropertyBase &  base 
)
friend

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