#include <Attraction.h>

Inheritance diagram for bio::physical::Attraction< DIMENSION >:

[legend]

Collaboration diagram for bio::physical::Attraction< DIMENSION >:

[legend]

Public Types
typedef double	Force

Public Types inherited from bio::physical::Identifiable< DIMENSION >
typedef DIMENSION	Identifier

typedef Arrangement< Identifier >	Ids

Public Types inherited from bio::physical::Observer< Perspective< DIMENSION > >
typedef Perspective< DIMENSION >	Perspective

Public Member Functions
	Attraction (const DIMENSION &dimension=0, const Force strength=0.0, Pointer< Perspective< DIMENSION > > perspective=NULL)

void	SetForce (const Force strength)

Force	GetForce () const

bool	operator== (const Attraction &other) const

Public Member Functions inherited from bio::physical::Class< Attraction< DIMENSION > >
	Class (Pointer< Attraction< DIMENSION > > object, Pointer< Symmetry > symmetry=NULL)

	Class (Pointer< Attraction< DIMENSION > > object, SymmetryFactory symmetryFactory)

	Class (const Class &other)

virtual	~Class ()

virtual Pointer< Attraction< DIMENSION > >	GetWaveObject ()

virtual Pointer< const Attraction< DIMENSION > >	GetWaveObject () const

virtual	operator Attraction< DIMENSION > & ()

virtual	operator const Attraction< DIMENSION > & () const

virtual Pointer< Wave >	Clone () const

Pointer< Wave >	AsWave ()

Pointer< const Wave >	AsWave () const

virtual	operator Pointer< Wave > ()

Public Member Functions inherited from bio::physical::Wave
	Wave (Pointer< Symmetry > symmetry=NULL)

	Wave (const Wave &other)

Wave &	operator= (const Wave &other)

virtual	~Wave ()

virtual Properties	GetProperties () const

virtual Pointer< const Symmetry >	Spin () const

Pointer< const Symmetry >	GetSymmetry () const

virtual Code	Reify (Pointer< const Symmetry > symmetry)

virtual bool	Superpose (Pointer< const Wave > displacement, Pointer< Interference > pattern)

virtual Pointer< Wave >	Superpose (const ConstWaves &displacement, Pointer< Interference > pattern)

virtual Pointer< Wave >	Modulate (Pointer< Wave > signal)

virtual Pointer< Wave >	Demodulate ()

virtual Pointer< const Wave >	Demodulate () const

virtual Code	Attenuate (Pointer< const Wave > other)

virtual Code	Disattenuate (Pointer< const Wave > other)

Pointer< Wave >	AsWave ()

Pointer< const Wave >	AsWave () const

virtual Pointer< chemical::Atom >	AsAtom ()

virtual Pointer< const chemical::Atom >	AsAtom () const

virtual void	operator\| (Pointer< Symmetry > symmetry)

virtual Pointer< Wave >	operator* (Pointer< Wave > signal)

virtual Pointer< Wave >	operator* ()

virtual Pointer< const Wave >	operator* () const

virtual void	operator+ (Pointer< const Wave > other)

virtual void	operator- (Pointer< const Wave > other)

uint16_t	GetTypeId () const

void	SetTypeId (uint16_t typeId)

Public Member Functions inherited from bio::physical::Identifiable< DIMENSION >
	Identifiable (Pointer< Perspective< DIMENSION > > perspective=NULL)

	Identifiable (const Name &name, Pointer< Perspective< DIMENSION > > perspective=NULL)

	Identifiable (Identifier id, Pointer< Perspective< DIMENSION > > perspective=NULL)

	Identifiable (const Identifiable &other)

virtual	~Identifiable ()

virtual	operator DIMENSION () const

virtual bool	operator== (const Identifier id) const

virtual bool	operator== (const Name &name) const

virtual bool	operator== (const Identifiable< DIMENSION > &other) const

virtual Name	GetName () const

virtual Identifier	GetId () const

virtual bool	SetName (const Name &name)

virtual bool	SetId (Identifier id)

virtual bool	IsName (const Name &name) const

virtual bool	IsNameInsensitive (const Name &name) const

virtual bool	IsId (Identifier id) const

virtual void	SetPerspective (Pointer< Perspective< DIMENSION > > perspective)

Public Member Functions inherited from bio::physical::Class< Identifiable< DIMENSION > >
	Class (Pointer< Identifiable< DIMENSION > > object, Pointer< Symmetry > symmetry=NULL)

	Class (Pointer< Identifiable< DIMENSION > > object, SymmetryFactory symmetryFactory)

	Class (const Class &other)

virtual	~Class ()

virtual Pointer< Identifiable< DIMENSION > >	GetWaveObject ()

virtual Pointer< const Identifiable< DIMENSION > >	GetWaveObject () const

virtual	operator Identifiable< DIMENSION > & ()

virtual	operator const Identifiable< DIMENSION > & () const

virtual Pointer< Wave >	Clone () const

Pointer< Wave >	AsWave ()

Pointer< const Wave >	AsWave () const

virtual	operator Pointer< Wave > ()

Public Member Functions inherited from bio::physical::Observer< Perspective< DIMENSION > >
	Observer (Pointer< Perspective > perspective=NULL)

	Observer (const Observer &other)

virtual	~Observer ()

virtual void	SetPerspective (Pointer< Perspective > perspective)

virtual Pointer< Perspective >	GetPerspective () const

Protected Attributes
DIMENSION	m_dimension

Force	m_strength

Protected Attributes inherited from bio::physical::Class< Attraction< DIMENSION > >
Pointer< Attraction< DIMENSION > >	mObject

Protected Attributes inherited from bio::physical::Wave
LazyPointer< Symmetry >	mSymmetry

bool	mHasSignal

uint16_t	mTypeId

Protected Attributes inherited from bio::physical::Class< Identifiable< DIMENSION > >
Pointer< Identifiable< DIMENSION > >	mObject

Protected Attributes inherited from bio::VirtualBase
bool	mHasBeenInitialized

Additional Inherited Members
Static Public Member Functions inherited from bio::physical::Class< Attraction< DIMENSION > >
static Pointer< Attraction< DIMENSION > >	Convert (Pointer< Wave > wave)

Static Public Member Functions inherited from bio::physical::Wave
static Properties	GetResonanceBetween (ConstWaves waves)

static Properties	GetResonanceBetween (Pointer< const Wave > wave1, Pointer< const Wave > wave2)

static Properties	GetResonanceBetween (Pointer< const Wave > wave, const Properties &properties)

Static Public Member Functions inherited from bio::physical::Class< Identifiable< DIMENSION > >
static Pointer< Identifiable< DIMENSION > >	Convert (Pointer< Wave > wave)

Protected Member Functions inherited from bio::physical::Identifiable< DIMENSION >
virtual void	InitializeImplementation (ByteStreams &args)

friend::std::ostream &	operator<< (std::ostream &out, const Identifiable< DIMENSION > &t)

Protected Member Functions inherited from bio::VirtualBase
	VirtualBase ()

virtual	~VirtualBase ()

void	Initialize (ByteStreams &args)

void	Initialize (ByteStream arg1)

void	Initialize (ByteStream arg1, ByteStream arg2)

void	Initialize (ByteStream arg1, ByteStream arg2, ByteStream arg3)

Detailed Description

template<typename DIMENSION>
class bio::physical::Attraction< DIMENSION >

physical::Attraction is essentially a key value pair between 2 objects in the same DIMENSION.
(See relativity/Perspective.h for an explanation of DIMENSION).
The Key to Attraction is the DIMENSION; the value is the strength of the Attraction.

To create repulsion, simply set a negative Strength.

Member Typedef Documentation

◆ Force

template<typename DIMENSION >

typedef double bio::physical::Attraction< DIMENSION >::Force

Constructor & Destructor Documentation

◆ Attraction()

template<typename DIMENSION >

bio::physical::Attraction< DIMENSION >::Attraction	(	const DIMENSION &	dimension = `0`,
		const Force	strength = `0.0`,
		Pointer< Perspective< DIMENSION > >	perspective = `NULL`
	)