Documentation for OpenFLUID 2.2.0
openfluid::ware::WareSignature Class Referenceabstract

#include <ware/WareSignature.hpp>

Public Types

using Person_t = std::pair< std::string, std::string >
 
using Link_t = std::pair< std::string, std::string >
 
using PeopleList_t = std::vector< Person_t >
 
using LinksList_t = std::vector< Link_t >
 
using DependenciesMap_t = std::map< std::string, std::string >
 

Public Member Functions

virtual openfluid::ware::WareType getType () const =0
 
 WareSignature ()
 
virtual ~WareSignature ()=default
 
std::vector< std::string > getTagsByType (const std::string &Type) const
 
void clear ()
 
std::string getStatusAsString () const
 
void setStatusFromString (const std::string &StatusStr)
 

Public Attributes

SignatureBuildInfo BuildInfo
 
WareID_t ID
 
WareName_t Name
 
std::string Description
 
WareVersion_t Version
 
WareStatus_t Status
 
PeopleList_t Authors
 
PeopleList_t Contacts
 
std::string License
 
std::vector< std::string > Tags
 
LinksList_t Links
 
WareIssues Issues
 
DependenciesMap_t Dependencies
 
Inheritance diagram for openfluid::ware::WareSignature:
Collaboration diagram for openfluid::ware::WareSignature:

Member Typedef Documentation

◆ DependenciesMap_t

using openfluid::ware::WareSignature::DependenciesMap_t = std::map<std::string, std::string>

◆ Link_t

using openfluid::ware::WareSignature::Link_t = std::pair<std::string,std::string>

◆ LinksList_t

◆ PeopleList_t

◆ Person_t

using openfluid::ware::WareSignature::Person_t = std::pair<std::string,std::string>

Constructor & Destructor Documentation

◆ WareSignature()

openfluid::ware::WareSignature::WareSignature ( )
inline

◆ ~WareSignature()

virtual openfluid::ware::WareSignature::~WareSignature ( )
virtualdefault

Member Function Documentation

◆ clear()

void openfluid::ware::WareSignature::clear ( )
inline

◆ getStatusAsString()

std::string openfluid::ware::WareSignature::getStatusAsString ( ) const
inline

◆ getTagsByType()

std::vector<std::string> openfluid::ware::WareSignature::getTagsByType ( const std::string &  Type) const
inline

◆ getType()

◆ setStatusFromString()

void openfluid::ware::WareSignature::setStatusFromString ( const std::string &  StatusStr)
inline

Member Data Documentation

◆ Authors

PeopleList_t openfluid::ware::WareSignature::Authors

Authors as a list of pairs [name,email]

◆ BuildInfo

SignatureBuildInfo openfluid::ware::WareSignature::BuildInfo

Information about build context

◆ Contacts

PeopleList_t openfluid::ware::WareSignature::Contacts

Contacts as a list of pairs [name,email]

◆ Dependencies

DependenciesMap_t openfluid::ware::WareSignature::Dependencies

Dependencies

◆ Description

std::string openfluid::ware::WareSignature::Description

◆ ID

WareID_t openfluid::ware::WareSignature::ID

◆ Issues

WareIssues openfluid::ware::WareSignature::Issues

Issues

◆ License

std::string openfluid::ware::WareSignature::License

SPDX code for software license

◆ Links

LinksList_t openfluid::ware::WareSignature::Links

List of links

◆ Name

WareName_t openfluid::ware::WareSignature::Name

◆ Status

WareStatus_t openfluid::ware::WareSignature::Status

Development status

◆ Tags

std::vector<std::string> openfluid::ware::WareSignature::Tags

List of tags

◆ Version

WareVersion_t openfluid::ware::WareSignature::Version

Version string


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