SOFA API  df6198ac
Open source framework for multi-physics simuation
sofa::core::objectmodel::lifecycle::DeprecatedData Class Reference

#include <DeprecatedData.h>

Inheritance diagram for sofa::core::objectmodel::lifecycle::DeprecatedData:

Detailed Description

Placeholder for a Data<T> to indicate it is deprecated

Use case: you want to deprecated Data<bool> d_sofaIsGreat;

add DeprecatedData d_sofaIsGreatM(this, "v23.06", "v23.12", "sofaIsGreat", "")

Public Attributes

std::string m_deprecationVersion
 
std::string m_removalVersion
 
std::string m_name
 
std::string m_helptext
 
bool m_isRemoved
 

Public Member Functions

 DeprecatedData (Base *b, const std::string &deprecationVersion, const std::string &removalVersion, const std::string &name, const std::string &helptext)
 

Attribute details

◆ m_deprecationVersion

std::string sofa::core::objectmodel::lifecycle::DeprecatedData::m_deprecationVersion

◆ m_helptext

std::string sofa::core::objectmodel::lifecycle::DeprecatedData::m_helptext

◆ m_isRemoved

bool sofa::core::objectmodel::lifecycle::DeprecatedData::m_isRemoved

◆ m_name

std::string sofa::core::objectmodel::lifecycle::DeprecatedData::m_name

◆ m_removalVersion

std::string sofa::core::objectmodel::lifecycle::DeprecatedData::m_removalVersion

Constructor details

◆ DeprecatedData()

sofa::core::objectmodel::lifecycle::DeprecatedData::DeprecatedData ( Base b,
const std::string &  deprecationVersion,
const std::string &  removalVersion,
const std::string &  name,
const std::string &  helptext 
)