/usr/include/CLAM/InControlBase.hxx is in libclam-dev 1.4.0-5build1.
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 | #ifndef InControlBase_hxx
#define InControlBase_hxx
#include <string>
#include <list>
#include <typeinfo>
namespace CLAM {
class Processing;
class OutControlBase;
/// Control events type
typedef float TControlData;
/**
* Base class for an inwards control connector.
* InControls can be used to receive asynchronous data from
* connected OutControls in other processings.
* @see OutControlBase AddingControlsToProcessings Processing
* @todo Remove the float services
*/
class InControlBase
{
std::string mName;
protected:
Processing * mProcessing;
typedef std::list<OutControlBase*> Peers;
/// Stores the pointers to the connected outcontrols
Peers mLinks;
TControlData mDefaultValue;
TControlData mUpperBound;
TControlData mLowerBound;
bool mBounded;
bool mHasDefaultValue;
mutable bool _hasBeenRead;
private:
/** Private copy constructor to avoid copies */
InControlBase(const InControlBase & toBeCopied ) {}
public:
bool HasBeenRead() const { return _hasBeenRead; }
/**
Class constructor.
@param name Unique name of the control within the processing.
@param processing Host processing (0 for a free control).
*/
InControlBase(const std::string &name, Processing * processing = 0);
/**
Class destructor.
Destruction clears any connection left and unregisters the control from the processing.
Whatever it gets destructed first (In or Out) links are properly unset.
*/
virtual ~InControlBase();
/**
Concrete InControls must overload this method by returning
the typeid of the kind of data they communicate.
This method is used internanlly in order to assure type
compatibility between an input an an output control.
There are some other uses like the NetworkEditor assigning
different colors to connectors depending on this type.
@todo Add a link to the
*/
virtual const std::type_info& GetTypeId() const = 0;
/// @returns The unique name that the control takes within the processing.
const std::string& GetName() const { return mName; }
/// @returns The hosting processing
Processing * GetProcessing() const { return mProcessing; }
/// @returns True if there is any linked out control
bool IsConnected() const { return not mLinks.empty(); }
/// @returns True if the control is linked to the parameter, an out control.
bool IsConnectedTo(OutControlBase & out);
/** @name Float specific services
* @todo move them to the concrete float class
*/
//{@
bool IsBounded() const;
TControlData UpperBound() const;
TControlData LowerBound() const;
/** Returns the bounds mean or the value set with SetDefaultValue() if its the case */
TControlData DefaultValue() const;
void SetDefaultValue(TControlData val);
void SetBounds(TControlData lower, TControlData upper);
//@}
/// Implementation detail just to be used just from OutControlBase
void OutControlInterface_AddLink(OutControlBase & outControl)
{
mLinks.push_back(&outControl);
}
/// Implementation detail just to be used just from OutControlBase
void OutControlInterface_RemoveLink(OutControlBase & outControl)
{
mLinks.remove(&outControl);
}
virtual const std::string GetLastValueAsString ()
{
return "Non printable type";
}
};
} // End namespace CLAM
#endif // InControlBase_hxx
|