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/annotated.html | 122 +++++++++++++++++++++------------------ 1 file changed, 65 insertions(+), 57 deletions(-) (limited to 'docs/doxygen/html/annotated.html') diff --git a/docs/doxygen/html/annotated.html b/docs/doxygen/html/annotated.html index f4275bc..6455b40 100644 --- a/docs/doxygen/html/annotated.html +++ b/docs/doxygen/html/annotated.html @@ -21,6 +21,12 @@ + @@ -84,31 +90,31 @@ $(document).ready(function(){initNavTree('annotated.html','');});
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 12]
- + - + - + - + - - - + + + - - - - + + + + - + @@ -116,93 +122,95 @@ $(document).ready(function(){initNavTree('annotated.html','');}); - - + + - - - + + + - + - + - + - - + + - - + + - + - + - + - - + + - - + + - + - + - + - + - + - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + +
 CAboutForm
 CAboutFormForm to show some informations
 CAboutFormBase
 CBranch
 CBus
 CBusElectricalData
 CBusForm
 CBusFormForm to edit the bus power data
 CBusFormBase
 CCamera
 CCameraClass responsible for the correct visualization of the elements on screen
 CCapacitor
 CCapacitorElectricalData
 CChartView
 CChartViewThis class is responsible to manage the charts generated in the transient electromechanical studies
 CChartViewBase
 CConnectionLine
 CConstant
 CConstantForm
 CConnectionLineConnection between two control elements or other connection line and an element
 CConstantA control element that provides a constant value
 CConstantFormForm to edit the constant control data
 CConstantFormBase
 CControlEditor
 CControlEditorBase
 CControlElement
 CControlElementButton
 CControlElementContainer
 CControlElementSolver
 CControlSystemTest
 CControlElementButtonThis class is responsible to handle the user interaction with control elements
 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
 CControlSystemTestForm to edit properties to test the control system created
 CControlSystemTestBase
 CDataReport
 CDataReportForm that shows the results of power flow and fault calculations
 CDataReportBase
 CElectricCalculation
 CElectromechanical
 CElementDataObject
 CElementPlotData
 CElementsLists
 CExponential
 CExponentialForm
 CExponentialGenerates an output following an exponential function. \( output = A\cdot e^{B\cdot input} \)
 CExponentialFormForm to edit the exponential control data
 CExponentialFormBase
 CFault
 CFileHanding
 CGain
 CGainForm
 CFileHandingSave and opens the projects created on disk
 CGainProvide an output multiplying the input by a constant. \( output = K \cdot input \)
 CGainFormForm to edit the gain control data
 CGainFormBase
 CGeneralData
 CGeneralPropertiesForm
 CGeneralPropertiesFormForm to edit the software's general data
 CGeneralPropertiesFormBase
 CGeneratorStabForm
 CGeneratorStabFormForm to edit the synchronous generator data for electromechanical studies
 CGeneratorStabFormBase
 CGraphicalElement
 CIndMotor
 CIndMotorElectricalData
 CIndMotorForm
 CIndMotorFormForm to edit the induction motor power data
 CIndMotorFormBase
 CInductor
 CInductorElectricalData
 CIntegrationConstant
 CIOControl
 CIOControlForm
 CIOControlProvides the communication with the power element
 CIOControlFormForm to edit the input/output control data
 CIOControlFormBase
 CLimiter
 CLimiterForm
 CLimiterLimits the input value by superior and inferior values
 CLimiterFormForm to edit the limit control data
 CLimiterFormBase
 CLine
 CLineElectricalData
 CLineForm
 CLineFormForm to edit the line power data
 CLineFormBase
 CLoad
 CLoadElectricalData
 CLoadForm
 CLoadFormForm to edit the load power data
 CLoadFormBase
 CMachines
 CMainApp
 CMainFrame
 CMainFrameMain frame of the program. This class manage the ribbon menu and the notebook behavior
 CMainFrameBase
 CMultiplier
 CNode
 CMultiplierMultiplies two inputs
 CNodeNode of a control element. This class manages the user interaction with the connection and control elements
 COpenGLColour
 CPlotData
 CPowerElement
 CPowerFlow
 CPropertiesData
 CRateLimiter
 CRateLimiterForm
 CRateLimiterLimits the rising and/or falling rate.
+
 CRateLimiterFormForm to edit the rate limit control data
 CRateLimiterFormBase
 CReactiveLimits
 CReactiveShuntElementForm
 CReactiveShuntElementFormForm to edit the reactive shunt element power data
 CReactiveShuntElementFormBase
 CShunt
 CSimulationData
 CSimulationsSettingsForm
 CSimulationsSettingsFormForm to edit the simulation data
 CSimulationsSettingsFormBase
 CSum
 CSumForm
 CSumFormForm to edit the sum control data
 CSumFormBase
 CSwitchingData
 CSwitchingForm
 CSwitchingFormForm to edit the switching data of power elements for electromechanical transient studies
 CSwitchingFormBase
 CSyncGenerator
 CSyncGeneratorElectricalData
 CSyncMachineForm
 CSyncMachineFormForm to edit the synchronous machine power data
 CSyncMachineFormBase
 CSyncMotor
 CSyncMotorElectricalData
 CText
 CTextForm
 CTextFormBase
 CTextGLDrawable
 CTextTexture
 ►CTransferFunction
 CTransferFunctionForm
 CTransferFunctionFormBase
 CTransformer
 CTransformerElectricalData
 CTransformerForm
 CTransformerFormBase
 CWorkspace
 CWorkspaceBase
 CwxGLNumberRenderer
 CwxGLString
 CwxGLStringArray
 CwxRibbonMetroArtProvider
 CSyncMachineModelDataSynchronous machine data for different models
 CSyncMotor
 CSyncMotorElectricalData
 CText
 CTextFormForm to edit the text graphical data
 CTextFormBase
 CTextGLDrawable
 CTextTexture
 ►CTransferFunction
 CTransferFunctionFormForm to edit the transfer function control data
 CTransferFunctionFormBase
 CTransformer
 CTransformerElectricalData
 CTransformerFormForm to edit the transformer power data
 CTransformerFormBase
 CWorkspaceThis class manages the graphical and power elements. It is responsible for handling the user's interaction with the elements
 CWorkspaceBase
 CwxGLNumberRenderer
 CwxGLString
 CwxGLStringArray
 CwxRibbonMetroArtProvider
-- 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/annotated.html | 60 ++++++++++++++++++++-------------------- 1 file changed, 30 insertions(+), 30 deletions(-) (limited to 'docs/doxygen/html/annotated.html') diff --git a/docs/doxygen/html/annotated.html b/docs/doxygen/html/annotated.html index 6455b40..3949517 100644 --- a/docs/doxygen/html/annotated.html +++ b/docs/doxygen/html/annotated.html @@ -92,13 +92,13 @@ $(document).ready(function(){initNavTree('annotated.html','');});
[detail level 12]
- - + + - + @@ -116,18 +116,18 @@ $(document).ready(function(){initNavTree('annotated.html','');}); - - - - + + + + - + - + - + @@ -135,39 +135,39 @@ $(document).ready(function(){initNavTree('annotated.html','');}); - - + + - + - + - + - + - + - - - - - + + + + + @@ -175,33 +175,33 @@ $(document).ready(function(){initNavTree('annotated.html','');}); - + - + - + - + - + - + - + - + -- cgit
 CAboutFormForm to show some informations
 CAboutFormBase
 CBranch
 CBus
 CBranchAbstract class for branch power elements
 CBusNode for power elements. All others power elements are connected through this
 CBusElectricalData
 CBusFormForm to edit the bus power data
 CBusFormBase
 CCameraClass responsible for the correct visualization of the elements on screen
 CCapacitor
 CCapacitorShunt capactior power element
 CCapacitorElectricalData
 CChartViewThis class is responsible to manage the charts generated in the transient electromechanical studies
 CChartViewBase
 CControlSystemTestBase
 CDataReportForm that shows the results of power flow and fault calculations
 CDataReportBase
 CElectricCalculation
 CElectromechanical
 CElement
 CElementDataObject
 CElectricCalculationBase class of electric calculations, with general methods
 CElectromechanicalCalculates the electromechanical transient based on disturbances (e.g. system fault)
 CElementBase class of all elements of the program. This class is responsible for manage graphical and his data
 CElementDataObjectClass to store the elements in the clipboard
 CElementPlotData
 CElementsLists
 CExponentialGenerates an output following an exponential function. \( output = A\cdot e^{B\cdot input} \)
 CExponentialGenerates an output following an exponential function
 CExponentialFormForm to edit the exponential control data
 CExponentialFormBase
 CFault
 CFaultCalculate the fault of the system and update the elements data
 CFileHandingSave and opens the projects created on disk
 CGainProvide an output multiplying the input by a constant. \( output = K \cdot input \)
 CGainProvide an output multiplying the input by a constant
 CGainFormForm to edit the gain control data
 CGainFormBase
 CGeneralData
 CGeneralPropertiesFormBase
 CGeneratorStabFormForm to edit the synchronous generator data for electromechanical studies
 CGeneratorStabFormBase
 CGraphicalElement
 CIndMotor
 CGraphicalElementAbstract class for graphical elements shown with power elements in workspace
 CIndMotorInduction motor power element
 CIndMotorElectricalData
 CIndMotorFormForm to edit the induction motor power data
 CIndMotorFormBase
 CInductor
 CInductorInductor shunt power element
 CInductorElectricalData
 CIntegrationConstant
 CIntegrationConstantIntegration constants to calculate dynamic elements through trapezoidal integration method
 CIOControlProvides the communication with the power element
 CIOControlFormForm to edit the input/output control data
 CIOControlFormBase
 CLimiterLimits the input value by superior and inferior values
 CLimiterFormForm to edit the limit control data
 CLimiterFormBase
 CLine
 CLinePower line element
 CLineElectricalData
 CLineFormForm to edit the line power data
 CLineFormBase
 CLoad
 CLoadLoas shunt power element
 CLoadElectricalData
 CLoadFormForm to edit the load power data
 CLoadFormBase
 CMachines
 CMachinesAbstract class for rotary machines power elements
 CMainApp
 CMainFrameMain frame of the program. This class manage the ribbon menu and the notebook behavior
 CMainFrameBase
 CMultiplierMultiplies two inputs
 CNodeNode of a control element. This class manages the user interaction with the connection and control elements
 COpenGLColour
 CPlotData
 CPowerElement
 CPowerFlow
 CPropertiesData
 COpenGLColourClass to manage color of OpenGL
 CPlotDataThis class is responsible to manage the graphical data of electromechanical result to be plotted on chart viewer
 CPowerElementAbstract class of power elements
 CPowerFlowCalculate the power flow
 CPropertiesDataGeneral and simulation data manager
 CRateLimiterLimits the rising and/or falling rate.
 CRateLimiterFormForm to edit the rate limit control data
 CReactiveLimits
 CReactiveShuntElementFormForm to edit the reactive shunt element power data
 CReactiveShuntElementFormBase
 CShunt
 CShuntAbstract class for shunt power elements
 CSimulationData
 CSimulationsSettingsFormForm to edit the simulation data
 CSimulationsSettingsFormBase
 CSum
 CSumSum the all inputs (can choose the input signal)
 CSumFormForm to edit the sum control data
 CSumFormBase
 CSwitchingData
 CSwitchingDataSwitching data of power elements
 CSwitchingFormForm to edit the switching data of power elements for electromechanical transient studies
 CSwitchingFormBase
 CSyncGenerator
 CSyncGeneratorSynchronous generator power element
 CSyncGeneratorElectricalData
 CSyncMachineFormForm to edit the synchronous machine power data
 CSyncMachineFormBase
 CSyncMachineModelDataSynchronous machine data for different models
 CSyncMotor
 CSyncMotorSynchronous motor (synchronous compensator) power element
 CSyncMotorElectricalData
 CText
 CTextElement that shows power element informations in workspace
 CTextFormForm to edit the text graphical data
 CTextFormBase
 CTextGLDrawable
 CTextTexture
 ►CTransferFunction
 ►CTransferFunctionCalculates the time response by a frequency domain transfer function
 CTransferFunctionFormForm to edit the transfer function control data
 CTransferFunctionFormBase
 CTransformer
 CTransformerTwo-winding transformer power element
 CTransformerElectricalData
 CTransformerFormForm to edit the transformer power data
 CTransformerFormBase