CLAM-Development  1.4.0
Public Types | Public Member Functions | Public Attributes | Static Public Attributes
CLAM::SpecTypeFlags Struct Reference

This class tells which formats are instantiated in a Spectrum. More...

#include <SpecTypeFlags.hxx>

List of all members.

Public Types

enum  tFlags { eComplex = 0, ePolar = 1, eMagPhase = 2, eMagPhaseBPF = 3 }

Public Member Functions

virtual ComponentSpecies () const
 Returns a new object of the same class than the receiver object.
 SpecTypeFlags ()
 SpecTypeFlags (const SpecTypeFlags &t)
- Public Member Functions inherited from CLAM::Flags< 4 >
virtual ~Flags ()
 The required virtual destructor.
const char * GetClassName () const
virtual unsigned int GetNFlags () const
virtual ComponentDeepCopy () const
virtual ComponentShallowCopy () const
- Public Member Functions inherited from CLAM::FlagsBase
std::string GetFlagString (unsigned int whichOne) const throw (IllegalValue)
 Retrieves the name of the flag at a position.
unsigned int GetFlagPosition (const std::string &whichOne) const throw (IllegalValue)
 Retrieves the position of the named flag.
virtual void StoreOn (Storage &storage) const
 Stores component's subitems on the given Storage.
virtual void LoadFrom (Storage &storage)
 Loads component's subitems from the given Storage.
bool CheckInvariant ()
 Checks that the object is internally consistent.
- Public Member Functions inherited from CLAM::Component
virtual ~Component ()

Public Attributes

reference bComplex
reference bPolar
reference bMagPhase
reference bMagPhaseBPF

Static Public Attributes

static tFlagValue sFlagValues []
static tValue sDefault

Additional Inherited Members

- Protected Member Functions inherited from CLAM::Flags< 4 >
 Flags (tFlagValue *names)
 The default constructor.
 Flags (tFlagValue *names, const Flags< N > &t)
 The derived copy constructor will use this.
 Flags (tFlagValue *names, const T &t)
 A lazy way to redefine all unary constructors in bitset by forwarding it.
 Flags (tFlagValue *names, const T1 &t1, const T2 &t2)
 A template binary constructor that fordwards to the matching std::bitset.
virtual bool IsSetFlag (unsigned int whichOne) const
virtual void SetFlag (unsigned int whichOne, bool value=true)

Detailed Description

This class tells which formats are instantiated in a Spectrum.

It could be:

It can be used as any other class derived from Flags: you can use the std::bit interface and Flags added functionalities.

See also:
Flags

Definition at line 42 of file SpecTypeFlags.hxx.


Member Enumeration Documentation

Enumerator:
eComplex 
ePolar 
eMagPhase 
eMagPhaseBPF 

Definition at line 50 of file SpecTypeFlags.hxx.


Constructor & Destructor Documentation

CLAM::SpecTypeFlags::SpecTypeFlags ( )
inline

Definition at line 57 of file SpecTypeFlags.hxx.

References bComplex, bMagPhase, bMagPhaseBPF, and bPolar.

Referenced by Species().

CLAM::SpecTypeFlags::SpecTypeFlags ( const SpecTypeFlags t)
inline

Definition at line 71 of file SpecTypeFlags.hxx.


Member Function Documentation

virtual Component* CLAM::SpecTypeFlags::Species ( ) const
inlinevirtual

Returns a new object of the same class than the receiver object.

To be reimplemented by subclasses.

Returns:
a new allocated component. The pointer belongs to the caller.

Implements CLAM::Flags< 4 >.

Definition at line 47 of file SpecTypeFlags.hxx.

References SpecTypeFlags().


Member Data Documentation

reference CLAM::SpecTypeFlags::bComplex
reference CLAM::SpecTypeFlags::bMagPhase
reference CLAM::SpecTypeFlags::bMagPhaseBPF
reference CLAM::SpecTypeFlags::bPolar
tValue CLAM::SpecTypeFlags::sDefault
static

Definition at line 46 of file SpecTypeFlags.hxx.

Flags< 4 >::tFlagValue SpecTypeFlags::sFlagValues
static
Initial value:
{
{SpecTypeFlags::eMagPhase, "MagPhase"},
{SpecTypeFlags::eMagPhaseBPF, "MagPhaseBPF"},
{0,NULL}
}

Definition at line 45 of file SpecTypeFlags.hxx.


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