workspace.h

Go to the documentation of this file.

/*
 The Real-Time eXperiment Interface (RTXI)
 Copyright (C) 2011 Georgia Institute of Technology, University of Utah, Weill Cornell Medical College

 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 the Free Software Foundation, either version 3 of the License, or
 (at your option) any later version.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 GNU General Public License for more details.

 You should have received a copy of the GNU General Public License
 along with this program. If not, see <http://www.gnu.org/licenses/>.

*/

#ifndef WORKSPACE_H
#define WORKSPACE_H

#include <io.h>


namespace Workspace
{

static const IO::flags_t INPUT = IO::INPUT;
static const IO::flags_t OUTPUT = IO::OUTPUT;
static const IO::flags_t PARAMETER = IO::OUTPUT<<1;
static const IO::flags_t STATE = IO::OUTPUT<<2;
static const IO::flags_t EVENT = IO::OUTPUT<<3;
static const IO::flags_t COMMENT = IO::OUTPUT<<4;

typedef IO::channel_t variable_t;

class Instance : public IO::Block
{

 friend class Manager;

public:

 Instance(std::string name,variable_t *variables,size_t size);
 virtual ~Instance(void);

 size_t getCount(IO::flags_t type) const;
 std::string getName(IO::flags_t type,size_t index) const;
 std::string getDescription(IO::flags_t type,size_t index) const;
 double getValue(IO::flags_t type,size_t index) const;
 std::string getValueString(IO::flags_t type,size_t index) const;

 void setValue(size_t index,double value);
 void setComment(size_t index,std::string comment);

protected:

 double *getData(IO::flags_t type,size_t index);

 void setData(IO::flags_t type,size_t index,double *value);

private:

 typedef struct
 {
 std::string name;
 std::string description;
 double *data;
 } var_t;

 std::vector<var_t> parameter;
 std::vector<var_t> state;
 std::vector<var_t> event;

 typedef struct
 {
 std::string name;
 std::string description;
 std::string comment;
 } comment_t;

 std::vector<comment_t> comment;

}; // class Object

class Manager
{

 friend class Instance;

public:

 static Manager *getInstance(void);

 void foreachWorkspace(void (*callback)(Instance *,void *),void *param);

private:

 /*****************************************************************
 * The constructor, destructor, and assignment operator are made *
 * private to control instantiation of the class. *
 *****************************************************************/

 Manager(void) : mutex(Mutex::RECURSIVE) {};
 ~Manager(void) {};
 Manager(const Manager &) {};
 Manager &operator=(const Manager &)
 {
 return *getInstance();
 };

 static Manager *instance;

 void insertWorkspace(Instance *);
 void removeWorkspace(Instance *);

 Mutex mutex;
 std::list<Instance *> instanceList;

}; // class Manager

} // namespace Workspace

#endif // WORKSPACE_H