CLAM-Development  1.4.0
Public Member Functions | Protected Member Functions
CLAM::SegmentTransformationConfig Class Reference

Configuration class for all SegmentTransformations. More...

#include <SegmentTransformationConfig.hxx>

List of all members.

Public Member Functions

 DYNAMIC_TYPE_USING_INTERFACE (SegmentTransformationConfig, 3, ProcessingConfig)
 DYN_ATTRIBUTE (0, public, std::string, Type)
 Type of transformation, for the time being just a string, should become an enumeration of known transformation types??
 DYN_ATTRIBUTE (1, public, TData, Amount)
 Single Value Parameter.
 DYN_ATTRIBUTE (2, public, BPF, BPFAmount)
 BPF (envelope-like) Parameter.
- Public Member Functions inherited from CLAM::ProcessingConfig
 ProcessingConfig (const int n)
 Constructor.
 ProcessingConfig (const ProcessingConfig &prototype, bool shareData=false, bool deep=true)
 Copy constructor.
virtual ~ProcessingConfig ()
virtual const char * GetClassName () const
 Return the class name.
- Public Member Functions inherited from CLAM::DynamicType
 DynamicType (const int nAttr)
 Constructs a DynamicType object that can hold.
 DynamicType (const DynamicType &prototype, const bool shareData, const bool deepCopy)
 Copy constructor of a dynamic Type.
 DynamicType (const DynamicType &prototype)
virtual ~DynamicType ()
void CopyInit (const DynamicType &dt)
 This method allows custom code for the copy-constructor of a dynamic type, since the copy-constructor is macro expanded and can not be overwritted.
bool UpdateData ()
 Method used to resize the data space of the dynamic type, necessary when some AddXXX() / RemoveXXX() (where XXX is an attribute name) has been done.
unsigned GetNDynamicAttributes () const
const char * GetDynamicAttributeName (unsigned i)
virtual const std::type_info & GetTypeId (unsigned i) const =0
bool AttributeIsComponent (unsigned i) const
bool AttributeIsDynamictype (unsigned i) const
bool IsAttributeInstantiated (unsigned i) const
const void * GetAttributeAsVoidPtr (unsigned i) const
const ComponentGetAttributeAsComponent (unsigned i) const
ComponentGetAttributeAsComponent (unsigned i)
void FullfilsInvariant () const
virtual ComponentDeepCopy () const
void Debug () const
virtual void StoreOn (CLAM::Storage &storage) const
 Stores component's subitems on the given Storage.
virtual void LoadFrom (CLAM::Storage &storage)
 Loads component's subitems from the given Storage.
- Public Member Functions inherited from CLAM::Component
virtual ~Component ()

Protected Member Functions

void DefaultInit ()
 The single-value Amount and the On configuration are added by default.
void DefaultValues ()
 By default, the amount is set to 0 and the On parameter to true.

Detailed Description

Configuration class for all SegmentTransformations.

It includes a float-like single value parameter and a BPF envelope-like parameter. Either one of these may be used to initialize and update the value control in an SegmentTransformation.

Definition at line 35 of file SegmentTransformationConfig.hxx.


Member Function Documentation

void CLAM::SegmentTransformationConfig::DefaultInit ( void  )
protected

The single-value Amount and the On configuration are added by default.

Should you need the BPF, it must be added explicitly

Reimplemented from CLAM::DynamicType.

Definition at line 26 of file SegmentTransformationConfig.cxx.

References DefaultValues(), and CLAM::DynamicType::UpdateData().

void CLAM::SegmentTransformationConfig::DefaultValues ( )
protected

By default, the amount is set to 0 and the On parameter to true.

Definition at line 33 of file SegmentTransformationConfig.cxx.

Referenced by DefaultInit().

CLAM::SegmentTransformationConfig::DYN_ATTRIBUTE ( ,
public  ,
std::string  ,
Type   
)

Type of transformation, for the time being just a string, should become an enumeration of known transformation types??

CLAM::SegmentTransformationConfig::DYN_ATTRIBUTE ( ,
public  ,
TData  ,
Amount   
)

Single Value Parameter.

CLAM::SegmentTransformationConfig::DYN_ATTRIBUTE ( ,
public  ,
BPF  ,
BPFAmount   
)

BPF (envelope-like) Parameter.

CLAM::SegmentTransformationConfig::DYNAMIC_TYPE_USING_INTERFACE ( SegmentTransformationConfig  ,
,
ProcessingConfig   
)

The documentation for this class was generated from the following files: