Calculates the time response by a frequency domain transfer function. More...

#include <TransferFunction.h>

Inheritance diagram for TransferFunction:

[legend]

Collaboration diagram for TransferFunction:

[legend]

Classes
struct	SpaceState

Public Member Functions
	TransferFunction (int id)

virtual void	DrawDC (GUIColour guiColour, wxPoint2DDouble translation, double scale, wxGraphicsContext gc) const
	Draw the element using GDI+.

virtual bool	Contains (wxPoint2DDouble position) const
	Checks if the element contains a position.

virtual bool	Intersects (wxRect2DDouble rect) const
	Check if the element's rect intersects other rect.

virtual bool	ShowForm (wxWindow parent, Element element, wxWindow *workspace=nullptr)
	Show element data form.

virtual void	Rotate (bool clockwise=true)
	Rotate the element.

virtual void	SetFont (wxFont &font)

virtual std::vector< double >	GetNumerator () const

virtual std::vector< double >	GetDenominator () const

virtual void	SetNumerator (std::vector< double > numerator)

virtual void	SetDenominator (std::vector< double > denominator)

virtual void	UpdateTFText ()

virtual bool	UpdateText ()
	Update the OpenGL text in the element (if present).

virtual SpaceState	GetSpaceState ()

virtual void	CalculateSpaceState (int maxIteration=100, double error=1e-3)
	Convert the transfer function to space state on controllable canonical form (CCF).

virtual bool	Solve (double *input, double timeStep)
	Calculates the time response by the space state form of transfer function.

virtual void	GetTFString (wxString &numerator, wxString &denominator)

virtual rapidxml::xml_node *	SaveElement (rapidxml::xml_document<> &doc, rapidxml::xml_node<> *elementListNode)

virtual bool	OpenElement (rapidxml::xml_node<> *elementNode)

virtual Element *	GetCopy ()
	Get a the element copy.

Public Member Functions inherited from ControlElement
	ControlElement (int id)

virtual void	StartMove (wxPoint2DDouble position)
	Update the element attributes related to the movement.

virtual void	Move (wxPoint2DDouble position)
	Move the element other position.

void	SetNodeList (std::vector< Node * > nodeList)

std::vector< Node * >	GetNodeList () const

virtual void	DrawDCNodes (wxGraphicsContext *gc) const

virtual void	ReplaceNode (Node oldNode, Node newNode)

virtual bool	IsSolved () const

virtual void	SetSolved (bool solved=true)

virtual bool	Initialize ()

virtual double	GetOutput () const

virtual void	SetOutput (double output)

Public Member Functions inherited from Element
	Element ()
	Constructor.

virtual	~Element ()
	Destructor.

void	SetDragging (bool dragging=true)
	Set if the element are being dragged.

void	SetHeight (double height)
	Set element height.

void	SetPosition (const wxPoint2DDouble position)
	Set the element position and update the rectangle.

void	SetSelected (bool selected=true)
	Set element selection.

void	SetWidth (double width)
	Set element width.

void	SetAngle (double angle)
	Set element angle.

void	ShowPickbox (bool showPickbox=true)
	Set if the pickbox is shown.

void	SetBorderSize (double borderSize)
	Set the size of the border (shown in selected elements).

bool	SetOnline (bool online=true)
	Set if the element is online or offline.

virtual void	SetPointList (std::vector< wxPoint2DDouble > pointList)
	Set the list of points that connect the element to the bus.

ElementType	GetElementType ()

wxRect2DDouble	GetRect () const
	Get the element rectangle.

wxPoint2DDouble	GetPosition () const
	Get the element position.

bool	IsDragging () const
	Checks if the element is being dragged.

double	GetHeight () const
	Get the element height.

bool	IsSelected () const
	Checks if the element is selected.

double	GetWidth () const
	Get the element width.

double	GetAngle () const
	Get the element angle.

double	GetRotationAngle () const
	Get the angle of rotation.

bool	IsPickboxShown () const
	Checks if the pickbox is shown.

bool	IsOnline () const
	Checks if the element is online or offline.

virtual std::vector< wxPoint2DDouble >	GetPointList () const
	Get the list of points that connect the element to bus.

virtual bool	AddParent (Element *parent, wxPoint2DDouble position)
	Add a parent to the element. This method must be used on power elements that connect to a bus, so the parent must be a bus. The element basic points are calculated in this method, so apply this when the element is being inserted.

virtual void	AddParent (Element *parent)
	Add a parent to the element.

virtual void	SetID (int id)
	Set the element ID.

virtual int	GetID () const
	Get the element ID.

virtual void	AddChild (Element *child)
	Add a child to the child list.

virtual void	RemoveChild (Element *child)
	Remove a child from the list.

virtual void	ReplaceChild (Element oldChild, Element newChild)
	Replace a child from the list.

virtual wxString	GetTipText () const
	Get the tip text.

virtual void	DrawDC (GUIColour *guiColour, wxPoint2DDouble translation, double scale, wxDC &dc) const
	Draw the element using wxDC.

virtual bool	GetContextMenu (wxMenu &menu)
	Get the element contex menu.

virtual void	AddPoint (wxPoint2DDouble point)
	Add point to the list of points that connect the element to the bus.

virtual void	MoveNode (Element *parent, wxPoint2DDouble position)
	Move a node. StartMove(wxPoint2DDouble position) before start moving.

virtual bool	NodeContains (wxPoint2DDouble position)
	Check if a node contains a point. If contains, set the attributes related to node movement.

virtual void	UpdateNodes ()
	Update the nodes according to the parents. If a parent is removed, use this method.

void	SetParent (Element *parent, int num)

void	SetChild (Element *child, int num)

virtual bool	SetNodeParent (Element *parent)
	Set a perent to the node. If all conditions are met, a new parent are added to the element and the points related to the nodes will be calculated.

virtual void	RemoveParent (Element *parent)
	Remove a parent.

virtual void	ReplaceParent (Element oldParent, Element newParent)
	Replace a parent.

virtual void	RotateNode (Element *parent, bool clockwise=true)
	Rotate a node.

virtual bool	PickboxContains (wxPoint2DDouble position)
	Check if a pickbox contains a point. If contains the attributes related to pickbox movement will be calculated.

virtual void	MovePickbox (wxPoint2DDouble position)
	Move the pickbox.

virtual wxCursor	GetBestPickboxCursor () const
	Get the best cursor to shown to the user when the mouse is above a pickbox.

virtual void	ResetPickboxes ()
	Remove the pickboxes.

virtual void	ResetNodes ()
	Remove the active nodes.

virtual wxPoint2DDouble	WorldToScreen (wxPoint2DDouble translation, double scale, double offsetX=0.0, double offsetY=0.0) const
	Convert the element position to screen position.

virtual wxPoint2DDouble	WorldToScreen (wxPoint2DDouble position, wxPoint2DDouble translation, double scale, double offsetX=0.0, double offsetY=0.0) const
	Convert a generic position to screen position.

virtual bool	RotatedRectanglesIntersects (wxRect2DDouble rect1, wxRect2DDouble rect2, double angle1, double angle2) const
	Check if two roteted rectangles intersect.

virtual void	DrawDCRectangle (wxPoint2DDouble position, double width, double height, double angle, wxDC &dc) const
	Draw a circle.

virtual void	DrawDCRoundedRectRotated (wxDC &dc, const wxPoint2DDouble &center, double width, double height, double radius, double angleDeg, int arcSegments=8) const

virtual void	DrawDCCircle (wxPoint2DDouble position, double radius, int numSegments, wxGraphicsContext *gc) const
	Draw a circle using device context.

virtual void	DrawDCCircle (wxPoint2DDouble position, double radius, wxDC &dc) const

virtual void	DrawDCArc (wxPoint2DDouble position, double radius, double initAngle, double finalAngle, int numSegments, wxGraphicsContext *gc) const

virtual void	DrawDCArc (wxPoint2DDouble position, double radius, double initAngle, double finalAngle, wxDC &dc) const

virtual void	DrawDCTriangle (std::vector< wxPoint2DDouble > points, wxGraphicsContext *gc) const
	Draw rectangle.

virtual void	DrawDCTriangle (std::vector< wxPoint > points, wxDC &dc) const

virtual void	DrawDCPickbox (wxPoint2DDouble position, wxGraphicsContext *gc) const
	Draw a point.

virtual wxPoint2DDouble	RotateAtPosition (wxPoint2DDouble pointToRotate, double angle, bool degrees=true) const
	Rotate a point as element position being the origin.

virtual wxPoint2DDouble	RotateLocal (wxPoint2DDouble local, double angleDeg) const

virtual wxPoint	RotateAround (const wxPoint2DDouble &p, const wxPoint2DDouble &center, double angleDeg) const

virtual std::vector< Element * >	GetParentList () const
	Get the parent list.

virtual std::vector< Element * >	GetChildList () const
	Get the Child list.

virtual void	CalculateBoundaries (wxPoint2DDouble &leftUp, wxPoint2DDouble &rightBottom) const
	Calculate the element boundaries.

virtual void	GeneralMenuItens (wxMenu &menu)
	Insert general itens to context menu.

virtual double	PointToLineDistance (wxPoint2DDouble point, int *segmentNumber=nullptr) const
	Calculate the distance between a line (formed by point list) and a point.

bool	IsInserted () const
	Check if the element is properly inserted in the workspace.

void	SetInserted (bool inserted=true)
	Set if the element is properly inserted in the workspace.

void	SaveCADProperties (rapidxml::xml_document<> &doc, rapidxml::xml_node<> *elementNode)

bool	OpenCADProperties (rapidxml::xml_node<> *elementNode)

Protected Member Functions
virtual void	SetText (wxString numerator, wxString denominator)

virtual wxString	GetSuperscriptNumber (int number)

Protected Member Functions inherited from ControlElement
void	SaveControlNodes (rapidxml::xml_document<> &doc, rapidxml::xml_node<> *elementNode)

bool	OpenControlNodes (rapidxml::xml_node<> *elementNode)

Protected Attributes
wchar_t	m_supNumber [10]

GCText *	m_gcTextNum = nullptr

GCText *	m_gcTextDen = nullptr

std::vector< double >	m_numerator

std::vector< double >	m_denominator

SpaceState	m_ss

std::vector< double >	m_x

std::vector< double >	m_dx

double	m_error = 1e-3

int	m_maxIteration = 100

Protected Attributes inherited from ControlElement
std::vector< Node * >	m_nodeList

bool	m_solved = false

double	m_output = 0.0

Protected Attributes inherited from Element
ElementType	m_elementType = ElementType::TYPE_NONE

int	m_elementID = 0

std::vector< Element * >	m_parentList

std::vector< Element * >	m_childList

wxRect2DDouble	m_rect

wxPoint2DDouble	m_position

double	m_width = 0.0

double	m_height = 0.0

double	m_angle = 0.0

double	m_borderSize = 2.0

double	m_rotationAngle = 45.0

double	m_switchSize = 10.0

std::vector< wxRect2DDouble >	m_switchRect

bool	m_selected = false

bool	m_dragging = false

bool	m_showPickbox = false

bool	m_inserted = false

int	m_activePickboxID = ID_PB_NONE

int	m_activeNodeID = 0

std::vector< wxPoint2DDouble >	m_pointList

std::vector< wxPoint2DDouble >	m_movePts

wxPoint2DDouble	m_moveStartPt

wxPoint2DDouble	m_movePos

bool	m_online = true

Additional Inherited Members
Static Public Member Functions inherited from ControlElement
static ControlElement *	GetControlElementFromID (std::vector< std::shared_ptr< ControlElement > > elementList, int id)

Static Public Member Functions inherited from Element
static bool	DoubleFromString (wxWindow *parent, wxString strValue, double &value, wxString errorMsg)
	Get a double value from a string. Show a error message if the conversion fail.

static bool	IntFromString (wxWindow *parent, wxString strValue, int &value, wxString errorMsg)
	Convert a string to int. Show a error message if the conversion fail.

static wxString	StringFromDouble (double value, int minDecimal=1, int maxDecimals=13)
	Convert a double value to string.

Detailed Description

Calculates the time response by a frequency domain transfer function.

Author: Thales Lima Oliveira thale.nosp@m.s@uf.nosp@m.u.br

Date: 06/10/2017

Definition at line 36 of file TransferFunction.h.

Constructor & Destructor Documentation

◆ TransferFunction()

TransferFunction::TransferFunction ( int id )

Definition at line 21 of file TransferFunction.cpp.

                                         : ControlElement(id)
{
    // Superscript unicode numbers
    m_supNumber[0] = L'\u2070';
    m_supNumber[1] = L'\u00B9';
    m_supNumber[2] = L'\u00B2';
    m_supNumber[3] = L'\u00B3';
    m_supNumber[4] = L'\u2074';
    m_supNumber[5] = L'\u2075';
    m_supNumber[6] = L'\u2076';
    m_supNumber[7] = L'\u2077';
    m_supNumber[8] = L'\u2078';
    m_supNumber[9] = L'\u2079';
 
    m_numerator.clear();
    m_numerator.push_back(1);
    m_denominator.clear();
    m_denominator.push_back(1);
    m_denominator.push_back(1);
    UpdateTFText();
 
    Node* node1 = new Node(m_position + wxPoint2DDouble(-m_width / 2, 0), Node::NodeType::NODE_IN, m_borderSize);
    node1->StartMove(m_position);
    Node* node2 = new Node(m_position + wxPoint2DDouble(m_width / 2, 0), Node::NodeType::NODE_OUT, m_borderSize);
    node2->SetAngle(180.0);
    node2->StartMove(m_position);
    m_nodeList.push_back(node1);
    m_nodeList.push_back(node2);
}

◆ ~TransferFunction()

TransferFunction::~TransferFunction ( )

Definition at line 51 of file TransferFunction.cpp.

{
    //if (m_glTextDen) delete m_glTextDen;
    if (m_gcTextDen) delete m_gcTextDen;
    if (m_gcTextNum) delete m_gcTextNum;
    //if (m_glTextNum) delete m_glTextNum;
    for (auto& node : m_nodeList) if (node) delete node;
    m_nodeList.clear();
}

Member Function Documentation

◆ CalculateSpaceState()

void TransferFunction::CalculateSpaceState	(	int	maxIteration = `100`,
		double	error = `1e-3`
	)

virtual

Convert the transfer function to space state on controllable canonical form (CCF).

Parameters

maxIteration	Max number of solution iteration.
error	Tolerance for calculation.

Definition at line 288 of file TransferFunction.cpp.

{
    m_maxIteration = maxIteration;
    m_error = error;
 
    int order = static_cast<int>(m_denominator.size());
    std::vector<double> denominator = m_denominator;
    std::vector<double> numerator;
 
    //[Ref.] http://lpsa.swarthmore.edu/Representations/SysRepTransformations/TF2SS.html
    int k = order;
    for (int i = 0; i < order; i++) {
        int numIndex = i - (order - static_cast<int>(m_numerator.size()));
        if (numIndex < 0)
            numerator.push_back(0.0);
        else
            numerator.push_back(m_numerator[numIndex]);
        k--;
    }
 
    SpaceState ss;
    for (int i = 0; i < (order - 1); i++) {
        std::vector<double> lineA;
        for (int j = 0; j < (order - 1); j++) {
            if (j == i + 1)
                lineA.push_back(1.0);
            else
                lineA.push_back(0.0);
        }
        ss.A.push_back(lineA);
        ss.B.push_back(0.0);
        ss.C.push_back(0.0);
    }
    for (int i = 0; i < order - 1; i++) {
        ss.A[order - 2][i] = -(denominator[order - 1 - i] / denominator[0]);
        ss.C[i] = numerator[order - 1 - i] / denominator[0] -
            (denominator[order - 1 - i] / denominator[0]) * (numerator[0] / denominator[0]);
    }
    ss.B[order - 2] = 1.0;
    ss.D = numerator[0] / denominator[0];
 
    m_ss = ss;
 
    // Reset state
    m_x.clear();
    m_dx.clear();
 
    for (unsigned int i = 0; i < m_denominator.size(); ++i) {
        m_x.push_back(0.0);
        m_dx.push_back(0.0);
    }
}

◆ Contains()

virtual bool TransferFunction::Contains ( wxPoint2DDouble position ) const

inlinevirtual

Checks if the element contains a position.

Parameters

position Position to be checked.

Implements Element.

Definition at line 51 of file TransferFunction.h.

51{ return m_rect.Contains(position); }

◆ DrawDC()

void TransferFunction::DrawDC	(	GUIColour *	guiColour,
		wxPoint2DDouble	translation,
		double	scale,
		wxGraphicsContext *	gc
	)		const

virtual

Draw the element using GDI+.

Parameters

guiColour	Colours of the system defined in properties.
translation	Translation of the system.
scale	Scale of the system.
gc	Graphics context

Reimplemented from Element.

Definition at line 61 of file TransferFunction.cpp.

{
    if (m_selected) {
        gc->SetPen(*wxTRANSPARENT_PEN);
        gc->SetBrush(wxBrush(guiColour->selection));
        double borderSize = (m_borderSize * 2.0 + 1.0) / scale;
        gc->DrawRectangle(m_position.m_x - m_width / 2 - borderSize / 2, m_position.m_y - m_height / 2 - borderSize / 2, m_width + borderSize, m_height + borderSize);
    }
    gc->SetPen(wxPen(guiColour->enabled));
    gc->SetBrush(wxBrush(guiColour->background));
    gc->DrawRectangle(m_position.m_x - m_width / 2, m_position.m_y - m_height / 2, m_width, m_height);
 
    wxPoint2DDouble linePts[2];
    linePts[0] = wxPoint2DDouble(m_position.m_x - m_width / 2 + 5 + m_borderSize, m_position.m_y);
    linePts[1] = wxPoint2DDouble(m_position.m_x + m_width / 2 - 5 - m_borderSize, m_position.m_y);
    gc->StrokeLines(2, linePts);
 
    gc->SetPen(*wxTRANSPARENT_PEN);
    gc->SetBrush(wxBrush(guiColour->enabled));
    DrawDCNodes(gc);
 
    //glColor4d(0.0, 0.0, 0.0, 1.0);
    m_gcTextNum->Draw(m_position + wxPoint2DDouble(-m_gcTextNum->GetWidth() / 2, -m_height / 4 - m_gcTextNum->GetHeight() / 2), gc,0.0, guiColour->text);
    m_gcTextDen->Draw(m_position + wxPoint2DDouble(-m_gcTextDen->GetWidth() / 2, m_height / 4 - m_gcTextDen->GetHeight() / 2), gc, 0.0, guiColour->text);
}

Here is the call graph for this function:

◆ GetCopy()

Element * TransferFunction::GetCopy ( )

virtual

Get a the element copy.

Returns: Copy of the element.

Reimplemented from Element.

Definition at line 403 of file TransferFunction.cpp.

{
    TransferFunction* copy = new TransferFunction(*this);
    copy->m_gcTextNum = m_gcTextNum ? m_gcTextNum->GetCopy() : nullptr;
    copy->m_gcTextDen = m_gcTextDen ? m_gcTextDen->GetCopy() : nullptr;
    return copy;
}

Here is the call graph for this function:

◆ GetDenominator()

virtual std::vector< double > TransferFunction::GetDenominator ( ) const

inlinevirtual

Definition at line 58 of file TransferFunction.h.

58{ return m_denominator; }

◆ GetNumerator()

virtual std::vector< double > TransferFunction::GetNumerator ( ) const

inlinevirtual

Definition at line 57 of file TransferFunction.h.

57{ return m_numerator; }

◆ GetSpaceState()

virtual SpaceState TransferFunction::GetSpaceState ( )

inlinevirtual

Definition at line 63 of file TransferFunction.h.

63{ return m_ss; }

◆ GetSuperscriptNumber()

wxString TransferFunction::GetSuperscriptNumber ( int number )

protectedvirtual

Definition at line 107 of file TransferFunction.cpp.

{
    wxString strNumber = wxString::Format("%d", number);
    wxString superscriptStr = "";
    for (int i = 0; i < (int)strNumber.length(); ++i) {
        wxString digitStr = strNumber[i];
        long digit = 0;
        digitStr.ToLong(&digit);
        superscriptStr += wxString(m_supNumber[digit]);
    }
    return superscriptStr;
}

◆ GetTFString()

void TransferFunction::GetTFString	(	wxString &	numerator,
		wxString &	denominator
	)

virtual

Definition at line 120 of file TransferFunction.cpp.

{
    numerator = "";
    denominator = "";
    int index = static_cast<int>(m_numerator.size()) - 1;
    for (auto it = m_numerator.begin(), itEnd = m_numerator.end(); it != itEnd; ++it) {
        double value = *it;
        if (value != 0.0) {
            wxString signal;
            if (index == static_cast<int>(m_numerator.size()) - 1) {
                if (value >= 0.0)
                    signal += "";
                else
                    signal += "-";
            }
            else {
                if (value >= 0.0)
                    signal += "+ ";
                else
                    signal += "- ";
            }
 
            if (index == 0) {
                numerator += signal + StringFromDouble(std::abs(value), 0);
                break;
            }
            else if (index == 1) {
                if (value == 1.0) {
                    numerator += signal + "s";
                }
                else {
                    numerator += signal + StringFromDouble(std::abs(value), 0) + "s";
                }
            }
            else {
                if (value == 1.0) {
                    numerator += signal + "s" + GetSuperscriptNumber(index);
                }
                else {
                    numerator += signal + StringFromDouble(std::abs(value), 0) + "s" + GetSuperscriptNumber(index);
                }
            }
            numerator += " ";
        }
        --index;
    }
 
    index = static_cast<int>(m_denominator.size()) - 1;
    for (auto it = m_denominator.begin(), itEnd = m_denominator.end(); it != itEnd; ++it) {
        double value = *it;
        if (value != 0.0) {
            wxString signal;
            if (index == static_cast<int>(m_denominator.size()) - 1) {
                if (value >= 0.0)
                    signal += "";
                else
                    signal += "-";
            }
            else {
                if (value >= 0.0)
                    signal += "+ ";
                else
                    signal += "- ";
            }
 
            if (index == 0) {
                denominator += signal + StringFromDouble(std::abs(value), 0);
                break;
            }
            else if (index == 1) {
                if (value == 1.0) {
                    denominator += signal + "s";
                }
                else {
                    denominator += signal + StringFromDouble(std::abs(value), 0) + "s";
                }
            }
            else {
                if (value == 1.0) {
                    denominator += signal + "s" + GetSuperscriptNumber(index);
                }
                else {
                    denominator += signal + StringFromDouble(std::abs(value), 0) + "s" + GetSuperscriptNumber(index);
                }
            }
            denominator += " ";
        }
        --index;
    }
}

◆ Intersects()

virtual bool TransferFunction::Intersects ( wxRect2DDouble rect ) const

inlinevirtual

Check if the element's rect intersects other rect.

Parameters

rect	Rect to check intersection.

Implements Element.

Definition at line 52 of file TransferFunction.h.

52{ return m_rect.Intersects(rect); }

◆ OpenElement()

bool TransferFunction::OpenElement ( rapidxml::xml_node<> * elementNode )

virtual

Reimplemented from Element.

Definition at line 443 of file TransferFunction.cpp.

{
    if (!OpenCADProperties(elementNode)) return false;
    if (!OpenControlNodes(elementNode)) return false;
 
    // Element properties
    std::vector<double> numerator, denominator;
    m_numerator.clear();
    m_denominator.clear();
    auto numeratorNode = elementNode->first_node("Numerator");
    auto nValue = numeratorNode->first_node("Value");
    while (nValue) {
        double value = 0.0;
        wxString(nValue->value()).ToCDouble(&value);
        m_numerator.push_back(value);
        nValue = nValue->next_sibling("Value");
    }
    auto denominatorNode = elementNode->first_node("Denominator");
    auto dValue = denominatorNode->first_node("Value");
    while (dValue) {
        double value = 0.0;
        wxString(dValue->value()).ToCDouble(&value);
        m_denominator.push_back(value);
        dValue = dValue->next_sibling("Value");
    }
    StartMove(m_position);
    UpdateTFText();
 
    return true;
}

◆ Rotate()

void TransferFunction::Rotate ( bool clockwise = true )

virtual

Rotate the element.

Parameters

clockwise True to rotate clockwise, false to rotate counter-clockwise.

Reimplemented from Element.

Definition at line 246 of file TransferFunction.cpp.

{
    if (clockwise)
        m_angle += 90.0;
    else
        m_angle -= 90.0;
    if (m_angle >= 360.0)
        m_angle = 0.0;
    else if (m_angle < 0)
        m_angle = 270.0;
 
    if (m_angle == 0.0) {
        m_nodeList[0]->SetPosition(m_position + wxPoint2DDouble(-m_width / 2, 0));
        m_nodeList[1]->SetPosition(m_position + wxPoint2DDouble(m_width / 2, 0));
    }
    else if (m_angle == 90.0) {
        m_nodeList[0]->SetPosition(m_position + wxPoint2DDouble(0, -m_height / 2));
        m_nodeList[1]->SetPosition(m_position + wxPoint2DDouble(0, m_height / 2));
    }
    else if (m_angle == 180.0) {
        m_nodeList[0]->SetPosition(m_position + wxPoint2DDouble(m_width / 2, 0));
        m_nodeList[1]->SetPosition(m_position + wxPoint2DDouble(-m_width / 2, 0));
    }
    else if (m_angle == 270.0) {
        m_nodeList[0]->SetPosition(m_position + wxPoint2DDouble(0, m_height / 2));
        m_nodeList[1]->SetPosition(m_position + wxPoint2DDouble(0, -m_height / 2));
    }
 
    for (auto it = m_nodeList.begin(), itEnd = m_nodeList.end(); it != itEnd; ++it) {
        Node* node = *it;
        node->Rotate(clockwise);
    }
}

◆ SaveElement()

rapidxml::xml_node * TransferFunction::SaveElement	(	rapidxml::xml_document<> &	doc,
		rapidxml::xml_node<> *	elementListNode
	)

virtual

Reimplemented from Element.

Definition at line 419 of file TransferFunction.cpp.

{
    auto elementNode = XMLParser::AppendNode(doc, elementListNode, "TransferFunction");
    XMLParser::SetNodeAttribute(doc, elementNode, "ID", m_elementID);
 
    SaveCADProperties(doc, elementNode);
    SaveControlNodes(doc, elementNode);
 
    // Element properties
    auto numeratorNode = XMLParser::AppendNode(doc, elementNode, "Numerator");
    for (unsigned int i = 0; i < m_numerator.size(); ++i) {
        auto value = XMLParser::AppendNode(doc, numeratorNode, "Value");
        XMLParser::SetNodeValue(doc, value, m_numerator[i]);
    }
    auto denominatorNode = XMLParser::AppendNode(doc, elementNode, "Denominator");
    for (unsigned int i = 0; i < m_denominator.size(); ++i) {
        auto value = XMLParser::AppendNode(doc, denominatorNode, "Value");
        XMLParser::SetNodeValue(doc, value, m_denominator[i]);
    }
 
    return elementNode;
}

◆ SetDenominator()

virtual void TransferFunction::SetDenominator ( std::vector< double > denominator )

inlinevirtual

Definition at line 60 of file TransferFunction.h.

60{ m_denominator = denominator; }

◆ SetFont()

void TransferFunction::SetFont ( wxFont & font )

virtual

Reimplemented from ControlElement.

Definition at line 280 of file TransferFunction.cpp.

{
    if (m_gcTextNum) m_gcTextNum->SetFont(font);
    if (m_gcTextDen) m_gcTextDen->SetFont(font);
    StartMove(m_position);
    UpdateTFText();
}

◆ SetNumerator()

virtual void TransferFunction::SetNumerator ( std::vector< double > numerator )

inlinevirtual

Definition at line 59 of file TransferFunction.h.

59{ m_numerator = numerator; }

◆ SetText()

void TransferFunction::SetText	(	wxString	numerator,
		wxString	denominator
	)

protectedvirtual

Definition at line 87 of file TransferFunction.cpp.

{
    if (m_gcTextNum)
        m_gcTextNum->SetText(numerator);
    else
        m_gcTextNum = new GCText(numerator);
 
    if (m_gcTextDen)
        m_gcTextDen->SetText(denominator);
    else
        m_gcTextDen = new GCText(denominator);
 
    double nWidth = static_cast<double>(m_gcTextNum->GetWidth()) + 5 + m_borderSize;
    double dWidth = static_cast<double>(m_gcTextDen->GetWidth()) + 5 + m_borderSize;
 
    m_width = nWidth > dWidth ? nWidth : dWidth;
    m_height = static_cast<double>(m_gcTextNum->GetHeight()) + static_cast<double>(m_gcTextDen->GetHeight()) + 2 * m_borderSize;
    SetPosition(m_position);  // Update rect properly.
}

◆ ShowForm()

bool TransferFunction::ShowForm	(	wxWindow *	parent,
		Element *	element,
		wxWindow *	workspace = `nullptr`
	)

virtual

Show element data form.

Parameters

parent	Form parent
element	Element that will be edited.

Returns: True if the form is shown, false otherwise.

Reimplemented from Element.

Definition at line 236 of file TransferFunction.cpp.

{
    TransferFunctionForm tfForm(parent, this);
    tfForm.CenterOnParent();
    if (tfForm.ShowModal() == wxID_OK) {
        return true;
    }
    return false;
}

◆ Solve()

bool TransferFunction::Solve	(	double *	input,
		double	timeStep
	)

virtual

Calculates the time response by the space state form of transfer function.

Uses the implicit trapezoidal rule to solve:

\( y_{n+1}=y_n+\frac{1}{2}h(y'_n+y'_{n+1}) \)

Parameters

input	Input value.
timeStep	Time step.

Returns: true if the calculation converges, false otherwise.

Reimplemented from ControlElement.

Definition at line 341 of file TransferFunction.cpp.

{
    if (!input) {
        m_output = 0.0;
        return true;
    }
 
    int order = static_cast<int>(m_ss.A.size());
 
    std::vector<double> x;
    std::vector<double> oldx;
    std::vector<double> dx;
    std::vector<double> olddx;
    for (int i = 0; i < order; i++) {
        x.push_back(m_x[i]);
        oldx.push_back(m_x[i]);
 
        dx.push_back(m_dx[i]);
        olddx.push_back(m_dx[i]);
    }
 
    bool exit = false;
    int iter = 0;
    while (!exit) {
        double xError = 0.0;
        double dxError = 0.0;
        for (int i = 0; i < order; i++) {
            // Trapezoidal method
            x[i] = m_x[i] + 0.5 * timeStep * (m_dx[i] + dx[i]);
 
            if (std::abs(x[i] - oldx[i]) > xError) xError = std::abs(x[i] - oldx[i]);
 
            oldx[i] = x[i];
        }
        for (int i = 0; i < order; i++) {
            // x' = Ax + Bu
            dx[i] = 0.0;
            for (int j = 0; j < order; j++) dx[i] += m_ss.A[i][j] * x[j];
            dx[i] += m_ss.B[i] * input[0];
 
            if (std::abs(dx[i] - olddx[i]) > dxError) dxError = std::abs(dx[i] - olddx[i]);
 
            olddx[i] = dx[i];
        }
        if (std::max(xError, dxError) < m_error) exit = true;
 
        iter++;
        if (iter >= m_maxIteration) return false;
    }
 
    m_output = 0.0;
    for (int i = 0; i < order; i++) {
        m_output += m_ss.C[i] * x[i];
        m_x[i] = x[i];
        m_dx[i] = dx[i];
    }
 
    m_output += m_ss.D * input[0];
 
    return true;
}

◆ UpdateText()

bool TransferFunction::UpdateText ( )

virtual

Update the OpenGL text in the element (if present).

Returns: true if OpenGLText is ok, false otherwise.

Reimplemented from ControlElement.

Definition at line 411 of file TransferFunction.cpp.

{
    UpdateTFText();
    //if (!m_glTextDen->IsTextureOK()) return false;
    //if (!m_glTextNum->IsTextureOK()) return false;
    return true;
}

◆ UpdateTFText()

void TransferFunction::UpdateTFText ( )

virtual

Definition at line 211 of file TransferFunction.cpp.

{
    wxString num, den;
    GetTFString(num, den);
    SetText(num, den);
    if (m_nodeList.size() == 2) {
        if (m_angle == 0.0) {
            m_nodeList[0]->SetPosition(m_position + wxPoint2DDouble(-m_width / 2, 0));
            m_nodeList[1]->SetPosition(m_position + wxPoint2DDouble(m_width / 2, 0));
        }
        else if (m_angle == 90.0) {
            m_nodeList[0]->SetPosition(m_position + wxPoint2DDouble(0, -m_height / 2));
            m_nodeList[1]->SetPosition(m_position + wxPoint2DDouble(0, m_height / 2));
        }
        else if (m_angle == 180.0) {
            m_nodeList[0]->SetPosition(m_position + wxPoint2DDouble(m_width / 2, 0));
            m_nodeList[1]->SetPosition(m_position + wxPoint2DDouble(-m_width / 2, 0));
        }
        else if (m_angle == 270.0) {
            m_nodeList[0]->SetPosition(m_position + wxPoint2DDouble(0, m_height / 2));
            m_nodeList[1]->SetPosition(m_position + wxPoint2DDouble(0, -m_height / 2));
        }
    }
}

Member Data Documentation

◆ m_denominator

std::vector<double> TransferFunction::m_denominator

protected

Definition at line 97 of file TransferFunction.h.

◆ m_dx

std::vector<double> TransferFunction::m_dx

protected

Definition at line 101 of file TransferFunction.h.

◆ m_error

double TransferFunction::m_error = 1e-3

protected

Definition at line 102 of file TransferFunction.h.

◆ m_gcTextDen

GCText* TransferFunction::m_gcTextDen = nullptr

protected

Definition at line 94 of file TransferFunction.h.

◆ m_gcTextNum

GCText* TransferFunction::m_gcTextNum = nullptr

protected

Definition at line 93 of file TransferFunction.h.

◆ m_maxIteration

int TransferFunction::m_maxIteration = 100

protected

Definition at line 103 of file TransferFunction.h.

◆ m_numerator

std::vector<double> TransferFunction::m_numerator

protected

Definition at line 96 of file TransferFunction.h.

◆ m_ss

SpaceState TransferFunction::m_ss

protected

Definition at line 98 of file TransferFunction.h.

◆ m_supNumber

wchar_t TransferFunction::m_supNumber[10]

protected

Definition at line 91 of file TransferFunction.h.

◆ m_x

std::vector<double> TransferFunction::m_x

protected

Definition at line 100 of file TransferFunction.h.

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

Project/elements/controlElement/TransferFunction.h
Project/elements/controlElement/TransferFunction.cpp

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TransferFunction()

◆ ~TransferFunction()

Member Function Documentation

◆ CalculateSpaceState()

◆ Contains()

◆ DrawDC()

◆ GetCopy()

◆ GetDenominator()

◆ GetNumerator()

◆ GetSpaceState()

◆ GetSuperscriptNumber()

◆ GetTFString()

◆ Intersects()

◆ OpenElement()

◆ Rotate()

◆ SaveElement()

◆ SetDenominator()

◆ SetFont()

◆ SetNumerator()

◆ SetText()

◆ ShowForm()

◆ Solve()

◆ UpdateText()

◆ UpdateTFText()

Member Data Documentation

◆ m_denominator

◆ m_dx

◆ m_error

◆ m_gcTextDen

◆ m_gcTextNum

◆ m_maxIteration

◆ m_numerator

◆ m_ss

◆ m_supNumber

◆ m_x