iso::flock::ParameterRegistration Class Reference

#include <iso_flock_com.h>

List of all members.

Public Member Functions
	ParameterRegistration (const base::String &pSwarmName, const base::String &pParameterName, const base::String &pSenderName, unsigned int pSendInterval)
	ParameterRegistration (const base::String &pSwarmName, const base::String &pParameterName, const base::String &pSenderName, unsigned int pSendInterval, const math::Vector< float > &pMinParValue, const math::Vector< float > &pMaxParValue) throw (FlockException)
	ParameterRegistration (const base::String &pSwarmName, const base::String &pParameterName, const base::String &pSenderName, unsigned int pSendInterval, const math::Vector2< int > &pAgentRange) throw (FlockException)
	ParameterRegistration (const base::String &pSwarmName, const base::String &pParameterName, const base::String &pSenderName, unsigned int pSendInterval, const math::Vector2< int > &pAgentRange, const math::Vector< float > &pMinParValue, const math::Vector< float > &pMaxParValue) throw (FlockException)
	ParameterRegistration (const ParameterRegistration &pRegistration)
	~ParameterRegistration ()
void	set (unsigned int pSendInterval) throw (FlockException)
void	set (unsigned int pSendInterval, const math::Vector2< int > &pAgentRange) throw (FlockException)
void	set (unsigned int pSendInterval, const math::Vector< float > &pMinParValue, const math::Vector< float > &pMaxParValue) throw (FlockException)
void	set (unsigned int pSendInterval, const math::Vector2< int > &pAgentRange, const math::Vector< float > &pMinParValue, const math::Vector< float > &pMaxParValue) throw (FlockException)
const base::String &	swarmName () const
const base::String &	parameterName () const
const base::String &	senderName () const
unsigned int	sendInterval () const
unsigned int &	currentSendInterval ()
const math::Vector2< int > &	agentRange () const
bool	normalise () const
const math::Vector< float > &	minParValue () const
const math::Vector< float > &	maxParValue () const
const math::Vector< float > &	parValueScale () const
const math::Vector< float > &	parValueOffset () const
bool	operator== (const ParameterRegistration &pRegistration) const
bool	match (const base::String &pSwarmName, const base::String &pParameterName) const
Protected Attributes
base::String	mSwarmName
base::String	mParameterName
base::String	mSenderName
math::Vector2< int >	mAgentRange
bool	mNormalise
math::Vector< float >	mMinParValue
math::Vector< float >	mMaxParValue
math::Vector< float >	mParValueScale
math::Vector< float >	mParValueOffset
unsigned int	mSendInterval
unsigned int	mCurrentSendInterval

---

Constructor & Destructor Documentation

ParameterRegistration::ParameterRegistration	(	const base::String &	pSwarmName,
		const base::String &	pParameterName,
		const base::String &	pSenderName,
		unsigned int	pSendInterval
	)

ParameterRegistration::ParameterRegistration	(	const base::String &	pSwarmName,
		const base::String &	pParameterName,
		const base::String &	pSenderName,
		unsigned int	pSendInterval,
		const math::Vector< float > &	pMinParValue,
		const math::Vector< float > &	pMaxParValue
	)			throw (FlockException)

ParameterRegistration::ParameterRegistration	(	const base::String &	pSwarmName,
		const base::String &	pParameterName,
		const base::String &	pSenderName,
		unsigned int	pSendInterval,
		const math::Vector2< int > &	pAgentRange
	)			throw (FlockException)

ParameterRegistration::ParameterRegistration	(	const base::String &	pSwarmName,
		const base::String &	pParameterName,
		const base::String &	pSenderName,
		unsigned int	pSendInterval,
		const math::Vector2< int > &	pAgentRange,
		const math::Vector< float > &	pMinParValue,
		const math::Vector< float > &	pMaxParValue
	)			throw (FlockException)

ParameterRegistration::ParameterRegistration

(

const ParameterRegistration &

pRegistration

)

ParameterRegistration::~ParameterRegistration

(

)

---

Member Function Documentation

void ParameterRegistration::set

(

unsigned int

pSendInterval

)

throw (FlockException)

void ParameterRegistration::set	(	unsigned int	pSendInterval,
		const math::Vector2< int > &	pAgentRange
	)			throw (FlockException)

void ParameterRegistration::set	(	unsigned int	pSendInterval,
		const math::Vector< float > &	pMinParValue,
		const math::Vector< float > &	pMaxParValue
	)			throw (FlockException)

void ParameterRegistration::set	(	unsigned int	pSendInterval,
		const math::Vector2< int > &	pAgentRange,
		const math::Vector< float > &	pMinParValue,
		const math::Vector< float > &	pMaxParValue
	)			throw (FlockException)

const base::String & ParameterRegistration::swarmName

(

)

const

const base::String & ParameterRegistration::parameterName

(

)

const

const base::String & ParameterRegistration::senderName

(

)

const

unsigned int ParameterRegistration::sendInterval

(

)

const

unsigned int & ParameterRegistration::currentSendInterval

(

)

const math::Vector2< int > & ParameterRegistration::agentRange

(

)

const

bool ParameterRegistration::normalise

(

)

const

const math::Vector< float > & ParameterRegistration::minParValue

(

)

const

const math::Vector< float > & ParameterRegistration::maxParValue

(

)

const

const math::Vector< float > & ParameterRegistration::parValueScale

(

)

const

const math::Vector< float > & ParameterRegistration::parValueOffset

(

)

const

bool ParameterRegistration::operator==

(

const ParameterRegistration &

pRegistration

)

const

bool ParameterRegistration::match	(	const base::String &	pSwarmName,
		const base::String &	pParameterName
	)			const

---

Member Data Documentation

base::String iso::flock::ParameterRegistration::mSwarmName [protected]

base::String iso::flock::ParameterRegistration::mParameterName [protected]

base::String iso::flock::ParameterRegistration::mSenderName [protected]

math::Vector2<int> iso::flock::ParameterRegistration::mAgentRange [protected]

bool iso::flock::ParameterRegistration::mNormalise [protected]

math::Vector<float> iso::flock::ParameterRegistration::mMinParValue [protected]

math::Vector<float> iso::flock::ParameterRegistration::mMaxParValue [protected]

math::Vector<float> iso::flock::ParameterRegistration::mParValueScale [protected]

math::Vector<float> iso::flock::ParameterRegistration::mParValueOffset [protected]

unsigned int iso::flock::ParameterRegistration::mSendInterval [protected]

unsigned int iso::flock::ParameterRegistration::mCurrentSendInterval [protected]

---

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

• /Users/dbisig/programming/swarms/trunk/flock/trunk/code/core/com/iso_flock_com.h
• /Users/dbisig/programming/swarms/trunk/flock/trunk/code/core/com/iso_flock_com.cpp

---