DocStrings.cmake

#
# CMake build for PyOpenFLUID
#
# Author : Bastien VAYSSE <bastien.vaysse@supagro.inra.fr>
#

##
# Advises:
#  ';' must be escaped (like '\;')
#

# ======== model ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_MODEL "") # string in a single line [<=> title]
SET(DOCSTRINGRAW_LONG_DESCRIPTION_MODEL "") # a list of string multi-lines
SET(DOCSTRINGRAW_RETURN_MODEL "") # a string in a single line (preferred)
SET(DOCSTRINGRAW_PARAMETERS_MODEL) # a list of string in a single line (preferred)
# following this model '<<param name>> -- <<description/infos>>'
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_MODEL) # same as parameter
SET(DOCSTRINGRAW_EXCEPTIONS_MODEL) # same as parameter
# write 'PyOpenFLUIDError' to show PyOpenFLUID exception
SET(DOCSTRINGRAW_EXAMPLES_MODEL "") # a string, representing python interpreter


# ======== constructor ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_CONSTRUCTOR "Create an OpenFLUID class.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_CONSTRUCTOR "")
SET(DOCSTRINGRAW_RETURN_CONSTRUCTOR "")
SET(DOCSTRINGRAW_PARAMETERS_CONSTRUCTOR)
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_CONSTRUCTOR)
SET(DOCSTRINGRAW_EXCEPTIONS_CONSTRUCTOR
    "PyOpenFLUIDError  -- from OpenFLUID framework, or unknown error"
    "MemoryError       -- if there's no enough memory")
SET(DOCSTRINGRAW_EXAMPLES_CONSTRUCTOR "")


# ======== getVersion ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_GETVERSION "Return a description of the class.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_GETVERSION "")
SET(DOCSTRINGRAW_RETURN_GETVERSION "A string representation of the class.")
SET(DOCSTRINGRAW_PARAMETERS_GETVERSION)
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_GETVERSION)
SET(DOCSTRINGRAW_EXCEPTIONS_GETVERSION)
SET(DOCSTRINGRAW_EXAMPLES_GETVERSION
">>> obj = PyOpenFLUID()
>>> info = str(obj)")


# ======== addExtraSimulatorsPaths ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_ADDEXTRASIMULATORSPATHS
    "Adds paths to search for simulation simulators.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_ADDEXTRASIMULATORSPATHS "")
SET(DOCSTRINGRAW_RETURN_ADDEXTRASIMULATORSPATHS "")
SET(DOCSTRINGRAW_PARAMETERS_ADDEXTRASIMULATORSPATHS
    "Paths  -- the semicolon separated paths to add")
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_ADDEXTRASIMULATORSPATHS)
SET(DOCSTRINGRAW_EXCEPTIONS_ADDEXTRASIMULATORSPATHS)
SET(DOCSTRINGRAW_EXAMPLES_ADDEXTRASIMULATORSPATHS "")


# ======== resetExtraSimulatorsPaths ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_RESETEXTRASIMULATORSPATHS
    "Reset paths to search for simulation simulators.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_RESETEXTRASIMULATORSPATHS
    "Delete all simulators paths in the class.")
SET(DOCSTRINGRAW_RETURN_RESETEXTRASIMULATORSPATHS "")
SET(DOCSTRINGRAW_PARAMETERS_RESETEXTRASIMULATORSPATHS)
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_RESETEXTRASIMULATORSPATHS)
SET(DOCSTRINGRAW_EXCEPTIONS_RESETEXTRASIMULATORSPATHS)
SET(DOCSTRINGRAW_EXAMPLES_RESETEXTRASIMULATORSPATHS "")


# ======== getExtraSimulatorsPaths ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_GETEXTRASIMULATORSPATHS
    "Returns the added paths to search for simulation simulators.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_GETEXTRASIMULATORSPATHS "")
SET(DOCSTRINGRAW_RETURN_GETEXTRASIMULATORSPATHS "a list of Paths")
SET(DOCSTRINGRAW_PARAMETERS_GETEXTRASIMULATORSPATHS)
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_GETEXTRASIMULATORSPATHS)
SET(DOCSTRINGRAW_EXCEPTIONS_GETEXTRASIMULATORSPATHS)
SET(DOCSTRINGRAW_EXAMPLES_GETEXTRASIMULATORSPATHS "")


# ======== addExtraObserversPaths ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_ADDEXTRAOBSERVERSPATHS
    "Adds paths to search for observers.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_ADDEXTRAOBSERVERSPATHS "")
SET(DOCSTRINGRAW_RETURN_ADDEXTRAOBSERVERSPATHS "")
SET(DOCSTRINGRAW_PARAMETERS_ADDEXTRAOBSERVERSPATHS
    "Paths  -- the semicolon separated paths to add")
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_ADDEXTRAOBSERVERSPATHS)
SET(DOCSTRINGRAW_EXCEPTIONS_ADDEXTRAOBSERVERSPATHS)
SET(DOCSTRINGRAW_EXAMPLES_ADDEXTRAOBSERVERSPATHS "")


# ======== resetExtraObserversPaths ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_RESETEXTRAOBSERVERSPATHS
    "Reset paths to search for observers.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_RESETEXTRAOBSERVERSPATHS
    "Delete all observers paths in the class.")
SET(DOCSTRINGRAW_RETURN_RESETEXTRAOBSERVERSPATHS "")
SET(DOCSTRINGRAW_PARAMETERS_RESETEXTRAOBSERVERSPATHS)
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_RESETEXTRAOBSERVERSPATHS)
SET(DOCSTRINGRAW_EXCEPTIONS_RESETEXTRAOBSERVERSPATHS)
SET(DOCSTRINGRAW_EXAMPLES_RESETEXTRAOBSERVERSPATHS "")


# ======== getExtraObserversPaths ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_GETEXTRAOBSERVERSPATHS
    "Returns the added paths to search for observers.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_GETEXTRAOBSERVERSPATHS "")
SET(DOCSTRINGRAW_RETURN_GETEXTRAOBSERVERSPATHS "a list of Paths")
SET(DOCSTRINGRAW_PARAMETERS_GETEXTRAOBSERVERSPATHS)
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_GETEXTRAOBSERVERSPATHS)
SET(DOCSTRINGRAW_EXCEPTIONS_GETEXTRAOBSERVERSPATHS)
SET(DOCSTRINGRAW_EXAMPLES_GETEXTRAOBSERVERSPATHS "")


# ======== printSimulationInfo ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_PRINTSIMULATIONINFO
    "Prints informations to screen about simulation.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_PRINTSIMULATIONINFO
"Prints infos on almost every informations: spatial domain, generators,
 simulation items (like simulators), period, time step, ...")
SET(DOCSTRINGRAW_RETURN_PRINTSIMULATIONINFO "")
SET(DOCSTRINGRAW_PARAMETERS_PRINTSIMULATIONINFO)
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_PRINTSIMULATIONINFO)
SET(DOCSTRINGRAW_EXCEPTIONS_PRINTSIMULATIONINFO)
SET(DOCSTRINGRAW_EXAMPLES_PRINTSIMULATIONINFO "")


# ======== getSimulatorParam ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_GETSIMULATORPARAM
    "Returns a simulator parameter value.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_GETSIMULATORPARAM "")
SET(DOCSTRINGRAW_RETURN_GETSIMULATORPARAM "the parameter value")
SET(DOCSTRINGRAW_PARAMETERS_GETSIMULATORPARAM
    "FunID      -- the simulation simulator id"
    "ParamName  -- the name of the parameter")
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_GETSIMULATORPARAM)
SET(DOCSTRINGRAW_EXCEPTIONS_GETSIMULATORPARAM)
SET(DOCSTRINGRAW_EXAMPLES_GETSIMULATORPARAM "")


# ======== setSimulatorParam ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_SETSIMULATORPARAM
    "Sets a simulator parameter value.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_SETSIMULATORPARAM "")
SET(DOCSTRINGRAW_RETURN_SETSIMULATORPARAM "")
SET(DOCSTRINGRAW_PARAMETERS_SETSIMULATORPARAM
    "FunID        -- the simulation simulator id"
    "ParamName    -- the name of the parameter"
    "ParamValue   -- the parameter value")
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_SETSIMULATORPARAM)
SET(DOCSTRINGRAW_EXCEPTIONS_SETSIMULATORPARAM
    "PyOpenFLUIDError    -- if simulator id doesn't exist")
SET(DOCSTRINGRAW_EXAMPLES_SETSIMULATORPARAM "")


# ======== removeSimulatorParam ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_REMOVESIMULATORPARAM
    "Removes a simulator parameter.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_REMOVESIMULATORPARAM "")
SET(DOCSTRINGRAW_RETURN_REMOVESIMULATORPARAM "")
SET(DOCSTRINGRAW_PARAMETERS_REMOVESIMULATORPARAM
    "FunID      -- the simulation simulator id"
    "ParamName  -- the name of the parameter")
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_REMOVESIMULATORPARAM)
SET(DOCSTRINGRAW_EXCEPTIONS_REMOVESIMULATORPARAM
    "PyOpenFLUIDError    -- if simulator id doesn't exist")
SET(DOCSTRINGRAW_EXAMPLES_REMOVESIMULATORPARAM "")


# ======== getSimulatorParams ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_GETSIMULATORPARAMS
    "Removes all simulators parameters.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_GETSIMULATORPARAMS "")
SET(DOCSTRINGRAW_RETURN_GETSIMULATORPARAMS "a list of parameter")
SET(DOCSTRINGRAW_PARAMETERS_GETSIMULATORPARAMS
    "FunID      -- the simulation simulator id")
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_GETSIMULATORPARAMS)
SET(DOCSTRINGRAW_EXCEPTIONS_GETSIMULATORPARAMS)
SET(DOCSTRINGRAW_EXAMPLES_GETSIMULATORPARAMS "")


# ======== getGeneratorParam ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_GETGENERATORPARAM
    "Returns a generator parameter value.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_GETGENERATORPARAM "")
SET(DOCSTRINGRAW_RETURN_GETGENERATORPARAM "the parameter value")
SET(DOCSTRINGRAW_PARAMETERS_GETGENERATORPARAM
    "UnitClass  -- the unit class to which the generator is applied"
    "VarName    -- the variable name to which the generator is applied"
    "ParamName  -- the name of the parameter")
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_GETGENERATORPARAM)
SET(DOCSTRINGRAW_EXCEPTIONS_GETGENERATORPARAM)
SET(DOCSTRINGRAW_EXAMPLES_GETGENERATORPARAM "")


# ======== setGeneratorParam ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_SETGENERATORPARAM
    "Sets a generator parameter value.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_SETGENERATORPARAM "")
SET(DOCSTRINGRAW_RETURN_SETGENERATORPARAM "")
SET(DOCSTRINGRAW_PARAMETERS_SETGENERATORPARAM
    "UnitClass   -- the unit class to which the generator is applied"
    "VarName     -- the variable name to which the generator is applied"
    "ParamName   -- the name of the parameter"
    "ParamValue  -- the parameter value")
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_SETGENERATORPARAM)
SET(DOCSTRINGRAW_EXCEPTIONS_SETGENERATORPARAM
    "PyOpenFLUIDError    -- if generator doesn't exist")
SET(DOCSTRINGRAW_EXAMPLES_SETGENERATORPARAM "")


# ======== getModelGlobalParam ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_GETMODELGLOBALPARAM
    "Returns a model global parameter value.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_GETMODELGLOBALPARAM "")
SET(DOCSTRINGRAW_RETURN_GETMODELGLOBALPARAM "the parameter value")
SET(DOCSTRINGRAW_PARAMETERS_GETMODELGLOBALPARAM
    "ParamName  -- the name of the parameter")
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_GETMODELGLOBALPARAM)
SET(DOCSTRINGRAW_EXCEPTIONS_GETMODELGLOBALPARAM)
SET(DOCSTRINGRAW_EXAMPLES_GETMODELGLOBALPARAM "")


# ======== setModelGlobalParam ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_SETMODELGLOBALPARAM
    "Sets a model global parameter value.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_SETMODELGLOBALPARAM
    "If the parameter doesn't exist, it creates it, but if it is already set,
 it changes the value.")
SET(DOCSTRINGRAW_RETURN_SETMODELGLOBALPARAM)
SET(DOCSTRINGRAW_PARAMETERS_SETMODELGLOBALPARAM
    "ParamName  -- the name of the parameter"
    "ParamValue  -- the parameter value")
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_SETMODELGLOBALPARAM)
SET(DOCSTRINGRAW_EXCEPTIONS_SETMODELGLOBALPARAM)
SET(DOCSTRINGRAW_EXAMPLES_SETMODELGLOBALPARAM "")


# ======== removeModelGlobalParam ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_REMOVEMODELGLOBALPARAM
    "Returns all model global parameters.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_REMOVEMODELGLOBALPARAM "")
SET(DOCSTRINGRAW_RETURN_REMOVEMODELGLOBALPARAM )
SET(DOCSTRINGRAW_PARAMETERS_REMOVEMODELGLOBALPARAM
    "ParamName  -- the name of the parameter")
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_REMOVEMODELGLOBALPARAM)
SET(DOCSTRINGRAW_EXCEPTIONS_REMOVEMODELGLOBALPARAM)
SET(DOCSTRINGRAW_EXAMPLES_REMOVEMODELGLOBALPARAM "")


# ======== getModelGlobalParams ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_GETMODELGLOBALPARAMS
    "Returns all model global parameters.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_GETMODELGLOBALPARAMS "")
SET(DOCSTRINGRAW_RETURN_GETMODELGLOBALPARAMS "a list of parameter name")
SET(DOCSTRINGRAW_PARAMETERS_GETMODELGLOBALPARAMS)
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_GETMODELGLOBALPARAMS)
SET(DOCSTRINGRAW_EXCEPTIONS_GETMODELGLOBALPARAMS)
SET(DOCSTRINGRAW_EXAMPLES_GETMODELGLOBALPARAMS "")


# ======== addSimulator ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_ADDSIMULATOR
    "Adds a simulator.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_ADDSIMULATOR
    "Warnings: make sure the simulator exists in simulators paths, or adds the
 path of the simulator later.")
SET(DOCSTRINGRAW_RETURN_ADDSIMULATOR "")
SET(DOCSTRINGRAW_PARAMETERS_ADDSIMULATOR
    "SimID   -- the simulation simulator id")
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_ADDSIMULATOR)
SET(DOCSTRINGRAW_EXCEPTIONS_ADDSIMULATOR)
SET(DOCSTRINGRAW_EXAMPLES_ADDSIMULATOR "")


# ======== removeSimulator ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_REMOVESIMULATOR
    "Removes a simulator.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_REMOVESIMULATOR "")
SET(DOCSTRINGRAW_RETURN_REMOVESIMULATOR "")
SET(DOCSTRINGRAW_PARAMETERS_REMOVESIMULATOR
    "SimID   -- the simulation simulator id")
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_REMOVESIMULATOR)
SET(DOCSTRINGRAW_EXCEPTIONS_REMOVESIMULATOR
    "PyOpenFLUIDError    -- if simulator id doesn't exist")
SET(DOCSTRINGRAW_EXAMPLES_REMOVESIMULATOR "")


# ======== clearModel ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_CLEARMODEL
    "Removes all simulators.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_CLEARMODEL "")
SET(DOCSTRINGRAW_RETURN_CLEARMODEL "")
SET(DOCSTRINGRAW_PARAMETERS_CLEARMODEL)
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_CLEARMODEL)
SET(DOCSTRINGRAW_EXCEPTIONS_CLEARMODEL)
SET(DOCSTRINGRAW_EXAMPLES_CLEARMODEL "")


# ======== getSimulatorsInModel ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_GETSIMULATORSINMODEL
    "Gets all simulators names.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_GETSIMULATORSINMODEL "")
SET(DOCSTRINGRAW_RETURN_GETSIMULATORSINMODEL "a list of simulator name")
SET(DOCSTRINGRAW_PARAMETERS_GETSIMULATORSINMODEL)
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_GETSIMULATORSINMODEL)
SET(DOCSTRINGRAW_EXCEPTIONS_GETSIMULATORSINMODEL)
SET(DOCSTRINGRAW_EXAMPLES_GETSIMULATORSINMODEL "")


# ======== getObserverParam ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_GETOBSERVERPARAM
    "Returns an observer parameter value.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_GETOBSERVERPARAM "")
SET(DOCSTRINGRAW_RETURN_GETOBSERVERPARAM "the parameter value")
SET(DOCSTRINGRAW_PARAMETERS_GETOBSERVERPARAM
    "ObsID      -- the observer id"
    "ParamName  -- the name of the parameter")
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_GETOBSERVERPARAM)
SET(DOCSTRINGRAW_EXCEPTIONS_GETOBSERVERPARAM)
SET(DOCSTRINGRAW_EXAMPLES_GETOBSERVERPARAM "")


# ======== setObserverParam ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_SETOBSERVERPARAM
    "Sets an observer parameter value.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_SETOBSERVERPARAM "")
SET(DOCSTRINGRAW_RETURN_SETOBSERVERPARAM "")
SET(DOCSTRINGRAW_PARAMETERS_SETOBSERVERPARAM
    "ObsID       -- the observer id"
    "ParamName   -- the name of the parameter"
    "ParamValue  -- the parameter value")
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_SETOBSERVERPARAM)
SET(DOCSTRINGRAW_EXCEPTIONS_SETOBSERVERPARAM
    "PyOpenFLUIDError  -- if the observer is not in monitoring")
SET(DOCSTRINGRAW_EXAMPLES_SETOBSERVERPARAM "")


# ======== removeObserverParam ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_REMOVEOBSERVERPARAM
    "Sets an observer parameter value.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_REMOVEOBSERVERPARAM "")
SET(DOCSTRINGRAW_RETURN_REMOVEOBSERVERPARAM "")
SET(DOCSTRINGRAW_PARAMETERS_REMOVEOBSERVERPARAM
    "ObsID      -- the observer id"
    "ParamName  -- the name of the parameter")
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_REMOVEOBSERVERPARAM)
SET(DOCSTRINGRAW_EXCEPTIONS_REMOVEOBSERVERPARAM
    "PyOpenFLUIDError  -- if the observer is not in monitoring")
SET(DOCSTRINGRAW_EXAMPLES_REMOVEOBSERVERPARAM "")


# ======== getObserverParams ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_GETOBSERVERPARAMS
    "Gets all observer parameters name.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_GETOBSERVERPARAMS "")
SET(DOCSTRINGRAW_RETURN_GETOBSERVERPARAMS "a list of observer parameters name")
SET(DOCSTRINGRAW_PARAMETERS_GETOBSERVERPARAMS
    "ObsID      -- the observer id")
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_GETOBSERVERPARAMS)
SET(DOCSTRINGRAW_EXCEPTIONS_GETOBSERVERPARAMS)
SET(DOCSTRINGRAW_EXAMPLES_GETOBSERVERPARAMS "")


# ======== addObserver ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_ADDOBSERVER
    "Adds an observer.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_ADDOBSERVER
    "Warnings: make sure the observer exists in observers paths, or adds the
 path of the observer later.")
SET(DOCSTRINGRAW_RETURN_ADDOBSERVER "")
SET(DOCSTRINGRAW_PARAMETERS_ADDOBSERVER
    "ObsID      -- the observer id")
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_ADDOBSERVER)
SET(DOCSTRINGRAW_EXCEPTIONS_ADDOBSERVER
    "PyOpenFLUIDError  -- if the observer exists")
SET(DOCSTRINGRAW_EXAMPLES_ADDOBSERVER "")


# ======== removeObserver ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_REMOVEOBSERVER
    "Removes an observer.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_REMOVEOBSERVER "")
SET(DOCSTRINGRAW_RETURN_REMOVEOBSERVER "")
SET(DOCSTRINGRAW_PARAMETERS_REMOVEOBSERVER
    "ObsID      -- the observer id")
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_REMOVEOBSERVER)
SET(DOCSTRINGRAW_EXCEPTIONS_REMOVEOBSERVER
    "PyOpenFLUIDError  -- if the observer doesn't exist")
SET(DOCSTRINGRAW_EXAMPLES_REMOVEOBSERVER "")


# ======== clearMonitoring ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_CLEARMONITORING
    "Removes all observers.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_CLEARMONITORING "")
SET(DOCSTRINGRAW_RETURN_CLEARMONITORING "")
SET(DOCSTRINGRAW_PARAMETERS_CLEARMONITORING)
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_CLEARMONITORING)
SET(DOCSTRINGRAW_EXCEPTIONS_CLEARMONITORING)
SET(DOCSTRINGRAW_EXAMPLES_CLEARMONITORING "")


# ======== getObserversInMonitoring ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_GETOBSERVERSINMONITORING
    "Gets all observer name.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_GETOBSERVERSINMONITORING "")
SET(DOCSTRINGRAW_RETURN_GETOBSERVERSINMONITORING "a list of observer name")
SET(DOCSTRINGRAW_PARAMETERS_GETOBSERVERSINMONITORING)
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_GETOBSERVERSINMONITORING)
SET(DOCSTRINGRAW_EXCEPTIONS_GETOBSERVERSINMONITORING)
SET(DOCSTRINGRAW_EXAMPLES_GETOBSERVERSINMONITORING "")


# ======== getUnitsClasses ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_GETUNITSCLASSES
    "Returns the existing units classes.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_GETUNITSCLASSES "")
SET(DOCSTRINGRAW_RETURN_GETUNITSCLASSES "a list of units classes")
SET(DOCSTRINGRAW_PARAMETERS_GETUNITSCLASSES)
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_GETUNITSCLASSES)
SET(DOCSTRINGRAW_EXCEPTIONS_GETUNITSCLASSES)
SET(DOCSTRINGRAW_EXAMPLES_GETUNITSCLASSES "")


# ======== getUnitsIDs ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_GETUNITSIDS
    "Returns the existing units IDs for a given units class.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_GETUNITSIDS "")
SET(DOCSTRINGRAW_RETURN_GETUNITSIDS "a list of units IDs")
SET(DOCSTRINGRAW_PARAMETERS_GETUNITSIDS
    "UnitClass  -- the unit class")
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_GETUNITSIDS)
SET(DOCSTRINGRAW_EXCEPTIONS_GETUNITSIDS)
SET(DOCSTRINGRAW_EXAMPLES_GETUNITSIDS "")


# ======== addUnit ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_ADDUNIT
    "Adds an new unit.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_ADDUNIT "")
SET(DOCSTRINGRAW_RETURN_ADDUNIT "")
SET(DOCSTRINGRAW_PARAMETERS_ADDUNIT
    "UnitClass  -- an unit class"
    "UnitID     -- an new unit id for this unit class"
    "PcsOrder   -- a process order")
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_ADDUNIT)
SET(DOCSTRINGRAW_EXCEPTIONS_ADDUNIT
    "PyOpenFLUIDError   -- if the unit exists")
SET(DOCSTRINGRAW_EXAMPLES_ADDUNIT "")


# ======== removeUnit ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_REMOVEUNIT
    "Removes an unit.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_REMOVEUNIT "")
SET(DOCSTRINGRAW_RETURN_REMOVEUNIT "")
SET(DOCSTRINGRAW_PARAMETERS_REMOVEUNIT
    "UnitClass  -- an unit class"
    "UnitID     -- an unit id for this unit class")
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_REMOVEUNIT)
SET(DOCSTRINGRAW_EXCEPTIONS_REMOVEUNIT
    "PyOpenFLUIDError   -- if the unit doesn't exists")
SET(DOCSTRINGRAW_EXAMPLES_REMOVEUNIT "")


# ======== clearAllUnits ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_CLEARALLUNITS
    "Removes all units from an unit class or all units in the domain.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_CLEARALLUNITS "")
SET(DOCSTRINGRAW_RETURN_CLEARALLUNITS "")
SET(DOCSTRINGRAW_PARAMETERS_CLEARALLUNITS)
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_CLEARALLUNITS
    "UnitClass  -- an unit class")
SET(DOCSTRINGRAW_EXCEPTIONS_CLEARALLUNITS)
SET(DOCSTRINGRAW_EXAMPLES_CLEARALLUNITS "")


# ======== setProcessOrder ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_SETPROCESSORDER
    "Sets the process order of an unit.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_SETPROCESSORDER "")
SET(DOCSTRINGRAW_RETURN_SETPROCESSORDER "")
SET(DOCSTRINGRAW_PARAMETERS_SETPROCESSORDER
    "UnitClass  -- an unit class"
    "UnitID     -- an unit id for this unit class"
    "PcsOrder   -- a process order")
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_SETPROCESSORDER)
SET(DOCSTRINGRAW_EXCEPTIONS_SETPROCESSORDER
    "PyOpenFLUIDError   -- if the unit doesn't exists")
SET(DOCSTRINGRAW_EXAMPLES_SETPROCESSORDER "")


# ======== getProcessOrder ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_GETPROCESSORDER
    "Gets the process order of an unit.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_GETPROCESSORDER "")
SET(DOCSTRINGRAW_RETURN_GETPROCESSORDER "the process order")
SET(DOCSTRINGRAW_PARAMETERS_GETPROCESSORDER
    "UnitClass  -- an unit class"
    "UnitID     -- an unit id for this unit class")
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_GETPROCESSORDER)
SET(DOCSTRINGRAW_EXCEPTIONS_GETPROCESSORDER)
SET(DOCSTRINGRAW_EXAMPLES_GETPROCESSORDER "")


# ======== getChildren ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_GETUNITCHILDREN
    "Gets children units of an unit.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_GETUNITCHILDREN "")
SET(DOCSTRINGRAW_RETURN_GETUNITCHILDREN
    "a list of tuple of units classes and units")
SET(DOCSTRINGRAW_PARAMETERS_GETUNITCHILDREN
    "UnitClass  -- an unit class"
    "UnitID     -- an unit id for this unit class")
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_GETUNITCHILDREN)
SET(DOCSTRINGRAW_EXCEPTIONS_GETUNITCHILDREN)
SET(DOCSTRINGRAW_EXAMPLES_GETUNITCHILDREN "")


# ======== getUnitParents ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_GETUNITPARENTS
    "Gets parents units of an unit.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_GETUNITPARENTS "")
SET(DOCSTRINGRAW_RETURN_GETUNITPARENTS
    "a list of tuple of units classes and units")
SET(DOCSTRINGRAW_PARAMETERS_GETUNITPARENTS
    "UnitClass  -- an unit class"
    "UnitID     -- an unit id for this unit class")
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_GETUNITPARENTS)
SET(DOCSTRINGRAW_EXCEPTIONS_GETUNITPARENTS)
SET(DOCSTRINGRAW_EXAMPLES_GETUNITPARENTS "")


# ======== addParentChildConnection ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_ADDPARENTCHILDCONNECTION
    "Adds a child on an unit.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_ADDPARENTCHILDCONNECTION
    "Creates a relation parent/child from the first unit given to the second.")
SET(DOCSTRINGRAW_RETURN_ADDPARENTCHILDCONNECTION "")
SET(DOCSTRINGRAW_PARAMETERS_ADDPARENTCHILDCONNECTION
    "UnitClassParent  -- an unit class (parent)"
    "UnitIDParent     -- an unit id (parent)"
    "UnitClassChild   -- an unit class (child)"
    "UnitIDChild      -- an unit id (child)")
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_ADDPARENTCHILDCONNECTION)
SET(DOCSTRINGRAW_EXCEPTIONS_ADDPARENTCHILDCONNECTION
    "PyOpenFLUIDError  -- if one of the unit or both units don't exist")
SET(DOCSTRINGRAW_EXAMPLES_ADDPARENTCHILDCONNECTION "")


# ======== removeParentChildConnection ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_REMOVEPARENTCHILDCONNECTION
    "Removes a child on an unit.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_REMOVEPARENTCHILDCONNECTION "")
SET(DOCSTRINGRAW_RETURN_REMOVEPARENTCHILDCONNECTION "")
SET(DOCSTRINGRAW_PARAMETERS_REMOVEPARENTCHILDCONNECTION
    "UnitClassParent  -- an unit class (parent)"
    "UnitIDParent     -- an unit id (parent)"
    "UnitClassChild   -- an unit class (child)"
    "UnitIDChild      -- an unit id (child)")
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_REMOVEPARENTCHILDCONNECTION)
SET(DOCSTRINGRAW_EXCEPTIONS_REMOVEPARENTCHILDCONNECTION
    "PyOpenFLUIDError  -- if one of the unit or both units don't exist")
SET(DOCSTRINGRAW_EXAMPLES_REMOVEPARENTCHILDCONNECTION "")


# ======== getUnitTos ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_GETUNITTOS
    "Gets tos units of an unit.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_GETUNITTOS "")
SET(DOCSTRINGRAW_RETURN_GETUNITTOS
    "a list of tuple of units classes and units")
SET(DOCSTRINGRAW_PARAMETERS_GETUNITTOS
    "UnitClass  -- an unit class"
    "UnitID     -- an unit id for this unit class")
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_GETUNITTOS)
SET(DOCSTRINGRAW_EXCEPTIONS_GETUNITTOS)
SET(DOCSTRINGRAW_EXAMPLES_GETUNITTOS "")


# ======== getUnitFroms ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_GETUNITFROMS
    "Gets froms units of an unit.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_GETUNITFROMS "")
SET(DOCSTRINGRAW_RETURN_GETUNITFROMS
    "a list of tuple of units classes and units")
SET(DOCSTRINGRAW_PARAMETERS_GETUNITFROMS
    "UnitClass  -- an unit class"
    "UnitID     -- an unit id for this unit class")
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_GETUNITFROMS)
SET(DOCSTRINGRAW_EXCEPTIONS_GETUNITFROMS)
SET(DOCSTRINGRAW_EXAMPLES_GETUNITFROMS "")


# ======== addFromToConnection ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_ADDFROMTOCONNECTION
    "Adds a from/to connection.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_ADDFROMTOCONNECTION
    "Creates a relation from/to from the first unit given to the second.")
SET(DOCSTRINGRAW_RETURN_ADDFROMTOCONNECTION "")
SET(DOCSTRINGRAW_PARAMETERS_ADDFROMTOCONNECTION
    "UnitClassFrom  -- an unit class (from)"
    "UnitIDFrom     -- an unit id (from)"
    "UnitClassTo    -- an unit class (child)"
    "UnitIDTo       -- an unit id (to)")
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_ADDFROMTOCONNECTION)
SET(DOCSTRINGRAW_EXCEPTIONS_ADDFROMTOCONNECTION
    "PyOpenFLUIDError -- if one of the unit or both units don't exist")
SET(DOCSTRINGRAW_EXAMPLES_ADDFROMTOCONNECTION "")


# ======== removeFromToConnection ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_REMOVEFROMTOCONNECTION
    "Removes a from/to connection.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_REMOVEFROMTOCONNECTION "")
SET(DOCSTRINGRAW_RETURN_REMOVEFROMTOCONNECTION "")
SET(DOCSTRINGRAW_PARAMETERS_REMOVEFROMTOCONNECTION
    "UnitClassFrom  -- an unit class (from)"
    "UnitIDFrom     -- an unit id (from)"
    "UnitClassTo    -- an unit class (to)"
    "UnitIDTo       -- an unit id (to)")
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_REMOVEFROMTOCONNECTION)
SET(DOCSTRINGRAW_EXCEPTIONS_REMOVEFROMTOCONNECTION
    "PyOpenFLUIDError  -- if one of the unit or both units don't exist")
SET(DOCSTRINGRAW_EXAMPLES_REMOVEFROMTOCONNECTION "")


# ======== createAttribute ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_CREATEATTRIBUTE
    "Creates an attribute for all spatial units of a class, initialized with a default value.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_CREATEATTRIBUTE "")
SET(DOCSTRINGRAW_RETURN_CREATEATTRIBUTE "")
SET(DOCSTRINGRAW_PARAMETERS_CREATEATTRIBUTE
    "UnitClass  -- the unit class"
    "AttrName  -- the attribute name"
    "AttrVal   -- the default attribute value for all units")
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_CREATEATTRIBUTE)
SET(DOCSTRINGRAW_EXCEPTIONS_CREATEATTRIBUTE
    "PyOpenFLUIDError  -- if unit class doesn't exist, or if the pair unit class and attr name exists")
SET(DOCSTRINGRAW_EXAMPLES_CREATEATTRIBUTE "")


# ======== getAttribute ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_GETATTRIBUTE
    "Returns an attribute value for a given spatial unit.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_GETATTRIBUTE "")
SET(DOCSTRINGRAW_RETURN_GETATTRIBUTE "the attribute value")
SET(DOCSTRINGRAW_PARAMETERS_GETATTRIBUTE
    "UnitClass  -- the unit class"
    "UnitID     -- the unit"
    "AttrName  -- the name of the attribute")
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_GETATTRIBUTE)
SET(DOCSTRINGRAW_EXCEPTIONS_GETATTRIBUTE)
SET(DOCSTRINGRAW_EXAMPLES_GETATTRIBUTE "")


# ======== setAttribute ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_SETATTRIBUTE
    "Sets an attribute value for a given spatial unit.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_SETATTRIBUTE "")
SET(DOCSTRINGRAW_RETURN_SETATTRIBUTE "")
SET(DOCSTRINGRAW_PARAMETERS_SETATTRIBUTE
    "UnitClass  -- the unit class"
    "UnitID     -- the unit"
    "AttrName  -- the name of the attribute"
    "AttrVal   -- the value of the attribute")
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_SETATTRIBUTE)
SET(DOCSTRINGRAW_EXCEPTIONS_SETATTRIBUTE
    "PyOpenFLUIDError  -- if unit doesn't exist, or if the pair unit class and attr name exists")
SET(DOCSTRINGRAW_EXAMPLES_SETATTRIBUTE "")


# ======== removeAttribute ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_REMOVEATTRIBUTE
    "Removes an attribute value for a given spatial unit.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_REMOVEATTRIBUTE "")
SET(DOCSTRINGRAW_RETURN_REMOVEATTRIBUTE "")
SET(DOCSTRINGRAW_PARAMETERS_REMOVEATTRIBUTE
    "UnitClass  -- the unit class"
    "AttrName  -- the name of the attribute")
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_REMOVEATTRIBUTE)
SET(DOCSTRINGRAW_EXCEPTIONS_REMOVEATTRIBUTE
    "PyOpenFLUIDError  -- if unit class doesn't exist, or if the pair unit class and attr name doesn't  exists either")
SET(DOCSTRINGRAW_EXAMPLES_REMOVEATTRIBUTE "")


# ======== openDataset ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_OPENDATASET
    "Opens a dataset.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_OPENDATASET "")
SET(DOCSTRINGRAW_RETURN_OPENDATASET "")
SET(DOCSTRINGRAW_PARAMETERS_OPENDATASET
    "Path  -- the path of the dataset to open")
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_OPENDATASET)
SET(DOCSTRINGRAW_EXCEPTIONS_OPENDATASET
    "PyOpenFLUIDError  -- from OpenFLUID framework"
    "MemoryError       -- if there's no enough memory"
    "SystemError       -- "
    "RuntimeError      -- if unknown error occured")
SET(DOCSTRINGRAW_EXAMPLES_OPENDATASET "")


# ======== openProject ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_OPENPROJECT
    "Opens an existing project.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_OPENPROJECT "")
SET(DOCSTRINGRAW_RETURN_OPENPROJECT "")
SET(DOCSTRINGRAW_PARAMETERS_OPENPROJECT
    "Path  -- the path of the project to open")
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_OPENPROJECT)
SET(DOCSTRINGRAW_EXCEPTIONS_OPENPROJECT
    "PyOpenFLUIDError  -- from OpenFLUID framework"
    "MemoryError       -- if there's no enough memory"
    "SystemError       -- "
    "RuntimeError      -- if unknown error occured")
SET(DOCSTRINGRAW_EXAMPLES_OPENPROJECT "")


# ======== saveDataset ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_SAVEDATASET
    "Saves a dataset in a directory.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_SAVEDATASET "")
SET(DOCSTRINGRAW_RETURN_SAVEDATASET "")
SET(DOCSTRINGRAW_PARAMETERS_SAVEDATASET
    "Path  -- the dataset output directory")
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_SAVEDATASET)
SET(DOCSTRINGRAW_EXCEPTIONS_SAVEDATASET
    "PyOpenFLUIDError  -- from OpenFLUID framework"
    "MemoryError       -- if there's no enough memory"
    "SystemError       -- "
    "RuntimeError      -- if unknown error occured")
SET(DOCSTRINGRAW_EXAMPLES_SAVEDATASET "")


# ======== saveProject ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_SAVEPROJECT
    "Saves a project in a directory.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_SAVEPROJECT "")
SET(DOCSTRINGRAW_RETURN_SAVEPROJECT "")
SET(DOCSTRINGRAW_PARAMETERS_SAVEPROJECT
    "path        -- the output directory"
    "**kw        -- optional keyword values")
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_SAVEPROJECT
    "name        -- the name of the project"
    "description -- a short description of the project"
    "authors     -- a string of author(s)")
SET(DOCSTRINGRAW_EXCEPTIONS_SAVEPROJECT
    "PyOpenFLUIDError  -- from OpenFLUID framework"
    "MemoryError       -- if there's no enough memory"
    "SystemError       -- "
    "RuntimeError      -- if unknown error occured")
SET(DOCSTRINGRAW_EXAMPLES_SAVEPROJECT "")


# ======== setCurrentOutputDir ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_SETCURRENTOUTPUTDIR
    "Sets the current output directory for simulations.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_SETCURRENTOUTPUTDIR "")
SET(DOCSTRINGRAW_RETURN_SETCURRENTOUTPUTDIR "")
SET(DOCSTRINGRAW_PARAMETERS_SETCURRENTOUTPUTDIR
    "Path  -- the output directory path")
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_SETCURRENTOUTPUTDIR)
SET(DOCSTRINGRAW_EXCEPTIONS_SETCURRENTOUTPUTDIR)
SET(DOCSTRINGRAW_EXAMPLES_SETCURRENTOUTPUTDIR "")


# ======== getCurrentOutputDir ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_GETCURRENTOUTPUTDIR
    "Gets the current output directory for simulations.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_GETCURRENTOUTPUTDIR "")
SET(DOCSTRINGRAW_RETURN_GETCURRENTOUTPUTDIR "the output directory path")
SET(DOCSTRINGRAW_PARAMETERS_GETCURRENTOUTPUTDIR)
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_GETCURRENTOUTPUTDIR)
SET(DOCSTRINGRAW_EXCEPTIONS_GETCURRENTOUTPUTDIR)
SET(DOCSTRINGRAW_EXAMPLES_GETCURRENTOUTPUTDIR "")


# ======== getDefaultDeltaT ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_GETDEFAULTDELTAT
    "Returns the default simulation time step.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_GETDEFAULTDELTAT "")
SET(DOCSTRINGRAW_RETURN_GETDEFAULTDELTAT "the time step value in seconds")
SET(DOCSTRINGRAW_PARAMETERS_GETDEFAULTDELTAT)
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_GETDEFAULTDELTAT)
SET(DOCSTRINGRAW_EXCEPTIONS_GETDEFAULTDELTAT)
SET(DOCSTRINGRAW_EXAMPLES_GETDEFAULTDELTAT "")


# ======== setDefaultDeltaT ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_SETDEFAULTDELTAT
    "Sets the default simulation time step.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_SETDEFAULTDELTAT "")
SET(DOCSTRINGRAW_RETURN_SETDEFAULTDELTAT "")
SET(DOCSTRINGRAW_PARAMETERS_SETDEFAULTDELTAT
    "DefaultDeltaT  -- the time step value in seconds")
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_SETDEFAULTDELTAT)
SET(DOCSTRINGRAW_EXCEPTIONS_GETDEFAULTDELTAT
    "ValueError     -- if default delta t is negative or null")
SET(DOCSTRINGRAW_EXAMPLES_GETDEFAULTDELTAT "")


# ======== getPeriodBeginDate ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_GETPERIODBEGINDATE
    "Returns the simulation period begin date.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_GETPERIODBEGINDATE "")
SET(DOCSTRINGRAW_RETURN_GETPERIODBEGINDATE
    "the begin date as an ISO datetime string (%Y-%m-%d %H:%M:%S)")
SET(DOCSTRINGRAW_PARAMETERS_GETPERIODBEGINDATE)
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_GETPERIODBEGINDATE)
SET(DOCSTRINGRAW_EXCEPTIONS_GETPERIODBEGINDATE)
SET(DOCSTRINGRAW_EXAMPLES_GETPERIODBEGINDATE "")


# ======== getPeriodEndDate ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_GETPERIODENDDATE
    "Returns the simulation period end date.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_GETPERIODENDDATE "")
SET(DOCSTRINGRAW_RETURN_GETPERIODENDDATE
    "the end date as an ISO datetime string (%Y-%m-%d %H:%M:%S)")
SET(DOCSTRINGRAW_PARAMETERS_GETPERIODENDDATE)
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_GETPERIODENDDATE)
SET(DOCSTRINGRAW_EXCEPTIONS_GETPERIODENDDATE)
SET(DOCSTRINGRAW_EXAMPLES_GETPERIODENDDATE "")


# ======== setPeriodBeginDate ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_SETPERIODBEGINDATE
    "Sets the simulation period begin date.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_SETPERIODBEGINDATE "")
SET(DOCSTRINGRAW_RETURN_SETPERIODBEGINDATE "")
SET(DOCSTRINGRAW_PARAMETERS_SETPERIODBEGINDATE
    "BeginDate   -- the begin date as an ISO datetime string (%Y-%m-%d %H:%M:%S)")
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_SETPERIODBEGINDATE)
SET(DOCSTRINGRAW_EXCEPTIONS_SETPERIODBEGINDATE
    "ValueError  -- the date doesn't match with the format")
SET(DOCSTRINGRAW_EXAMPLES_SETPERIODBEGINDATE "")


# ======== setPeriodEndDate ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_SETPERIODENDDATE
    "Sets the simulation period end date.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_SETPERIODENDDATE "")
SET(DOCSTRINGRAW_RETURN_SETPERIODENDDATE "")
SET(DOCSTRINGRAW_PARAMETERS_SETPERIODENDDATE
    "EndDate     -- the end date as an ISO datetime string (%Y-%m-%d %H:%M:%S)")
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_SETPERIODENDDATE)
SET(DOCSTRINGRAW_EXCEPTIONS_SETPERIODENDDATE
    "ValueError  -- the date doesn't match with the format")
SET(DOCSTRINGRAW_EXAMPLES_SETPERIODENDDATE "")


# ======== runProject ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_RUNPROJECT "Runs an existing project.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_RUNPROJECT "")
SET(DOCSTRINGRAW_RETURN_RUNPROJECT "")
SET(DOCSTRINGRAW_PARAMETERS_RUNPROJECT
    "Path  -- the path of the project to open")
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_RUNPROJECT)
SET(DOCSTRINGRAW_EXCEPTIONS_RUNPROJECT)
SET(DOCSTRINGRAW_EXAMPLES_RUNPROJECT "")


# ======== runSimulation ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_RUNSIMULATION
    "Runs the simulation.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_RUNSIMULATION "")
SET(DOCSTRINGRAW_RETURN_RUNSIMULATION
    "True if the simulation is runned without problems, False otherwise.")
SET(DOCSTRINGRAW_PARAMETERS_RUNSIMULATION)
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_RUNSIMULATION)
SET(DOCSTRINGRAW_EXCEPTIONS_RUNSIMULATION
    "PyOpenFLUIDError  -- from OpenFLUID framework"
    "MemoryError       -- if there's no enough memory"
    "SystemError       -- "
    "RuntimeError      -- if unknown error occured")
SET(DOCSTRINGRAW_EXAMPLES_RUNSIMULATION "")


# ======== getStr ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_GETSTR "Return a description of the class.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_GETSTR "")
SET(DOCSTRINGRAW_RETURN_GETSTR "A string representation of the class.")
SET(DOCSTRINGRAW_PARAMETERS_GETSTR)
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_GETSTR)
SET(DOCSTRINGRAW_EXCEPTIONS_GETSTR)
SET(DOCSTRINGRAW_EXAMPLES_GETSTR
">>> obj = PyOpenFLUID()
>>> info = str(obj)")


# ======== getModelItems ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_GETMODELITEMS
    "Gets an ordered list of simulators and generators id.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_GETMODELITEMS "")
SET(DOCSTRINGRAW_RETURN_GETMODELITEMS "a list of id")
SET(DOCSTRINGRAW_PARAMETERS_GETMODELITEMS)
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_GETMODELITEMS)
SET(DOCSTRINGRAW_EXCEPTIONS_GETMODELITEMS)
SET(DOCSTRINGRAW_EXAMPLES_GETMODELITEMS "")


# ======== addCSVOutput ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_ADDCSVOUTPUT
    "Adds an csv output.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_ADDCSVOUTPUT "")
SET(DOCSTRINGRAW_RETURN_ADDCSVOUTPUT
    "Return the name of the observer created.")
SET(DOCSTRINGRAW_PARAMETERS_ADDCSVOUTPUT
    "UnitClass    -- the unit class"
    "Vars         -- a string of vars name (separated by comma '\;') or '*'"
    "ListID       -- a string of unit id (separated by comma '\;') or '*'")
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_ADDCSVOUTPUT)
SET(DOCSTRINGRAW_EXCEPTIONS_ADDCSVOUTPUT)
SET(DOCSTRINGRAW_EXAMPLES_ADDCSVOUTPUT "")


# ======== loadCSVOutput ========
SET(DOCSTRINGRAW_SHORT_DESCRIPTION_LOADCSVOUTPUT
    "Loads results from an csv output.")
SET(DOCSTRINGRAW_LONG_DESCRIPTION_LOADCSVOUTPUT "")
SET(DOCSTRINGRAW_RETURN_LOADCSVOUTPUT
    "Return a list of tuple ((unit class, unit id, unit var), headers, values).
Values is a pair of numpy.ndarray of numpy.datetime64 and numpy.float64.")
SET(DOCSTRINGRAW_PARAMETERS_LOADCSVOUTPUT
    "ObsName      -- the observer name"
    "UnitClass    -- the unit class"
    "ListID       -- a string of unit id (separated by comma '\;'), or a list of id or '*'"
    "ListVar      -- a string of vars name (separated by comma '\;'), or a list of vars or '*'")
SET(DOCSTRINGRAW_OPTIONAL_PARAMETERS_LOADCSVOUTPUT)
SET(DOCSTRINGRAW_EXCEPTIONS_LOADCSVOUTPUT)
SET(DOCSTRINGRAW_EXAMPLES_LOADCSVOUTPUT "")


# all functions names
SET(DOCSTRING_ALL_FUNCTIONS_ADVANCED PRINTSIMULATIONINFO GETVERSION
ADDEXTRASIMULATORSPATHS GETEXTRASIMULATORSPATHS RESETEXTRASIMULATORSPATHS
ADDEXTRAOBSERVERSPATHS GETEXTRAOBSERVERSPATHS RESETEXTRAOBSERVERSPATHS
GETSIMULATORPARAM SETSIMULATORPARAM REMOVESIMULATORPARAM GETSIMULATORPARAMS
GETGENERATORPARAM SETGENERATORPARAM
GETMODELGLOBALPARAM SETMODELGLOBALPARAM REMOVEMODELGLOBALPARAM GETMODELGLOBALPARAMS
ADDSIMULATOR REMOVESIMULATOR CLEARMODEL GETSIMULATORSINMODEL
GETOBSERVERPARAM SETOBSERVERPARAM REMOVEOBSERVERPARAM GETOBSERVERPARAMS
ADDOBSERVER REMOVEOBSERVER CLEARMONITORING GETOBSERVERSINMONITORING
GETUNITSCLASSES GETUNITSIDS ADDUNIT REMOVEUNIT CLEARALLUNITS
GETPROCESSORDER SETPROCESSORDER GETUNITCHILDREN GETUNITPARENTS
ADDPARENTCHILDCONNECTION REMOVEPARENTCHILDCONNECTION
CREATEATTRIBUTE GETATTRIBUTE SETATTRIBUTE REMOVEATTRIBUTE
OPENDATASET OPENPROJECT SETCURRENTOUTPUTDIR GETCURRENTOUTPUTDIR
GETDEFAULTDELTAT SETDEFAULTDELTAT
GETPERIODBEGINDATE GETPERIODENDDATE SETPERIODBEGINDATE SETPERIODENDDATE
RUNPROJECT RUNSIMULATION GETSTR CONSTRUCTOR
GETUNITTOS GETUNITFROMS ADDFROMTOCONNECTION REMOVEFROMTOCONNECTION
GETMODELITEMS SAVEDATASET SAVEPROJECT
ADDCSVOUTPUT LOADCSVOUTPUT)