#include <Axis.h>

Inheritance diagram for bio::chemical::Axis:

Collaboration diagram for bio::chemical::Axis:

Public Member Functions
	Axis ()

virtual	~Axis ()

virtual std::string	Rotate (Symmetry *symmetry) const

Public Member Functions inherited from bio::physical::Axis
	Axis ()

virtual	~Axis ()

virtual Symmetry *	operator() (std::string encoded) const

virtual std::string	operator\| (Wave *particle) const

virtual Symmetry *	Rotate (std::string) const

virtual std::string	Rotate (Symmetry *symmetry) const

Additional Inherited Members
Static Public Member Functions inherited from bio::physical::Axis
static std::string	Failed ()

Protected Member Functions inherited from bio::physical::Axis
virtual std::string	Encode (Symmetry *symmetry) const

Detailed Description

chemical::Axes simplify the Axis definition process by leveraging the nested nature of chemical::Symmetry. All you need to do to make an Axis using chemical::Axis is define Encode(Symmetry*) and Rotate(std::string).

Definition at line 35 of file Axis.h.

Constructor & Destructor Documentation

◆ Axis()

bio::chemical::Axis::Axis ( )

Definition at line 29 of file Axis.cpp.

{
 
}

◆ ~Axis()

bio::chemical::Axis::~Axis ( )

virtual

Reimplemented from bio::physical::Axis.

Definition at line 34 of file Axis.cpp.

{
 
}

Member Function Documentation

◆ Rotate()

std::string bio::chemical::Axis::Rotate ( Symmetry * symmetry ) const

virtual

Express the given Symmetry into something intelligible by another system. Takes advantage of Encode and chemical::Symmetry to make defining Axes easier. You shouldn't have to override this from here on out. NOTE: this does not apply to Rotate(std::string); you'll still need to override that one.

Parameters

symmetry

Returns: text, possibly a command (like mysql), structured values (like json), an entire program (like python), etc. or Failed().

Definition at line 39 of file Axis.cpp.

{
    std::string ret = "";
    ret += Encode(symmetry);
    Container* toRotate = symmetry->GetAll< Symmetry* >();
    for (
        SmartIterator sym = toRotate->Begin();
        !sym.IsAtEnd();
        ++sym
        )
    {
        ret += Rotate(sym.As< Symmetry* >());
    }
 
    return ret;
}

References bio::Container::Begin(), bio::physical::Axis::Encode(), bio::chemical::UnorderedStructureInterface::GetAll(), bio::SmartIterator::IsAtEnd(), and Rotate().

Referenced by Rotate().

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

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