inputpage.h

/*
BSD 3-Clause License

Copyright (c) Alliance for Energy Innovation, LLC. See also https://github.com/NatLabRockies/SAM/blob/develop/LICENSE
All rights reserved.

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 the copyright holder 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.
*/


#ifndef __inputpage_h
#define __inputpage_h

#include <wx/panel.h>
#include <wex/uiform.h>

#include <lk/env.h>

#include "variables.h"
#include "equations.h"
#include "case.h"

class Case;
class CaseWindow;
class ActiveInputPage;

class UICallbackContext  : public CaseCallbackContext
{
	ActiveInputPage *m_inputPage;
public:
	UICallbackContext( ActiveInputPage *ip, const wxString &desc = wxEmptyString );	
	ActiveInputPage *InputPage();
	CaseWindow *GetCaseWindow();
protected:
	virtual void SetupLibraries( lk::env_t *env );
};

class ActiveInputPage : public wxPanel
{
public:
	ActiveInputPage( wxWindow *parent, wxUIFormData *form, CaseWindow *cw, size_t ndx_hybrid,
		int id = wxID_ANY, const wxPoint &pos = wxDefaultPosition, const wxSize &size = wxDefaultSize );
	virtual ~ActiveInputPage();
	
	// initialize by running any existing callbacks for it
	void Initialize();

	// Find() will look for an object on this specific input page
	wxUIObject *Find( const wxString &name );

	// FindActiveObject() can be overridden ( eg ActiveInputPage, casewin.cpp )
	// to locate an object that may reside on a different page
	virtual wxUIObject *FindActiveObject( const wxString &name, ActiveInputPage **page );
	wxString GetName() const { return m_formData->GetName(); }

	std::vector<wxUIObject*> GetObjects();
	VarInfoLookup &GetVariables(size_t i);
	EqnFastLookup &GetEquations(size_t i);
	VarTable &GetValues(size_t i);
	Case *GetCase();
	CaseWindow *GetCaseWindow();	

	size_t GetHybridIndex() { return m_ndxHybrid; }

	// This one is called when a UI event occurs, 
	// as when a user changes the value in an input control.
	// The implementation of this virtual method
	// in descendent classes is responsible
	// for handling the data exchange between the object
	// and any associated variable.
	// if any variable values are changed in the table
	// this function must also call any methods to (i.e. Case->Changed(...) )
	// propagate the changes (i.e. equations) to affected variables
	
	// Note: when a variable is changed programmatically (i.e. UI callback, or otherwise)
	// and the UI subsystem needs to be notified to update the
	// widget corresponding to a variable accordingly, the correct
	// way to handle this is to call GetCase()->VariableChanged(..)
	void OnUserInputChanged( wxUIObject *obj );

	
	// data exchange from UI object to data value and vice versa
	enum DdxDir { OBJ_TO_VAR, VAR_TO_OBJ };
	// static for parametric
	static bool DataExchange( Case *c, wxUIObject *obj, VarValue &val, DdxDir dir, size_t analysis_period = 0, size_t ndxHybrid=0);

protected:
	
	// to draw labels & units
	void OnErase( wxEraseEvent & );
	void OnPaint( wxPaintEvent & );

	// handler(s) for child widget changes
	void OnNativeEvent( wxCommandEvent & );
	

	bool LoadFile( const wxString &file );
	wxUIFormData *m_formData;
	bool m_formDataOwned;

	double m_scaleX, m_scaleY;
	void UpdateScale( wxDC *dc );
	wxSize ScaleSize( const wxSize &s );
	wxRect ScaleRect( const wxRect &r );

private:
	CaseWindow *m_cwin;
	Case *m_case;
	size_t m_ndxHybrid; // hybrid index for variables, varinfos and equations
	
	DECLARE_EVENT_TABLE();
};

typedef unordered_map<wxString, wxUIFormData*, wxStringHash, wxStringEqual> FormDataHash;
class UIFormDatabase
{
public:
	UIFormDatabase();
	~UIFormDatabase();
	void Add( const wxString &name, wxUIFormData *data );
	wxUIFormData *Lookup( const wxString &name );
	void Clear();
private:
	FormDataHash m_hash;
};
#endif