CLAM::SegmentTransformationConfig Class Reference

Configuration class for all SegmentTransformations. More...

#include <SegmentTransformationConfig.hxx>

List of all members.

Public Member Functions

 SegmentTransformationConfig ()
 SegmentTransformationConfig (const SegmentTransformationConfig &prototype, const bool shareData=false, const bool deep=true)
 __COMMON_DYNAMIC_TYPE (SegmentTransformationConfig, 3)
 __COMMON_DYN_ATTRIBUTE (0, public, std::string, Type) protected
 Type of transformation, for the time being just a string, should become an enumeration of known transformation types??
bool LoadType (CLAM::Storage &s)
 __COMMON_DYN_ATTRIBUTE (1, public, TData, Amount) protected
 Single Value Parameter.
bool LoadAmount (CLAM::Storage &s)
 __COMMON_DYN_ATTRIBUTE (2, public, BPF, BPFAmount) protected
 BPF (envelope-like) Parameter.
bool LoadBPFAmount (CLAM::Storage &s)

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.


Constructor & Destructor Documentation

CLAM::SegmentTransformationConfig::SegmentTransformationConfig (  )  [inline]

Definition at line 38 of file SegmentTransformationConfig.hxx.

CLAM::SegmentTransformationConfig::SegmentTransformationConfig ( const SegmentTransformationConfig prototype,
const bool  shareData = false,
const bool  deep = true 
) [inline]

Definition at line 38 of file SegmentTransformationConfig.hxx.


Member Function Documentation

CLAM::SegmentTransformationConfig::__COMMON_DYN_ATTRIBUTE ( ,
public  ,
BPF  ,
BPFAmount   
) [inline]

BPF (envelope-like) Parameter.

Definition at line 45 of file SegmentTransformationConfig.hxx.

CLAM::SegmentTransformationConfig::__COMMON_DYN_ATTRIBUTE ( ,
public  ,
TData  ,
Amount   
) [inline]

Single Value Parameter.

Definition at line 43 of file SegmentTransformationConfig.hxx.

CLAM::SegmentTransformationConfig::__COMMON_DYN_ATTRIBUTE ( ,
public  ,
std::string  ,
Type   
) [inline]

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

Definition at line 41 of file SegmentTransformationConfig.hxx.

CLAM::SegmentTransformationConfig::__COMMON_DYNAMIC_TYPE ( SegmentTransformationConfig  ,
 
)
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().

bool CLAM::SegmentTransformationConfig::LoadAmount ( CLAM::Storage s  )  [inline]

Definition at line 43 of file SegmentTransformationConfig.hxx.

bool CLAM::SegmentTransformationConfig::LoadBPFAmount ( CLAM::Storage s  )  [inline]

Definition at line 45 of file SegmentTransformationConfig.hxx.

bool CLAM::SegmentTransformationConfig::LoadType ( CLAM::Storage s  )  [inline]

Definition at line 41 of file SegmentTransformationConfig.hxx.


The documentation for this class was generated from the following files:
Generated by  doxygen 1.6.3