#include <PeriodicTable.h>

Inheritance diagram for bio::chemical::PeriodicTableImplementation:

Collaboration diagram for bio::chemical::PeriodicTableImplementation:

Public Member Functions
	PeriodicTableImplementation ()

virtual	~PeriodicTableImplementation ()

virtual bool	AssociateType (AtomicNumber id, physical::Wave *type)

virtual bool	DisassociateType (AtomicNumber id)

template<typename T >
AtomicNumber	GetIdFromType ()

template<typename T >
AtomicNumber	GetIdFromType (const T t)

template<typename T >
Name	GetNameFromType () const

template<typename T >
Name	GetNameFromType (const T t) const

template<typename T >
const Properties	GetPropertiesOf () const

const Properties	GetPropertiesOf (AtomicNumber id) const

const Properties	GetPropertiesOf (Name name) const

virtual const physical::Wave *	GetTypeFromId (AtomicNumber id) const

AtomicNumber	RecordPropertiesOf (AtomicNumber id, Properties properties)

AtomicNumber	RecordPropertiesOf (Name name, Properties properties)

template<typename T >
AtomicNumber	RecordPropertiesOf (Properties properties)

AtomicNumber	RecordPropertyOf (AtomicNumber id, Property property)

AtomicNumber	RecordPropertyOf (Name name, Property property)

template<typename T >
AtomicNumber	RecordPropertyOf (Property property)

Public Member Functions inherited from bio::physical::Perspective< AtomicNumber >
	Perspective ()

virtual	~Perspective ()

virtual bool	AssociateType (Id id, Wave *type)

virtual bool	DisassociateType (Id id)

Hadits::iterator	Find (Id id)

Hadits::const_iterator	Find (Id id) const

virtual Id	GetIdFromName (Name name)

virtual Id	GetIdWithoutCreation (Name name) const

virtual Name	GetNameFromId (Id id) const

virtual Wave *	GetNewObjectFromId (Id id) const

T	GetNewObjectFromIdAs (Id id)

virtual Wave *	GetNewObjectFromName (Name name)

T	GetNewObjectFromNameAs (Name name)

virtual Id	GetNumUsedIds () const

virtual const Wave *	GetTypeFromId (Id id) const

const T	GetTypeFromIdAs (Id id) const

virtual const Wave *	GetTypeFromName (Name name) const

const T	GetTypeFromNameAs (Name name) const

virtual Id	GetUniqueIdFor (Name name)

Public Member Functions inherited from bio::ThreadSafe
	ThreadSafe ()

	ThreadSafe (const ThreadSafe &toCopy)

virtual	~ThreadSafe ()

void	LockThread () const

void	UnlockThread () const

Additional Inherited Members
Public Types inherited from bio::physical::Perspective< AtomicNumber >
typedef std::vector< Hadit >	Hadits

typedef AtomicNumber	Id

typedef std::vector< Id >	Ids

Static Public Member Functions inherited from bio::physical::Perspective< AtomicNumber >
static Id	InvalidId ()

static Name	InvalidName ()

Protected Attributes inherited from bio::physical::Perspective< AtomicNumber >
Hadits	m_hadits

Id	m_nextId

Detailed Description

The PeriodicTable is a stand-in for runtime type information (RTTI). Instead of having to rely on code compiled with RTTI enabled, we implement our own type tracking mechanism.

The PeriodicTable tracks Properties of types in addition to assigning them an AtomicNumber.. This is done because neither static nor virtual methods will allow for the inverted inheritance necessary to make inverted-inheritance methods like Atom::CallForAll work properly. See Elementary.h for a more detailed description of this system.

Definition at line 40 of file PeriodicTable.h.

Constructor & Destructor Documentation

◆ PeriodicTableImplementation()

bio::chemical::PeriodicTableImplementation::PeriodicTableImplementation ( )

Definition at line 55 of file PeriodicTable.cpp.

{
 
}

◆ ~PeriodicTableImplementation()

bio::chemical::PeriodicTableImplementation::~PeriodicTableImplementation ( )

virtual

Definition at line 60 of file PeriodicTable.cpp.

{
 
}

Member Function Documentation

◆ AssociateType()

bool bio::chemical::PeriodicTableImplementation::AssociateType	(	AtomicNumber	id,
		physical::Wave *	type
	)

virtual

Associates the given Wave type with the given id. This is only necessary if you want to use GetTypeFromId later on. Associating a type with an id has no effect on the Recorded Properties.

Parameters

id
type

Returns: true if the association completed successfully else false

Definition at line 146 of file PeriodicTable.cpp.

{
    Element* element = ForceCast< Element* >(Perspective::GetTypeFromId(id));
    BIO_SANITIZE(element, ,
        return false);
    LockThread();
    element->m_type = type;
    UnlockThread();
    return true;
}

References BIO_SANITIZE, bio::ThreadSafe::LockThread(), bio::chemical::Element::m_type, and bio::ThreadSafe::UnlockThread().

◆ DisassociateType()

bool bio::chemical::PeriodicTableImplementation::DisassociateType ( AtomicNumber id )

virtual

Removes the type association created by AssociateType(). Disassociating a type has no effect on the Recorded Properties.

Parameters

id

Returns: true if the association was removed else false.

Definition at line 160 of file PeriodicTable.cpp.

{
    Element* element = ForceCast< Element* >(Perspective::GetTypeFromId(id));
    BIO_SANITIZE(element, ,
        return false);
    LockThread();
    element->m_type = NULL;
    UnlockThread();
    return true;
}

References BIO_SANITIZE, bio::ThreadSafe::LockThread(), bio::chemical::Element::m_type, and bio::ThreadSafe::UnlockThread().

◆ GetIdFromType() [1/2]

template<typename T >

AtomicNumber bio::chemical::PeriodicTableImplementation::GetIdFromType ( )

inline

Template Parameters

T

Returns: the AtomicNumber associated with the given type.

Definition at line 81 of file PeriodicTable.h.

    {
        return GetIdFromName(GetNameFromType< T >());
    }

References bio::physical::Perspective< AtomicNumber >::GetIdFromName().

◆ GetIdFromType() [2/2]

template<typename T >

AtomicNumber bio::chemical::PeriodicTableImplementation::GetIdFromType ( const T t )

inline

For auto template determination.

Template Parameters

T

Parameters

t

Returns: the AtomicNumber associated with the given type.

Definition at line 93 of file PeriodicTable.h.

    {
        return GetIdFromType< T >();
    }

◆ GetNameFromType() [1/2]

template<typename T >

Name bio::chemical::PeriodicTableImplementation::GetNameFromType ( ) const

inline

Template Parameters

T

Returns: the Name associated with the given type.

Definition at line 59 of file PeriodicTable.h.

    {
        return TypeName< T >().c_str();
    }

◆ GetNameFromType() [2/2]

template<typename T >

Name bio::chemical::PeriodicTableImplementation::GetNameFromType ( const T t ) const

inline

For auto template determination.

Template Parameters

T

Parameters

t

Returns: the Name associated with the given type.

Definition at line 71 of file PeriodicTable.h.

    {
        return GetNameFromType< T >();
    }

◆ GetPropertiesOf() [1/3]

template<typename T >

const Properties bio::chemical::PeriodicTableImplementation::GetPropertiesOf ( ) const

inline

Template Parameters

T

Returns: whatever properties have been Recorded for the given type.

Definition at line 115 of file PeriodicTable.h.

    {
        return GetPropertiesOf(TypeName< T >().c_str());
    }

References GetPropertiesOf().

Referenced by GetPropertiesOf().

◆ GetPropertiesOf() [2/3]

const Properties bio::chemical::PeriodicTableImplementation::GetPropertiesOf ( AtomicNumber id ) const

Parameters

id

Returns: whatever properties have been Recorded for the given type.

Definition at line 65 of file PeriodicTable.cpp.

{
    Properties ret;
    Element* element = ForceCast< Element* >(Perspective::GetTypeFromId(id));
    BIO_SANITIZE(element, ,
        return ret);
    LockThread();
    ret = element->GetAllAsVector< Property >();
    UnlockThread();
    return ret;
}

References BIO_SANITIZE, bio::chemical::UnorderedStructureInterface::GetAllAsVector(), bio::ThreadSafe::LockThread(), bio::Properties, and bio::ThreadSafe::UnlockThread().

◆ GetPropertiesOf() [3/3]

const Properties bio::chemical::PeriodicTableImplementation::GetPropertiesOf ( Name name ) const

Parameters

name

Returns: whatever properties have been Recorded for the given type.

Definition at line 77 of file PeriodicTable.cpp.

{
    return GetPropertiesOf(GetIdWithoutCreation(name));
}

References bio::physical::Perspective< AtomicNumber >::GetIdWithoutCreation(), and GetPropertiesOf().

◆ GetTypeFromId()

const physical::Wave * bio::chemical::PeriodicTableImplementation::GetTypeFromId ( AtomicNumber id ) const

virtual

Only works if AssociateType has been called with the given id.

Parameters

id

Returns: the pointer to the Wave type associated with the given id else NULL.

Definition at line 138 of file PeriodicTable.cpp.

{
    Element* element = ForceCast< Element* >(Perspective::GetTypeFromId(id));
    BIO_SANITIZE(element, ,
        return NULL);
    return element->m_type;
}

References BIO_SANITIZE, and bio::chemical::Element::m_type.

◆ RecordPropertiesOf() [1/3]

AtomicNumber bio::chemical::PeriodicTableImplementation::RecordPropertiesOf	(	AtomicNumber	id,
		Properties	properties
	)

Add Properties to the given type's record in *this.

Parameters

id
properties

Returns: the given id.

Definition at line 106 of file PeriodicTable.cpp.

{
    typename Hadits::iterator hdt = Find(id);
    BIO_SANITIZE_AT_SAFETY_LEVEL_2(hdt == this->m_hadits.end(), ,
        return InvalidId());
 
    LockThread();
    Element* element = ForceCast< Element* >(hdt->m_type);
    if (!element)
    {
        element = new Element();
        hdt->m_type = element->AsWave();
    }
    element->Import< Property >(properties);
    UnlockThread();
    return id;
}

References bio::physical::Class< T >::AsWave(), BIO_SANITIZE_AT_SAFETY_LEVEL_2, bio::physical::Perspective< AtomicNumber >::Find(), bio::chemical::UnorderedStructureInterface::Import(), bio::physical::Perspective< AtomicNumber >::InvalidId(), bio::ThreadSafe::LockThread(), bio::physical::Perspective< AtomicNumber >::m_hadits, and bio::ThreadSafe::UnlockThread().

Referenced by RecordPropertiesOf(), and RecordPropertyOf().

◆ RecordPropertiesOf() [2/3]

AtomicNumber bio::chemical::PeriodicTableImplementation::RecordPropertiesOf	(	Name	name,
		Properties	properties
	)

Add Properties to the given type's record in *this.

Parameters

name
properties

Returns: the id of the given name.

Definition at line 127 of file PeriodicTable.cpp.

{
    return RecordPropertiesOf(
        GetIdFromName(name),
        properties
    );
}

References bio::physical::Perspective< AtomicNumber >::GetIdFromName(), and RecordPropertiesOf().

◆ RecordPropertiesOf() [3/3]

template<typename T >

AtomicNumber bio::chemical::PeriodicTableImplementation::RecordPropertiesOf ( Properties properties )

inline

Add Properties to the given type's record in *this.

Template Parameters

T

Parameters

properties

Returns: the id of the given type.

Definition at line 186 of file PeriodicTable.h.

    {
        return RecordPropertiesOf(
            TypeName< T >().c_str(),
            properties
        );
    }

References RecordPropertiesOf().

◆ RecordPropertyOf() [1/3]

AtomicNumber bio::chemical::PeriodicTableImplementation::RecordPropertyOf	(	AtomicNumber	id,
		Property	property
	)

Add a Property to the given type's record in *this.

Parameters

id
property

Returns: the id given.

Definition at line 82 of file PeriodicTable.cpp.

{
    Properties properties;
    properties.push_back(property);
    return RecordPropertiesOf(
        id,
        properties
    );
}

References bio::Properties, and RecordPropertiesOf().

Referenced by RecordPropertyOf().

◆ RecordPropertyOf() [2/3]

AtomicNumber bio::chemical::PeriodicTableImplementation::RecordPropertyOf	(	Name	name,
		Property	property
	)

Add a Property to the given type's record in *this.

Parameters

name
property

Returns: the id of the given name.

Definition at line 95 of file PeriodicTable.cpp.

{
    return RecordPropertyOf(
        GetIdFromName(name),
        property
    );
}

References bio::physical::Perspective< AtomicNumber >::GetIdFromName(), and RecordPropertyOf().

◆ RecordPropertyOf() [3/3]

template<typename T >

AtomicNumber bio::chemical::PeriodicTableImplementation::RecordPropertyOf ( Property property )

inline

Add a Property to the given type's record in *this.

Template Parameters

T

Parameters

property

Returns: the id of the given typo.

Definition at line 149 of file PeriodicTable.h.

    {
        return RecordPropertyOf(
            TypeName< T >().c_str(),
            property
        );
    }

References RecordPropertyOf().

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

/home/eons/git/biology/lib_bio/inc/bio/chemical/PeriodicTable.h
/home/eons/git/biology/lib_bio/src/chemical/PeriodicTable.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PeriodicTableImplementation()

◆ ~PeriodicTableImplementation()

Member Function Documentation

◆ AssociateType()

◆ DisassociateType()

◆ GetIdFromType() [1/2]

◆ GetIdFromType() [2/2]

◆ GetNameFromType() [1/2]

◆ GetNameFromType() [2/2]

◆ GetPropertiesOf() [1/3]

◆ GetPropertiesOf() [2/3]

◆ GetPropertiesOf() [3/3]

◆ GetTypeFromId()

◆ RecordPropertiesOf() [1/3]

◆ RecordPropertiesOf() [2/3]

◆ RecordPropertiesOf() [3/3]

◆ RecordPropertyOf() [1/3]

◆ RecordPropertyOf() [2/3]

◆ RecordPropertyOf() [3/3]