---

StructureUnit.h

Go to the documentation of this file.

#ifndef StructureUnitH
#define StructureUnitH

/*******************************************************************************
Copyright 2000,2001,2002 Petr Kulhanek

    This file is part of Core plugin.

    Core plugin is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    Core plugin is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with Core plugin; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*******************************************************************************/
/*******************************************************************************
** COPYRIGHT (C):       1998,1999,2000 All Rights Reserved
** PROJEKT:             Projekt NEMESIS
** SOUBOR:              StructureUnit
** úÈEL:                slouží pro popis a manipulaci se strukturní jednotkou
** VERZE:               1.0
** JAZYK:               CBuilder C++
** CÍLOVÝ POÈÍTAÈ:      IBM PC
** PROGRAMÁTOR:         Petr Kulhánek
** HISTORIE úPRAV:
VERZE   DATUM       POZNÁMKA
1.0             2000-11-30      vznik modulu
*******************************************************************************/

/* HLAVIÈKOVÉ SOUBORY *********************************************************/

#include "CoreMainHeader.h"
#include "Atom.h"
#include "ContainerEnumerator.h"
#include "IndexCounter.h"

/* KONEC HLAVIÈKOVÝCH SOUBORù *************************************************/

class CElementsRecord;
class CMolecule;
class CAtom;
class CStructureUnitsList;
class CStructureUnit;

/* DEFINICE TØÍD **************************************************************/


class NEMESIS_CORE_PACKAGE CStructureUnitData {
        public:
 // konstruktor a destruktor ---------------------------------------------------
        __fastcall CStructureUnitData(void);
        __fastcall ~CStructureUnitData(void);

 // vstupnì - výstuptní operace ------------------------------------------------
    friend ostream& __fastcall operator << (ostream& str,const CStructureUnitData& su);
    friend istream& __fastcall operator >> (istream& str,CStructureUnitData& su);

 // inicializace dat a obnova dat ----------------------------------------------
    void                        __fastcall GetFromStructureUnit(CStructureUnit* unit);
    CStructureUnit* __fastcall MakeStructureUnit(CMolecule* molecule,CElementsRecord* history=NULL);
    inline int          __fastcall GetStructureUnitIndex(void) const;

    void __fastcall SetNumOfAtoms(int atoms);

 // sekce soukromých dat -------------------------------------------------------
    public:
    CExtUUID                    ExtUUID;                        // uuid objektu
    int                                 StructureUnitIndex;     // index jednotky
    CSmallString                Name;               // jméno jednotky
    CSmallString                Description;        // popis jednotky
    CSmallString        UnitName;           // jméno jednotky
    CExtObject::CStatus Status;             // status jednotky
    int                                 NumOfAtoms;         // poèet atomù v jednotce
    int*                                AtomsIndexArea;         // pole indexù tvoøící strukturní jednotku
    };

//------------------------------------------------------------------------------


class NEMESIS_CORE_PACKAGE CStructureUnit : public CExtObject{
    public:
 // konstrukce - destrukce objektu ---------------------------------------------
                        __fastcall CStructureUnit(CStructureUnitsList* baselist,CPluginObjectInfo* objectinfo);
            __fastcall ~CStructureUnit(void);
    void        __fastcall RemoveFromBaseList(CElementsRecord* history=NULL);

 // operace zaznamenávané do historylistu --------------------------------------
    bool __fastcall Delete(void); // odstraní strukturní jednotku

 // zjiš�ovací metody ----------------------------------------------------------
        bool                                    __fastcall IsModified(void);    // zjistí zda byla jednotka modifikována
    inline CMolecule*           __fastcall GetMolecule(void);
    CSmallString                __fastcall GetFullUnitName(void);
    inline const CSmallString&  __fastcall GetUnitName(void);
    inline void                 __fastcall SetUnitName(const CSmallString& name);
    inline void                 __fastcall SetUnitID(int unit_id);
    inline int                  __fastcall GetUnitID(void);

 // registrování a odregistrování atomu ze strukturní jednotky -----------------
    bool        __fastcall RegisterAtom(CAtom* atom,int index);
    bool        __fastcall UnregisterAtom(int index);
    void        __fastcall SetNumOfAtoms(int atoms);
    inline int  __fastcall GetNumOfAtoms(void);
    CAtom*      __fastcall GetAtom(int index);

 // metody - uložení a naètení unitu -------------------------------------------
    bool __fastcall Load(CXMLElement* p_el);
    bool __fastcall Save(CXMLElement* p_el);

    virtual void __fastcall RemoveFromRegistered(CExtObject* object,CElementsRecord* history=NULL);

 // sekce soukromých dat -------------------------------------------------------
    protected:
    CStructureUnitsList* FBaselist;         // výchozí list
    CSmallString        FUnitName;          // jméno jednotky
    int                                 NumOfAtoms;         // poèet atomù v jednotce
    CAtom**                             AtomsArea;                  // pole atomù tvoøící strukturní jednotku
    bool                Modified;           // jednotka je modifikovana
    int                 UnitID;
    friend class CStructureUnitData;
    };

//------------------------------------------------------------------------------

DECLARE_EVENT(StructureUnit_IsModified);

//------------------------------------------------------------------------------


class NEMESIS_CORE_PACKAGE CStructureUnitsList : public CExtObject, public CTemplList<CStructureUnit> {
    public:
 // konstruktor a destruktor ---------------------------------------------------
        __fastcall CStructureUnitsList(CMolecule* molecule);

 // vkládání strukturní jednotky -----------------------------------------------
        CStructureUnit* __fastcall AddStructureUnit(CStructureUnitData& data,CElementsRecord* history=NULL);
        CStructureUnit* __fastcall AddStructureUnit(const CUUID& uuid);

 // zjiš�ování vlastností ------------------------------------------------------
        __property CMolecule* Molecule = {read = FMolecule};

    bool __fastcall Load(CXMLElement* p_el);
    bool __fastcall Save(CXMLElement* p_el);

    public:
    CIndexCounter   NameIndexer;    // base counter for structure unit name index

 // sekce soukromých dat -------------------------------------------------------
    private:
    CMolecule*      FMolecule;  // mother molecule
    };

// -----------------------------------------------------------------------------

DECLARE_EVENT(StructureUnitsList_AddStructureUnit);
DECLARE_EVENT(StructureUnitsList_RemoveStructureUnit);

// ----------------------------------------------------------------------------
// ############################################################################
// ----------------------------------------------------------------------------

extern CPluginObjectInfo StructureUnitEnumObjectInfo;
extern CExtUUID          ID_StructureUnitEnum;

// ----------------------------------------------------------------------------


class CStructureUnitEnumerator : public CContainerEnumerator {
    public:
        __fastcall CStructureUnitEnumerator(CComObject* owner,CMolecule* molecule);

    virtual int __fastcall NumOfCommands(void);
    virtual CSmallString __fastcall GetCommand(int i,bool& enabled);
    virtual bool __fastcall DoCommand(int i);

 // sekce zabývající se popisem objektù v kontejneru ---------------------------
    virtual int         __fastcall NumOfObjects(void);
    virtual bool        __fastcall PrepareObjects(int startpos,int size,int rstart,int rend);
    virtual CExtObject* __fastcall GetObject(int pos);

 // funkce pro rozšíøený popis objektù a kontejnerù ----------------------------
    virtual int __fastcall NumOfColumns(void);  // poèet sloupcù popisujících objekt
    virtual const CSmallString __fastcall GetColumnCaption(int index); // popis sloupce
    virtual const CSmallString __fastcall GetObjectProperty(int index); // vlastnost objektu
    virtual int __fastcall GetObjectImageIndex(void);

    virtual void __fastcall ProcessEvent(const CEventIdentifier& event,CExtObject* Sender,void* p_data);

    virtual CExtObject* __fastcall GetCurrentObject(void);
    virtual bool        __fastcall SetCurrentObject(CExtObject* p_object);

    private:
    CStructureUnitsList*             StructureUnits;
    CTemplIterator<CStructureUnit>   Pointer;
    CStructureUnit*                  CurrentObject;
    int                              StartPos;
    int                              EndPos;
    bool                             Changed;
    CSimpleList<CStructureUnit>      CurrentView;
    };

// ----------------------------------------------------------------------------

extern CPluginObjectInfo SingleStructureUnitEnumObjectInfo;
extern CExtUUID          ID_SingleStructureUnitEnum;

// ----------------------------------------------------------------------------


class CSingleStructureUnitEnumerator : public CContainerEnumerator {
    public:
        __fastcall CSingleStructureUnitEnumerator(CComObject* owner,CStructureUnit* p_str);

    virtual int __fastcall NumOfCommands(void);
    virtual CSmallString __fastcall GetCommand(int i,bool& enabled);
    virtual bool __fastcall DoCommand(int i);

 // sekce zabývající se popisem objektù v kontejneru ---------------------------
    virtual int         __fastcall NumOfObjects(void);
    virtual CExtObject* __fastcall GetObject(int pos);

 // funkce pro rozšíøený popis objektù a kontejnerù ----------------------------
    virtual int __fastcall NumOfColumns(void);  // poèet sloupcù popisujících objekt
    virtual const CSmallString __fastcall GetColumnCaption(int index); // popis sloupce
    virtual const CSmallString __fastcall GetObjectProperty(int index); // vlastnost objektu
    virtual int __fastcall GetObjectImageIndex(void);

    virtual void __fastcall ProcessEvent(const CEventIdentifier& event,CExtObject* Sender,void* p_data);

    virtual CExtObject* __fastcall GetCurrentObject(void);
    virtual bool        __fastcall SetCurrentObject(CExtObject* p_object);

    private:
    CStructureUnit*  StructureUnit;
    CAtom*           CurrentObject;
    bool             Changed;
    };

// ----------------------------------------------------------------------------
// ############################################################################
// ----------------------------------------------------------------------------

/*  TØÍDA: CStructureUnitDataHistory
    ÚÈEL:  slouží pro záznam zmìn souvisejících s destrukcí èi vznikem CStructureUnit
*/

class CStructureUnitDataHistory : public CElementData{
        public:
                                __fastcall CStructureUnitDataHistory(CStructureUnit* p_unit,bool create);

    private:
    virtual void        __fastcall Forward(void);
    virtual void        __fastcall Backward(void);

    CStructureUnitData  Data;
    CMolecule*                  Molecule;
    CStructureUnit*             Unit;
    };

// ----------------------------------------------------------------------------
// ############################################################################
// ----------------------------------------------------------------------------

class CStructureUnitUnregHistory: public CElementData{
    public:
    __fastcall CStructureUnitUnregHistory(CStructureUnit* p_str,CAtom* p_atom,int index,bool regobject);

    private:
    CMolecule*  Molecule;
    int         StructureUnitIndex;
    int         AtomIndex;
    int         AtomPositionIndex;

    virtual void __fastcall Forward(void);
    virtual void __fastcall Backward(void);
    };

/* KONEC DEFINICE TØÍD ********************************************************/

inline int __fastcall CStructureUnitData::GetStructureUnitIndex(void) const
{
 return(StructureUnitIndex);
}

// -----------------------------------------------------------------------------

inline CMolecule* __fastcall CStructureUnit::GetMolecule(void)
{
 return(FBaselist->Molecule);
}

// -----------------------------------------------------------------------------

inline int __fastcall CStructureUnit::GetNumOfAtoms(void)
{
 return(NumOfAtoms);
}

// -----------------------------------------------------------------------------

inline const CSmallString&  __fastcall CStructureUnit::GetUnitName(void)
{
 return(FUnitName);
}

// -----------------------------------------------------------------------------

inline void __fastcall CStructureUnit::SetUnitName(const CSmallString& name)
{
 FUnitName = name;
}

// -----------------------------------------------------------------------------

inline void __fastcall CStructureUnit::SetUnitID(int unit_id)
{
 UnitID = unit_id;
}

// -----------------------------------------------------------------------------

inline int __fastcall CStructureUnit::GetUnitID(void)
{
 return(UnitID);
}

// -----------------------------------------------------------------------------

#endif

---