/usr/include/CLAM/InPort.hxx is in libclam-dev 1.4.0-7.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 | /*
* Copyright (c) 2004 MUSIC TECHNOLOGY GROUP (MTG)
* UNIVERSITAT POMPEU FABRA
*
*
* 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 2 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, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
*/
#ifndef __InPort_hxx__
#define __InPort_hxx__
#include "WritingRegion.hxx"
#include "ReadingRegion.hxx"
#include <string>
#include <typeinfo>
namespace CLAM
{
class OutPortBase;
class Processing;
class InPortBase
{
public:
InPortBase( const std::string & name = "unnamed in port", Processing * proc = 0 );
virtual ~InPortBase();
OutPortBase * GetVisuallyConnectedOutPort();
void SetVisuallyConnectedOutPort( OutPortBase* );
const std::string & GetName();
bool HasProcessing();
Processing * GetProcessing();
virtual bool CanConsume()=0;
virtual int GetSize()=0;
virtual void SetSize(int newSize)=0;
virtual int GetHop()=0;
virtual void SetHop(int newHop)=0;
virtual void UnAttachRegion()=0;
void Disconnect();
virtual bool IsPublisherOf( InPortBase& ) const { return false; }
virtual bool IsPublisher() const { return false; }
virtual const std::type_info& GetTypeId() const = 0;
protected:
OutPortBase * mVisuallyConnectedOutPort;
std::string mName;
Processing * mProcessing;
};
template<typename Token>
class InPort : public InPortBase
{
typedef WritingRegion<Token> ProperWritingRegion;
typedef typename ProperWritingRegion::ProperReadingRegion ProperReadingRegion;
public:
InPort( const std::string & name = "unnamed in port", Processing * proc = 0 );
virtual ~InPort();
// XR: BIG TODO: make this method const!
/*const*/ Token & GetData(int offset=0);
void SetSize( int newSize );
int GetSize();
int GetHop();
void SetHop( int hop );
void Consume();
bool CanConsume();
/**
* This method is intended to be used only for the OutPort. A user shouldn't call it directly.
* Instead , use ConnectToIn method in OutPortBase.
*/
void AttachRegionToOutPort( OutPortBase * out, ProperWritingRegion & writer );
/**
* This method is intended to be used only for the OutPort. A user shouldn't call it directly.
* Instead , use DisconnectFromIn method in OutPortBase.
*/
void UnAttachRegion();
virtual const std::type_info & GetTypeId() const
{
return typeid(Token);
};
protected:
ProperReadingRegion mRegion;
};
/////// Implementation ////////
template<class Token>
InPort<Token>::InPort( const std::string & name, Processing * proc )
: InPortBase( name,proc )
{
}
template<class Token>
InPort<Token>::~InPort()
{
if(mVisuallyConnectedOutPort)
Disconnect();
}
template<class Token>
// XR BIG TODO: make this method const!
/*const*/ Token & InPort<Token>::GetData( int offset )
{
return mRegion[offset];
}
template<class Token>
void InPort<Token>::SetSize( int newSize )
{
mRegion.Size( newSize );
}
template<class Token>
int InPort<Token>::GetSize()
{
return mRegion.Size();
}
template<class Token>
int InPort<Token>::GetHop()
{
return mRegion.Hop();
}
template<class Token>
void InPort<Token>::SetHop( int hop )
{
mRegion.Hop(hop);
}
template<class Token>
void InPort<Token>::Consume()
{
mRegion.Consume();
}
template<class Token>
bool InPort<Token>::CanConsume()
{
return mRegion.CanConsume();
}
template<class Token>
void InPort<Token>::AttachRegionToOutPort( OutPortBase * out, ProperWritingRegion & writer )
{
writer.LinkRegions( mRegion );
mVisuallyConnectedOutPort = out;
}
template<class Token>
void InPort<Token>::UnAttachRegion()
{
CLAM_DEBUG_ASSERT( mVisuallyConnectedOutPort, "InPort<T>::UnAttachRegion() - InPort is not connected" );
mRegion.ProducerRegion()->RemoveRegion( mRegion );
mVisuallyConnectedOutPort = 0;
}
} // namespace CLAM
#endif // __InPort_hxx__
|