source: osgVisual/include/cluster/dataIO_cluster.h @ 32

Last change on this file since 32 was 32, checked in by Torben Dannhauer, 14 years ago

Adding first version of osgVisual!!

File size: 3.6 KB
Line 
1#pragma once
2/* -*-c++-*- osgVisual - Copyright (C) 2009-2010 Torben Dannhauer
3 *
4 * This library is based on OpenSceneGraph, open source and may be redistributed and/or modified under
5 * the terms of the OpenSceneGraph Public License (OSGPL) version 0.0 or
6 * (at your option) any later version.  The full license is in LICENSE file
7 * included with this distribution, and on the openscenegraph.org website.
8 *
9 * osgVisual requires for some proprietary modules a license from the correspondig manufacturer.
10 * You have to aquire licenses for all used proprietary modules.
11 *
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 * OpenSceneGraph Public License for more details.
16*/
17
18#include "osg/referenced"
19
20#include "dataIO_slot.h"
21
22#include "dataIO_transportContainer.h"
23
24
25namespace osgVisual
26{
27
28/**
29 * \brief This class is the interface definition class for valid cluster implementations.
30 *
31 * This class is an abstract class, thus cannot be instantiated. Derive this class for usage.
32 *
33 * @author Torben Dannhauer
34 * @date  Feb 2010
35 */ 
36class dataIO_cluster :  public osg::Referenced
37{
38public:
39        /**
40         * \brief Empty constructor.
41         *
42         */ 
43        dataIO_cluster() {}
44
45        /**
46         * \brief Empty destructor
47         *
48         * @return
49         */ 
50        virtual ~dataIO_cluster() {}
51
52        /**
53         * \brief Pure virtual function for initialization. Must be implemented in derived class.
54         *
55         */ 
56        virtual void init( osg::ArgumentParser& arguments_, osgVisual::dataIO_transportContainer* sendContainer_, bool compressionEnabled_, bool asAscii_ ) = 0;
57
58
59        virtual void shutdown() = 0;
60
61        /**
62         * \brief This function sets the current transportContainer the cluster should send.
63         *
64         * The previous container is removed, if set. (smartpointer, will delete itself.). If the cluster is in slave mode, the send_container is ignored.
65         *
66         * @param sendContainer_ : New container to set.
67         */ 
68        void setSendTransportContainer( osgVisual::dataIO_transportContainer* sendContainer_ ) {sendContainer=sendContainer_;}
69
70        /**
71         * \brief Pure virtual function for sending TO_OBJ values via cluster to slave. Must be implemented in derived class.
72         *
73         * @return : See derived class.
74         */ 
75        virtual bool sendTO_OBJvaluesToSlaves() = 0;
76
77        /**
78         * \brief Pure virtual function for reading TO_OBJ values from master. Must be implemented in derived class.
79         *
80         * @return : See derived class.
81         */ 
82        virtual bool readTO_OBJvaluesFromMaster() = 0;
83
84        /**
85         * \brief Pure virtual function for reporting slave as ready to swap. Must be implemented in derived class.
86         *
87         */ 
88        virtual void reportAsReadyToSwap() = 0;
89
90        /**
91         * \brief Pure virtual function for waiting as slave for swap command. Must be implemented in derived class.
92         *
93         * @return : See derived class.
94         */ 
95        virtual bool waitForSwap() = 0;
96
97        /**
98         * \brief Pure virtual function for waiting as master for all slaves reported as ready to swap. Must be implemented in derived class.
99         *
100         * @return : See derived class.
101         */ 
102        virtual bool waitForAllReadyToSwap() = 0;
103
104        /**
105         * \brief Pure virtual function for sending swap command to all slaves. Must be implemented in derived class.
106         *
107         * @return : See derived class.
108         */ 
109        virtual bool sendSwapCommand() = 0;
110
111        /**
112         * This enum defines the three modi of the cluster engine.
113         */ 
114        enum clustermode {MASTER, SLAVE, STANDALONE};
115
116
117
118protected:
119        osg::ref_ptr<osgVisual::dataIO_transportContainer> sendContainer;
120};
121
122}       // END NAMESPACE
Note: See TracBrowser for help on using the repository browser.