FREE::Accessor::VectorToPhaseAccessor< TVector > Class Template Reference
[Evaluation tools]

Accessor class which computes the phase of a 2d vector. More...

#include <freVectorToPhaseAccessor.h>

List of all members.

Public Types
typedef VectorToPhaseAccessor	Self
typedef TVector	InternalType
typedef double	ExternalType
Public Member Functions
void	Set (InternalType &output, const ExternalType &input) const
ExternalType	Get (const InternalType &input) const
void	SetOutputAsRad (const bool &bAsRad)
bool	GetOutputAsRad () const
	VectorToPhaseAccessor ()
	~VectorToPhaseAccessor ()
Private Attributes
bool	m_bOutputAsRad

---

Detailed Description

template<class TVector>
class FREE::Accessor::VectorToPhaseAccessor< TVector >

Accessor class which computes the phase of a 2d vector.

The accessor calculates the phase of a passed 2D vector as double. The vector (0;1)indicates the phase 0 and it will be calculated counter clockwise. The phase can be calculated as radian (default) or degrees.

Definition at line 44 of file freVectorToPhaseAccessor.h.

---

Member Typedef Documentation

template<class TVector>

typedef VectorToPhaseAccessor FREE::Accessor::VectorToPhaseAccessor< TVector >::Self

Standard class typedefs.

Definition at line 48 of file freVectorToPhaseAccessor.h.

template<class TVector>

typedef TVector FREE::Accessor::VectorToPhaseAccessor< TVector >::InternalType

Internal typedef. It defines the internal real representation of data

Definition at line 52 of file freVectorToPhaseAccessor.h.

template<class TVector>

typedef double FREE::Accessor::VectorToPhaseAccessor< TVector >::ExternalType

External typedef. It defines the external aspect that this class will exhibit

Definition at line 56 of file freVectorToPhaseAccessor.h.

---

Constructor & Destructor Documentation

template<class TVector>

FREE::Accessor::VectorToPhaseAccessor< TVector >::VectorToPhaseAccessor

(

)

[inline]

Definition at line 53 of file freVectorToPhaseAccessor.cxx.

References FREE::Accessor::VectorToPhaseAccessor< TVector >::m_bOutputAsRad.

template<class TVector>

FREE::Accessor::VectorToPhaseAccessor< TVector >::~VectorToPhaseAccessor

(

)

[inline]

Definition at line 60 of file freVectorToPhaseAccessor.cxx.

---

Member Function Documentation

template<class TVector>

void FREE::Accessor::VectorToPhaseAccessor< TVector >::Set	(	InternalType &	output,
		const ExternalType &	input
	)			const [inline]

Write access to the VectorToNorm component

Definition at line 59 of file freVectorToPhaseAccessor.h.

template<class TVector>

VectorToPhaseAccessor< TVector >::ExternalType FREE::Accessor::VectorToPhaseAccessor< TVector >::Get

(

const InternalType &

input

)

const [inline]

Read access to the VectorToNorm component

Definition at line 34 of file freVectorToPhaseAccessor.cxx.

References FREE::Accessor::VectorToPhaseAccessor< TVector >::m_bOutputAsRad.

template<class TVector>

void FREE::Accessor::VectorToPhaseAccessor< TVector >::SetOutputAsRad

(

const bool &

bAsRad

)

[inline]

Definition at line 71 of file freVectorToPhaseAccessor.h.

template<class TVector>

bool FREE::Accessor::VectorToPhaseAccessor< TVector >::GetOutputAsRad

(

)

const [inline]

Definition at line 76 of file freVectorToPhaseAccessor.h.

---

Member Data Documentation

template<class TVector>

bool FREE::Accessor::VectorToPhaseAccessor< TVector >::m_bOutputAsRad [private]

Definition at line 85 of file freVectorToPhaseAccessor.h.

Referenced by FREE::Accessor::VectorToPhaseAccessor< TVector >::Get(), and FREE::Accessor::VectorToPhaseAccessor< TVector >::VectorToPhaseAccessor().

---

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

• freVectorToPhaseAccessor.h
• freVectorToPhaseAccessor.cxx

---