Function_Block_Base.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file      Function_Block_Base.h
//! @brief     Function block base class header file.
//! @copyright ANVILEX LLC
//! @attention No special attention requered.
//!            $HeadURL: https://192.168.3.4:8443/svn/P004_07/ConOpSys/Blocks/Function_Block_Base.h $
//!            $Revision: 2946 $
//!            $Date: 2022-02-27 01:12:30 +0500 (So, 27 Feb 2022) $
//!            $Author: minch $
//
// Copyright(C) 2004-2020 ANVILEX LLC
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice,
//    this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright notice,
//    this list of conditions and the following disclaimer in the documentation
//    and/or other materials provided with the distribution.
//
// 3. Neither the name of ANVILEX nor the names of its contributors may be
//    used to endorse or promote products derived from this software without
//    specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
//
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Protecting header files from mutual, recursive inclusion.
//------------------------------------------------------------------------------
 
#pragma once
 
//------------------------------------------------------------------------------
// Include standard libraries header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Include thrid party header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Include ConOpSys header files
//------------------------------------------------------------------------------
 
#include "ConOpSys_Target.h"
 
#if CONOPSYS_TARGET == CONOPSYS_TARGET_VDC
 
#include <Classes.hpp>
#include <Controls.hpp>
#include <StdCtrls.hpp>
#include <ExtCtrls.hpp>
#include <IniFiles.hpp>
 
#endif
 
#include "Application_Resource_Configuration.h"
#include "Protocol_Base.h"
#include "Block_Input_Connector.h"
#include "Block_Output_Connector.h"
#include "Function_Block_Defines.h"
 
//#include "Core_Template.h"
//#include "Footer_Template.h"
//#include "Parameters_Template.h"
 
//------------------------------------------------------------------------------
// Macros
//------------------------------------------------------------------------------
 
#if CONOPSYS_TARGET == CONOPSYS_TARGET_DEVICE
 
//! @brief Function block base class for device
class TFunction_Block_Base
 
#elif CONOPSYS_TARGET == CONOPSYS_TARGET_VDC
 
//! @brief Function block base class for VDC tool
class TFunction_Block_Base : public TWinControl
 
#endif
{
 
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
 
  public:
  
    //--------------------------------------------------------------------------
    // Public defines
    //--------------------------------------------------------------------------
  
    //! @brief Function block ststus
    typedef union
    {
      
      //! @brief Function block status as raw data
      U32 u32_Status_Raw_Data;
      
      //! @brief Function block status as but fields
      struct
      {
        
        //! @brief Bit 0: Initialised flag 
        U32 bit1_Initialised:1;
        
        //! @brief Bit 1: Connected flag 
        U32 bit1_Connected:1;
        
        //! @brief Bit 2: Initialisation error flag 
        U32 bit1_Initialisation_Error:1;
        
        //! @brief Bits 3-31: Reserved
        U32 bit29_Reserved:29;
 
      };
      
    } TFunction_Block_Status;
    
    //--------------------------------------------------------------------------
    // Public methods
    //--------------------------------------------------------------------------
 
    //!-------------------------------------------------------------------------
    //! @brief     Class constructor method.
    //! @note      None
    //! @param     [in] u32_Function_ID - Function block ID
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    TFunction_Block_Base( U32 u32_Function_ID );
 
    //!-------------------------------------------------------------------------
    //! @brief     Class destructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    virtual ~TFunction_Block_Base();
 
    //!-------------------------------------------------------------------------
    //! @brief     Function block connect method
    //! @note      This method set function block connected status 
    //! @param     None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Connect();
 
    //!-------------------------------------------------------------------------
    //! @brief     Function block initialisation method
    //! @note      None
    //! @param     None
    //! \par       Override
    //!            Optional
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Init();
 
    //!-------------------------------------------------------------------------
    //! @brief     Function block finalisation method
    //! @note      None
    //! @param     None
    //! \par       Override
    //!            Optional
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Done();
 
    //!-------------------------------------------------------------------------
    //! @brief     Update parameters at runtime method
    //! @note      This is experemental functionality
    //! @param     None
    //! \par       Override
    //!            Optional
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Update();
 
    //!-------------------------------------------------------------------------
    //! @brief     Function block execute method
    //! @note      Body of this method must be implemented according function block requerements
    //! @param     None
    //! \par       Override
    //!            Requered
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Execute() = 0;
 
    //!-------------------------------------------------------------------------
    //! @brief     Function block trip method
    //! @note      implement in this method emergency trip functions related to hardware reconfoguration
    //! @param     None
    //! \par       Override
    //!            Oprional
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Trip();
 
    //!-------------------------------------------------------------------------
    //! @brief     Get function block dentifier
    //! @note      None
    //! @return    U32 - Function block identifier
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    U32 Get_Function_Block_ID();
 
    //!-------------------------------------------------------------------------
    //! @brief     Set function block initialisation error
    //! @note      None
    //! @param     None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Set_Initialisation_Error();
 
    //!-------------------------------------------------------------------------
    //! @brief     Return function block initialisation error status
    //! @note      None
    //! @return    BOOL - Function block  initialisation error status
    //! @param     None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    BOOL Is_Initialisation_Error();
 
    //!-------------------------------------------------------------------------
    //! @brief     Append interconnection status of the function block
    //! @note      None
    //! @param     [out] *bool_Connected_Status - Pointer to the function block interconnection status variable
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Append_Connected_Status( BOOL *bool_Connected_Status );
    
    //!-------------------------------------------------------------------------
    //! @brief     Returns status of the function block interconnection
    //! @note      None
    //! @return    BOOL - Interconnection status of the function block inputs
    //! @retval    false - Function block has invalid interconnection of the inputs
    //! @retval    true - Function block has valid interconnection of the inputs
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    BOOL Is_Connected();
 
    //!-------------------------------------------------------------------------
    //! @brief     Returns status of the function block interconnection
    //! @note      None
    //! @return    BOOL - Function block initialisation status
    //! @retval    false - Function block initialised with errors
    //! @retval    true - Function block initialised without errors
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    BOOL Is_Initialised();
 
    //!-------------------------------------------------------------------------
    //! @brief     Get pointer to the input connector
    //! @note      None
    //! @param     [in] u32_Connector_Index - Input connector index
    //! @param     [out] **object_Input_Connector - Pointer to the input connector storage
    //! @return    BOOL - Method execution status
    //! @retval    false - Input connector not found
    //! @retval    true - Input connector found
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    BOOL Get_Input_Connector( U32 u32_Connector_Index, TBlock_Input_Connector **object_Input_Connector );
 
    //!-------------------------------------------------------------------------
    //! @brief     Get pointer to the output connector
    //! @note      None
    //! @param     [in] u32_Connector_Index - Output connector index
    //! @param     [out] **object_Output_Connector - Pointer to the output connector storage
    //! @return    BOOL - Method execution status
    //! @retval    false - Input connector not found
    //! @retval    true - Input connector found
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    BOOL Get_Output_Connector( U32 u32_Connector_Index, TBlock_Output_Connector **object_Output_Connector );
 
    //!-------------------------------------------------------------------------
    //! @brief     Get function block status method
    //! @note      None
    //! @param     None
    //! @return    TFunction_Block_Status - Function block status
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    TFunction_Block_Status Get_Status();
 
    //!-------------------------------------------------------------------------
    //! @brief     Send information about Function block over communication link protocol
    //! @note      This method sends information about Function block over specified communication link protocol.
    //! @param     [in] *object_Protocol - Pointer to the communication link protocol
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Send_Information( TProtocol_Base *object_Protocol );
 
  //----------------------------------------------------------------------------
  // Public defines, methods and variables related to VDC tool
  //----------------------------------------------------------------------------
 
  #if CONOPSYS_TARGET == CONOPSYS_TARGET_VDC
 
  public:
 
    //--------------------------------------------------------------------------
    // Public methods relared to VDC tool
    //--------------------------------------------------------------------------
 
    __fastcall TBlock_Template( TComponent* Owner, TList *Storage );
    
    __fastcall ~TBlock_Template();
    
    void __fastcall CreateBlock();
    
    virtual void __fastcall Paint();
    
    virtual bool __fastcall PropertiesDialog();
    
    virtual void __fastcall SaveToProjectFile( TMemIniFile *ProjectFile, AnsiString ParentSection );
    
    virtual void __fastcall LoadFromProjectFile( TMemIniFile *ProjectFile, AnsiString ParentSection );
    
    virtual void __fastcall SwapBlocks();
    
    virtual void __fastcall RepaintAllBlocks();
  
    VOID __fastcall Load_Block_From_List( TStringList *object_File_Source_CPP, TStringList *object_File_Source_H );
    
    VOID __fastcall Get_SQL_Queries( TStringList *object_SQL_Queries );
    
    //.... Other methods related to VDC tool
 
    //--------------------------------------------------------------------------
    // Public variables relared to VDC tool
    //--------------------------------------------------------------------------
  
    // Pointer to storage of the blocks
    TList *StorageOfBlocks = (TList*)NULL;            
  
    // ID of the block
    int BlockID;                          
  
    // Count of input connectors
    int InputConnectorsCount;   
 
    // Count of output connectors
    int OutputConnectorsCount;   
    
    // Storage of input connectors
    TList *StorageOfInputConnectors;
    
    // Storage of output connectors
    TList *StorageOfOutputConnectors;
    
    // Block core
    TCore_Template *Core;
    
    // Block footer
    TFooter_Template *Footer;             
    
    // Pointer to parameters
    // ANVILEX KM: Depricated
    TParameters_Template *Parameters;     
    
    // Function block autosize ststus
    bool AutoSize;
    
    // Function block icon
    Graphics::TBitmap *Icon;
 
    //--------------------------------------------------------------------------
    // Public properties relared to VDC tool
    //--------------------------------------------------------------------------
 
    __property TNotifyEvent OnInputConnectorSelected = { read = FOnInputConnectorSelected, write = FOnInputConnectorSelected };
    
    __property TNotifyEvent OnOutputConnectorSelected = { read = FOnOutputConnectorSelected, write = FOnOutputConnectorSelected };
    
    __property TNotifyEvent OnCoreSelected = { read = FOnCoreSelected, write = FOnCoreSelected };
    
    __property TNotifyEvent OnModified = { read = FModified, write = FModified };
    
    __property TNotifyEvent OnNeedToUpdate = { read = FNeedToUpdate, write = FNeedToUpdate };
    
    __property TResolveConnectorAddressEvent OnResolveConnectorAddress = { read = FOnResolveConnectorAddress, write = FOnResolveConnectorAddress };
    
    __property AnsiString Label = { read = FLabel, write = FLabel };
    
    __property BOOL Border = { read = FBorder, write = FBorder, default = true };
    
    __property BOOL Selected = { read = FSelected, write = SetSelectedFlag, default = false };
    
    __property BOOL Flipped = { read = FFlipped, write = SetFlippedFlag, default = false };
 
  #endif
 
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
 
  protected:
 
    //--------------------------------------------------------------------------
    // Protected methods
    //--------------------------------------------------------------------------
 
    //!-------------------------------------------------------------------------
    //! @brief     Updates function block interconnection status
    //! @note      None
    //! @param     [in] bool_New_Connected_Status - New status
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Update_Connected_Status( BOOL bool_New_Connected_Status );
 
    //!-------------------------------------------------------------------------
    //! @brief     Create event method
    //! @note      None
    //! @param     [in] u32_Event_ID - Event identifier
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Create_Event( U32 u32_Event_ID );
 
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables related to VDC tool
  //----------------------------------------------------------------------------
 
  #if CONOPSYS_TARGET == CONOPSYS_TARGET_VDC
 
  protected:
 
    //--------------------------------------------------------------------------
    // Protected methods related to VDC tool
    //--------------------------------------------------------------------------
 
    void __fastcall SetSelectedFlag( bool Value );             // Set selected flag
    void __fastcall SetFlippedFlag( bool Value );              // Set flipped flag
    virtual void __fastcall SetNamesOfConnectors();            // Set names of the connectors
    void __fastcall CorePaint( TObject *Sender );
 
    //--------------------------------------------------------------------------
    // Protected variables related to VDC tool
    //--------------------------------------------------------------------------
 
    // Pointer to the modified method
    TNotifyEvent FModified;
  
    // Pointer to the need to update method
    TNotifyEvent FNeedToUpdate;                                
  
    // Pointer to the input connector selected method
    TNotifyEvent FOnInputConnectorSelected;                    
 
    // Method storage
    TNotifyEvent FOnOutputConnectorSelected;                   
    
    TNotifyEvent FOnCoreSelected;                              
    
    TResolveConnectorAddressEvent FOnResolveConnectorAddress;  
    
    //! @brief Function block label of the core string
    AnsiString FLabel = "";                                    
    
    //! @brief Function block border status
    BOOL FBorder = (BOOL)true;                                 
    
    //! @brief Function block seleted status
    BOOL FSelected = (BOOL)false;                              
    
    //! @brief Function block flipped status
    BOOL FFlipped = (BOOL)false;                               
    
    // Locked mode flag
    BOOL LockedMode = (BOOL)false;                             
    
    // Double clicked flag
    BOOL DobbleClicked = (BOOL)false;                          
    
    // Locked X position
    U32 u32_Locked_Position_X = (U32)0;                                          
    
    // Locked Y position
    U32 u32_Locked_Position_Y = (U32)0;                                          
 
  #endif
 
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
 
  private:
 
    //--------------------------------------------------------------------------
    // Private variables
    //--------------------------------------------------------------------------
  
    //! @brief Function block function block identifier
    U32 u32_Function_Block_ID = (U32)0;
 
    //! @brief Function block status
    TFunction_Block_Status struct_Status = { .u32_Status_Raw_Data = (U32)0x00000000 };
  
//    U32 u32_Condition;               //!< Condition storage
//    U32 u32_Warning_Condition_Mask;  //!< Warning condition mask
//    U32 u32_Alarm_Condition_Mask;    //!< Alarm condition mask
//    U32 u32_Trip_Condition_Mask;     //!< Trip condition mask
 
  //----------------------------------------------------------------------------
  // Private defines, methods and variables related to VDC tool
  //----------------------------------------------------------------------------
 
  private:
 
    #if CONOPSYS_TARGET == CONOPSYS_TARGET_VDC
 
    //--------------------------------------------------------------------------
 
    void __fastcall NeedToUpdate( TObject *object_Sender );
    
    //--------------------------------------------------------------------------
 
    void __fastcall Modified( TObject *object_Sender );
 
    //--------------------------------------------------------------------------
 
    void __fastcall OnClick( TObject *object_Sender );
 
    //--------------------------------------------------------------------------
 
    void __fastcall OnDblClick( TObject *object_Sender );
    
    //--------------------------------------------------------------------------
    
    void __fastcall OnMouseDown( TObject *object_Sender, TMouseButton Button, TShiftState Shift, int int_X, int int_Y );
 
    //--------------------------------------------------------------------------
 
    void __fastcall OnMouseUp( TObject *object_Sender, TMouseButton Button, TShiftState Shift, int int_X, int int_Y );
    
    //--------------------------------------------------------------------------
 
    void __fastcall OnMouseMove( TObject *object_Sender, TShiftState Shift, int int_X, int int_Y );
    
    //--------------------------------------------------------------------------
 
    void __fastcall OnInputConnectorClick( TObject *Sender );
    
    //--------------------------------------------------------------------------
 
    void __fastcall OnOutputConnectorClick( TObject *Sender );
    
    //--------------------------------------------------------------------------
 
    void __fastcall ResolveConnectorAddress( TObject *Sender, TConnectorAddress *Address );
    
    //--------------------------------------------------------------------------
    // Private variables related to VDC tool
    //--------------------------------------------------------------------------
 
    TStringList *object_Source_CPP = (TStringList*)NULL;
    TStringList *object_Source_H = (TStringList*)NULL;
    
    TUTF8String utf8_string_Name = "";
    TUTF8String utf8_string_Description = "";
    
    TObjectList *object_Parameter_Connector_List = (TObjectList*) = NULL;
    TObjectList *object_Input_Connector_List = (TObjectList*) = NULL;
    TObjectList *object_Output_Parameter_List = (TObjectList*) = NULL;
 
    #endif
    
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------