bio::genetic::Localization Class Reference

#include <Localization.h>

Inheritance diagram for bio::genetic::Localization:

Collaboration diagram for bio::genetic::Localization:

Public Member Functions
virtual	~Localization ()
	BIO_DISAMBIGUATE_ALL_CLASS_METHODS (physical, Localization) explicit Localization(Site site
virtual Name	GetNameOfSite () const
virtual Site	GetSite () const
virtual chemical::Substance *	Seek (chemical::Substance *seekIn) const
virtual void	SetNameOfSite (Name name)
virtual void	SetSite (Site site)

Public Attributes
Name	name

Protected Member Functions
chemical::Substance *	ResolvePrevious (chemical::Substance *seekIn) const

Protected Attributes
Name	m_name
Localization *	m_previous
Site	m_site
chemical::ExcitationBase *	mc_method

Detailed Description

Localizations are a chain of named places. Each place is a different Localization, which has more places (Localizations) around it. This system allows us to traverse arbitrarily complex spaces with ease.

In order to use a standard interface with arbitrarily complex containers, we rely on physical::Perspective::AssociateType(), chemical::Excitation, and the chemical/structure system to provide us with a means of translating a Site (AssociateType) into a class method (Excitation) that is used to query a container by Name (structure). See genetic/Macros.h for an easy way to define all that (its not nearly as hard to use as it is to implement).

For specifying a series of places, we use the already existing physical::Wave Modulation system in reverse order; meaning the Modulated signal is what should be evaluated BEFORE *this. Evaluation here means Localization::Seek() (past tense as Sought). If you can imagine a real-life wave being modulated, that is, having smaller waves that it carries, then visualizing this system should be easy: the largest wave is what we really want to do, which can only happen once the smaller waves have been resolved; so, we take a large wave of interest and look deeper and deeper into its more subtle fluctuations as we search larger and larger contexts, until we find what we are seeking.

To create a localization, first select the kind of place you want from the available LocalizationTypes (in the localization_type namespace). Next, note the Name of the desired place. And, lastly, instantiate a Localization. If you would like to identify a place within another place, simple repeat and Modulate the first Localization with the second. For example, if you want to identify where the bathroom is within a restaurant, we would start with a Localization like {localization_site::Room(), "Bathroom"}, which might cause us to ask the nearest person for the "Bathroom". Next, we would create another Localization along the lines of {localization_site::StreetAddress(), "MyFavoriteRestaurant"}. In this case, StreetAddress would tell us to use a navigation app and maybe a car or taxi service to "extract" the restaurant form the world. Then, we say bathroomLocalization % restaurantLocalization. Thus, we end up with all the information necessary to "extract" the "Bathroom" from "MyFavoriteRestaurant".

Definition at line 56 of file Localization.h.

Constructor & Destructor Documentation

~Localization()

bio::genetic::Localization::~Localization ( )

virtual

Definition at line 43 of file Localization.cpp.

{
    if (m_name)
    {
        delete[] m_name;
        m_name = NULL;
    }
    if (mc_method)
    {
        delete mc_method;
        mc_method = NULL;
    }
}

Member Function Documentation

BIO_DISAMBIGUATE_ALL_CLASS_METHODS()

bio::genetic::Localization::BIO_DISAMBIGUATE_ALL_CLASS_METHODS	(	physical	,
		Localization
	)

Ensure virtual methods point to Class implementations.

Parameters

site
name

GetNameOfSite()

Name bio::genetic::Localization::GetNameOfSite ( ) const

virtual

Get the Name to use with m_site.

Returns

m_name.

Definition at line 114 of file Localization.cpp.

{
    return m_name;
}

GetSite()

Site bio::genetic::Localization::GetSite ( ) const

virtual

Get m_site.

Returns

m_site.

Definition at line 129 of file Localization.cpp.

{
    return m_site;
}

ResolvePrevious()

chemical::Substance * bio::genetic::Localization::ResolvePrevious ( chemical::Substance *  seekIn ) const

protected

To be run at the top of Seek.

Parameters

seekIn

Returns

the result of Seeking through all Modulated Localizations.

Definition at line 57 of file Localization.cpp.

{
    BIO_SANITIZE(seekIn, ,
        return seekIn);
 
    //TODO: What if *this has been Modulated with something other than a Localization?
    Localization* previous = ForceCast< Localization* >(Demodulate());
 
    if (previous)
    {
        seekIn = previous->Seek(seekIn);
    }
    return seekIn;
}

References BIO_SANITIZE, and Seek().

Seek()

chemical::Substance * bio::genetic::Localization::Seek ( chemical::Substance *  seekIn ) const

virtual

Find some place by following a chain of Localizations. Will recurse upward, following m_previous for as long as possible.

Parameters

seekIn

Returns

a Substance somewhere within the Substance provided or NULL.

Reimplemented in bio::genetic::Insertion.

Definition at line 72 of file Localization.cpp.

{
    seekIn = ResolvePrevious(seekIn);
 
    BIO_SANITIZE(seekIn, ,
        return seekIn);
 
    if (m_site == LocalizationSitePerspective::InvalidId())
    {
        return seekIn;
    }
 
    BIO_SANITIZE(mc_method, ,
        return NULL)
    ByteStream newName(m_name);
    (const_cast< chemical::ExcitationBase* >(mc_method))->EditArg(
        0,
        newName
    );
    ByteStream result;
    mc_method->CallDown(
        seekIn->AsWave(),
        result
    );
    chemical::Substance* extract = ChemicalCast< chemical::Substance* >(Cast< physical::Wave* >(result.IKnowWhatImDoing())); //This is about as safe as we can get right now.
    BIO_SANITIZE(extract, ,
        return NULL)
    return extract;
}

References bio::physical::Class< T >::AsWave(), BIO_SANITIZE, and bio::ByteStream::IKnowWhatImDoing().

Referenced by ResolvePrevious().

SetNameOfSite()

void bio::genetic::Localization::SetNameOfSite ( Name  name )

virtual

Set m_name.

Parameters

name

Definition at line 102 of file Localization.cpp.

{
    if (m_name)
    {
        delete[] m_name;
    }
    string::CloneInto(
        name,
        m_name
    );
}

References bio::string::CloneInto().

SetSite()

void bio::genetic::Localization::SetSite ( Site  site )

virtual

Set m_site.

Parameters

site

Reimplemented in bio::genetic::Insertion.

Definition at line 119 of file Localization.cpp.

{
    m_site = site;
    if (mc_method)
    {
        delete mc_method;
    }
    mc_method = LocalizationSitePerspective::Instance().GetNewObjectFromIdAs< chemical::ExcitationBase* >(m_site);
}

Member Data Documentation

m_name

Name bio::genetic::Localization::m_name

protected

Definition at line 123 of file Localization.h.

m_previous

Localization* bio::genetic::Localization::m_previous

protected

Definition at line 124 of file Localization.h.

m_site

Site bio::genetic::Localization::m_site

protected

Definition at line 122 of file Localization.h.

mc_method

chemical::ExcitationBase* bio::genetic::Localization::mc_method

protected

Definition at line 125 of file Localization.h.

name

Name bio::genetic::Localization::name

Initial value:

= NULL
    )

Definition at line 74 of file Localization.h.

---

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

• /home/eons/git/biology/lib_bio/inc/bio/genetic/localization/Localization.h
• /home/eons/git/biology/lib_bio/src/genetic/localization/Localization.cpp