AMSmartProperties::AMPropertyBase Class Reference

Base interface and basic fuction for smart property. Most of these funcions can be used, whenever you have only reference to base class. But, in spite of this base class is not virtual, you can't instantiate it directly. More...

#include <AMProperty.h>

Inheritance diagram for AMSmartProperties::AMPropertyBase:

Collaboration diagram for AMSmartProperties::AMPropertyBase:

Public Member Functions
AMPropertyPool &	getPool () const
	Get the pool assigned to property. More...
void	setPool (AMPropertyPool &newPool)
	Move property from one pool to another. More...
AMPropertyBase *	getNext () const
	Do not use it directly! More...
void	resetState ()
	Reset state od property. This function is not intenden for use in common operation.
bool	isNonComputed () const
	Information about property. More...
void	setNoComputedFlag ()
	Information about property Set flag that property is not already computed. More...
void	setNoComputed (bool noComputed)
	Information about property. More...
bool	getComputingFlag ()
	Information about property. More...
bool	isInProgress ()
	Information about property. More...
void	runLoop ()
	Sets operation mode to loop. More...
void	runDeleted ()
	Sets operation mode to deleted. It works, if current mode is normal. More...
AMPropertyState	getState (AMPropertyState valueOnly) const
	Get state (AMSmartProperties::AMPropertyState) of property. Bits 0,1 comes from this property. Bit 2 is given from inherited class. Oher bits, 3,4 comes from AMSmartProperties::AMProperyPool. Warning! If parameter valueOnly has set any other bits than (0, AMPropertyState::VALUEONLY), result is undefined. More...
std::string	to_string () const
	Debug helper. Simple dumps property into std::string. More...

Detailed Description

Base interface and basic fuction for smart property. Most of these funcions can be used, whenever you have only reference to base class. But, in spite of this base class is not virtual, you can't instantiate it directly.

Member Function Documentation

getComputingFlag()

bool AMSmartProperties::AMPropertyBase::getComputingFlag ( )

inline

Information about property.

Returns

true if property is computing. (Signals computing and calls another property)

Exceptions

This	function will not throw an exception.

getNext()

AMPropertyBase* AMSmartProperties::AMPropertyBase::getNext ( ) const

inline

Do not use it directly!

Returns

Next property in pool. You may iterate over all properties in AMSmartProperties::AMProperyPool.

Exceptions

This	function will not throw an exception.

getPool()

AMPropertyPool& AMSmartProperties::AMPropertyBase::getPool ( ) const

inline

Get the pool assigned to property.

Returns

The pool reference (AMSmartProperties::AMPropertyPool).

Exceptions

This	function will not throw an exception.

getState()

AMPropertyState AMSmartProperties::AMPropertyBase::getState ( AMPropertyState  valueOnly ) const

inline

Get state (AMSmartProperties::AMPropertyState) of property. Bits 0,1 comes from this property. Bit 2 is given from inherited class. Oher bits, 3,4 comes from AMSmartProperties::AMProperyPool. Warning! If parameter valueOnly has set any other bits than (0, AMPropertyState::VALUEONLY), result is undefined.

Parameters

valueOnly

this one bit information comes from inherited class.

Returns

state (AMSmartProperties::AMPropertyState)

Exceptions

This	function will not throw an exception.

References AMSmartProperties::to_string().

isInProgress()

bool AMSmartProperties::AMPropertyBase::isInProgress ( )

inline

Information about property.

Returns

true if property computing is in progress. (was called by another property)

Exceptions

This	function will not throw an exception.

isNonComputed()

bool AMSmartProperties::AMPropertyBase::isNonComputed ( ) const

inline

Information about property.

Returns

true if property was not been computed since last reset.

Exceptions

This	function will not throw an exception.

runDeleted()

void AMSmartProperties::AMPropertyBase::runDeleted

(

)

Sets operation mode to deleted. It works, if current mode is normal.

Exceptions

This	function will not throw an exception.

runLoop()

void AMSmartProperties::AMPropertyBase::runLoop

(

)

Sets operation mode to loop.

Exceptions

This	function will not throw an exception.

setNoComputed()

void AMSmartProperties::AMPropertyBase::setNoComputed ( bool  noComputed )

inline

Information about property.

Parameters

noComputed

Set/reset flag that property is not already computed.

Exceptions

This	function will not throw an exception.

setNoComputedFlag()

void AMSmartProperties::AMPropertyBase::setNoComputedFlag ( )

inline

Information about property Set flag that property is not already computed.

Exceptions

This	function will not throw an exception.

setPool()

void AMSmartProperties::AMPropertyBase::setPool ( AMPropertyPool &  newPool )

inline

Move property from one pool to another.

Parameters

newPool

new AMSmartProperties::AMProperyPool in which should be this property placed.

Exceptions

This	function will not throw an exception.

to_string()

std::string AMSmartProperties::AMPropertyBase::to_string

(

)

const

Debug helper. Simple dumps property into std::string.

Returns

stringstream

Exceptions

This	function will not throw an exception.

---

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

• include/AMSmartProperties/AMProperty.h