From bc5a3e8923cb8efedbbd5b88e212eb0e9009cf87 Mon Sep 17 00:00:00 2001 From: Thales Lima Oliveira Date: Thu, 5 Oct 2017 20:02:59 -0300 Subject: Add copyright on files and documentation update --- docs/doxygen/html/hierarchy.html | 186 ++++++++++++++++++++------------------- 1 file changed, 97 insertions(+), 89 deletions(-) (limited to 'docs/doxygen/html/hierarchy.html') diff --git a/docs/doxygen/html/hierarchy.html b/docs/doxygen/html/hierarchy.html index 762b63c..8d0d95e 100644 --- a/docs/doxygen/html/hierarchy.html +++ b/docs/doxygen/html/hierarchy.html @@ -21,6 +21,12 @@ + @@ -85,24 +91,25 @@ $(document).ready(function(){initNavTree('hierarchy.html','');});
This inheritance list is sorted roughly, but not completely, alphabetically:
[detail level 1234]
- + - - + + - - - - - - - - + + + + + + + + @@ -122,14 +129,14 @@ $(document).ready(function(){initNavTree('hierarchy.html','');}); - + - + @@ -137,82 +144,83 @@ $(document).ready(function(){initNavTree('hierarchy.html','');}); - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 CBusElectricalData
 CCamera
 CCameraClass responsible for the correct visualization of the elements on screen
 CCapacitorElectricalData
 CControlElementContainer
 CControlElementSolver
 CControlElementContainerClass that can contain all control elements. Can identify (using RTTI) the elements from a generic list and store them separately
 CControlElementSolverSolves in the time the control system. Can solve the control system directly from a ControlEditor or from a ControlEditorElement
 ▼CElectricCalculation
 CElectromechanical
 CFault
 CPowerFlow
 ▼CElement
 ►CControlElement
 ►CGraphicalElement
 CElementPlotData
 CElementsLists
 CFileHanding
 CFileHandingSave and opens the projects created on disk
 CGeneralData
 CIndMotorElectricalData
 CInductorElectricalData
 CIntegrationConstant
 CLineElectricalData
 CLoadElectricalData
 CNode
 CNodeNode of a control element. This class manages the user interaction with the connection and control elements
 COpenGLColour
 CPropertiesData
 CReactiveLimits
 CTransferFunction::SpaceState
 CSwitchingData
 CSyncGeneratorElectricalData
 CSyncMotorElectricalData
 ▼CTextGLDrawable
 ►CwxGLString
 CTextTexture
 CTransformerElectricalData
 ▼CwxApp
 CMainApp
 ▼CwxDataObjectSimple
 CElementDataObject
 ▼CwxDialog
 ►CAboutFormBase
 ►CBusFormBase
 ►CConstantFormBase
 ►CControlSystemTestBase
 ►CExponentialFormBase
 ►CGainFormBase
 ►CGeneralPropertiesFormBase
 ►CGeneratorStabFormBase
 ►CIndMotorFormBase
 ►CIOControlFormBase
 ►CLimiterFormBase
 ►CLineFormBase
 ►CLoadFormBase
 ►CRateLimiterFormBase
 ►CReactiveShuntElementFormBase
 ►CSimulationsSettingsFormBase
 ►CSumFormBase
 ►CSwitchingFormBase
 ►CSyncMachineFormBase
 ►CTextFormBase
 ►CTransferFunctionFormBase
 ►CTransformerFormBase
 ▼CwxFrame
 ►CChartViewBase
 ►CControlEditorBase
 ►CDataReportBase
 ►CMainFrameBase
 CwxGLStringArray
 ▼CwxPanel
 ►CWorkspaceBase
 ▼CwxRibbonMSWArtProvider
 CwxRibbonMetroArtProvider
 ▼CwxString
 CwxGLString
 ▼CwxTreeItemData
 CPlotData
 ▼CwxWindow
 CControlElementButton
 CSyncMachineModelDataSynchronous machine data for different models
 CSyncMotorElectricalData
 ▼CTextGLDrawable
 ►CwxGLString
 CTextTexture
 CTransformerElectricalData
 ▼CwxApp
 CMainApp
 ▼CwxDataObjectSimple
 CElementDataObject
 ▼CwxDialog
 ►CAboutFormBase
 ►CBusFormBase
 ►CConstantFormBase
 ►CControlSystemTestBase
 ►CExponentialFormBase
 ►CGainFormBase
 ►CGeneralPropertiesFormBase
 ►CGeneratorStabFormBase
 ►CIndMotorFormBase
 ►CIOControlFormBase
 ►CLimiterFormBase
 ►CLineFormBase
 ►CLoadFormBase
 ►CRateLimiterFormBase
 ►CReactiveShuntElementFormBase
 ►CSimulationsSettingsFormBase
 ►CSumFormBase
 ►CSwitchingFormBase
 ►CSyncMachineFormBase
 ►CTextFormBase
 ►CTransferFunctionFormBase
 ►CTransformerFormBase
 ▼CwxFrame
 ►CChartViewBase
 ►CControlEditorBase
 ►CDataReportBase
 ►CMainFrameBase
 CwxGLStringArray
 ▼CwxPanel
 ►CWorkspaceBase
 ▼CwxRibbonMSWArtProvider
 CwxRibbonMetroArtProvider
 ▼CwxString
 CwxGLString
 ▼CwxTreeItemData
 CPlotData
 ▼CwxWindow
 CControlElementButtonThis class is responsible to handle the user interaction with control elements
-- cgit From 89befdb9b259d02249876e39ec6fd28860272439 Mon Sep 17 00:00:00 2001 From: Thales Lima Oliveira Date: Fri, 6 Oct 2017 17:06:15 -0300 Subject: A lot of documentation written --- docs/doxygen/html/hierarchy.html | 60 ++++++++++++++++++++-------------------- 1 file changed, 30 insertions(+), 30 deletions(-) (limited to 'docs/doxygen/html/hierarchy.html') diff --git a/docs/doxygen/html/hierarchy.html b/docs/doxygen/html/hierarchy.html index 8d0d95e..0ddc0a9 100644 --- a/docs/doxygen/html/hierarchy.html +++ b/docs/doxygen/html/hierarchy.html @@ -95,54 +95,54 @@ $(document).ready(function(){initNavTree('hierarchy.html','');});  CCapacitorElectricalData  CControlElementContainerClass that can contain all control elements. Can identify (using RTTI) the elements from a generic list and store them separately  CControlElementSolverSolves in the time the control system. Can solve the control system directly from a ControlEditor or from a ControlEditorElement - ▼CElectricCalculation - CElectromechanical - CFault - CPowerFlow - ▼CElement + ▼CElectricCalculationBase class of electric calculations, with general methods + CElectromechanicalCalculates the electromechanical transient based on disturbances (e.g. system fault) + CFaultCalculate the fault of the system and update the elements data + CPowerFlowCalculate the power flow + ▼CElementBase class of all elements of the program. This class is responsible for manage graphical and his data  ►CControlElement  CConnectionLineConnection between two control elements or other connection line and an element  CConstantA control element that provides a constant value - CExponentialGenerates an output following an exponential function. \( output = A\cdot e^{B\cdot input} \) - CGainProvide an output multiplying the input by a constant. \( output = K \cdot input \) + CExponentialGenerates an output following an exponential function + CGainProvide an output multiplying the input by a constant  CIOControlProvides the communication with the power element  CLimiterLimits the input value by superior and inferior values  CMultiplierMultiplies two inputs  CRateLimiterLimits the rising and/or falling rate.
- CSum - CTransferFunction - ►CGraphicalElement - CText - ►CPowerElement - ►CBranch - CLine - CTransformer - CBus - ►CMachines - CIndMotor - CSyncGenerator - CSyncMotor - ►CShunt - CCapacitor - CInductor - CLoad + CSumSum the all inputs (can choose the input signal) + CTransferFunctionCalculates the time response by a frequency domain transfer function + ►CGraphicalElementAbstract class for graphical elements shown with power elements in workspace + CTextElement that shows power element informations in workspace + ►CPowerElementAbstract class of power elements + ►CBranchAbstract class for branch power elements + CLinePower line element + CTransformerTwo-winding transformer power element + CBusNode for power elements. All others power elements are connected through this + ►CMachinesAbstract class for rotary machines power elements + CIndMotorInduction motor power element + CSyncGeneratorSynchronous generator power element + CSyncMotorSynchronous motor (synchronous compensator) power element + ►CShuntAbstract class for shunt power elements + CCapacitorShunt capactior power element + CInductorInductor shunt power element + CLoadLoas shunt power element  CElementPlotData  CElementsLists  CFileHandingSave and opens the projects created on disk  CGeneralData  CIndMotorElectricalData  CInductorElectricalData - CIntegrationConstant + CIntegrationConstantIntegration constants to calculate dynamic elements through trapezoidal integration method  CLineElectricalData  CLoadElectricalData  CNodeNode of a control element. This class manages the user interaction with the connection and control elements - COpenGLColour - CPropertiesData + COpenGLColourClass to manage color of OpenGL + CPropertiesDataGeneral and simulation data manager  CReactiveLimits  CSimulationData  CTransferFunction::SpaceState - CSwitchingData + CSwitchingDataSwitching data of power elements  CSyncGeneratorElectricalData  CSyncMachineModelDataSynchronous machine data for different models  CSyncMotorElectricalData @@ -154,7 +154,7 @@ $(document).ready(function(){initNavTree('hierarchy.html','');});  ▼CwxApp  CMainApp  ▼CwxDataObjectSimple - CElementDataObject + CElementDataObjectClass to store the elements in the clipboard  ▼CwxDialog  ►CAboutFormBase  CAboutFormForm to show some informations @@ -218,7 +218,7 @@ $(document).ready(function(){initNavTree('hierarchy.html','');});  ▼CwxString  CwxGLString  ▼CwxTreeItemData - CPlotData + CPlotDataThis class is responsible to manage the graphical data of electromechanical result to be plotted on chart viewer  ▼CwxWindow  CControlElementButtonThis class is responsible to handle the user interaction with control elements -- cgit