openfluid::base::FunctionSignature Struct Reference

List of all members.

Public Member Functions
	FunctionSignature ()
void	setSDKVersion (FuncVersion_t Version)
Public Attributes
FuncID_t	ID
FuncName_t	Name
std::string	Description
FuncDomain_t	Domain
FuncProcess_t	Process
FuncMethod_t	Method
FuncVersion_t	Version
FuncStatus_t	Status
std::string	SDKVersion
std::string	Author
std::string	AuthorEmail
SignatureHandledData	HandledData
SignatureHandledUnitsGraph	HandledUnitsGraph

---

Detailed Description

Structure encapsulating the plugin signature, returned from the plugin to the host app for registering

---

Constructor & Destructor Documentation

openfluid::base::FunctionSignature::FunctionSignature

(

)

[inline]

---

Member Function Documentation

void openfluid::base::FunctionSignature::setSDKVersion

(

FuncVersion_t

Version

)

[inline]

---

Member Data Documentation

std::string openfluid::base::FunctionSignature::Author

Author's name

std::string openfluid::base::FunctionSignature::AuthorEmail

Author's email

std::string openfluid::base::FunctionSignature::Description

Plugin Description

FuncDomain_t openfluid::base::FunctionSignature::Domain

Plugin domain (i.e. hydrology, pop, erosion, ...)

SignatureHandledData openfluid::base::FunctionSignature::HandledData

Handled data

SignatureHandledUnitsGraph openfluid::base::FunctionSignature::HandledUnitsGraph

Handled units graph

FuncID_t openfluid::base::FunctionSignature::ID

Function ID

FuncMethod_t openfluid::base::FunctionSignature::Method

Plugin involved method (i.e. morel-seytoux, hayami, ...)

FuncName_t openfluid::base::FunctionSignature::Name

Plugin name

FuncProcess_t openfluid::base::FunctionSignature::Process

Plugin simulated process (i.e. surface rainfall-runoff production, ditch infiltration, ...)

std::string openfluid::base::FunctionSignature::SDKVersion

SDK version number used to build the function

FuncStatus_t openfluid::base::FunctionSignature::Status

Development status

FuncVersion_t openfluid::base::FunctionSignature::Version

Plug-in version number