convertUNICADO2CPACS
unicadoAcft Class Reference

Class that represents the UNICADO XML Structure. More...

#include <unicadoAcftXML.h>

Collaboration diagram for unicadoAcft:
Collaboration graph

Classes

struct  centreOfGravityRangeStruct
 Structure for center of gravity range. More...
 
class  unicadoAccommodation
 Represents the unicado Accommodations Values-XML-Block. More...
 
class  unicadoAerodynamics
 Represents the unicado Aerodynamics Values XML-Block. More...
 
class  unicadoDesignSpecs
 Represents the unicado design specification XML-Block. More...
 
class  unicadoEcologicalValues
 Represents the unicado EcologicalValues-XML-Block. More...
 
class  unicadoGeometry
 Represents the unicado Geometry-XML-Block. More...
 
class  unicadoMassesAndLoadings
 Class represents the UNICADO MassesAndLoadings-Block. More...
 
class  unicadoMonetaryValues
 Represents the unicado Monetary Values-XML-Block. More...
 
class  unicadoPerformance
 Represents the unicado Performance Values-XML-Block. More...
 
class  unicadoPropulsion
 Represents the unicado Propulsion Values-XML-Block. More...
 
class  unicadoRequirements
 
class  unicadoStabilityAndControlCharacteristics
 Represents the unicado StabilityAndControlCharacteristics Values-XML-Block. More...
 
class  unicadoSystems
 Represents the unicado Systems Values-XML-Block. More...
 

Public Member Functions

 unicadoAcft (const convertUNICADO2CPACSSettings &mySettings)
 Constructor for unicadoAcft. More...
 
virtual ~unicadoAcft ()
 Destructor for unicadoAcft. More...
 
void readMassesAndLoadings ()
 Function reads masses and loadings from unicado xml. More...
 
void readGeometry ()
 Function reads geometry from unicado xml. More...
 
void readAccommodation ()
 Function reads accommodation from unicado xml. More...
 
void readPropulsion ()
 Function reads propulsion from unicado xml. More...
 
double *** readEnginePerformance (const std::string &filename, std::vector< double > *FL, std::vector< double > *N, std::vector< double > *Mach)
 function reads engine performance decks More...
 
void readSystems ()
 Function reads systems from unicado xml. More...
 
void readAerodynamics ()
 Function reads aerodynamics from unicado xml. More...
 
void readStabilityAndControlCharacteristics ()
 Function reads stability and control characteristics from unicado xml. More...
 
void readPerformance ()
 Function reads performance from unicado xml. More...
 
void readMission (const std::string &uniadoDir, const std::string &missionPath, unicadoAcft::unicadoPerformance::missionAnalysis *aMission)
 Function reads mission from unicado xml. More...
 
void readAMissionAnalysisCruiseStep (const std::string &missionPath, unicadoAcft::unicadoPerformance::missionAnalysis *aMission)
 Function reads CruiseSteps from Performance from UNICADO-file. More...
 
void readMonetaryValues ()
 Function reads monetary values from unicado xml. More...
 
void readEcologicalValues ()
 Function reads ecological values from unicado xml. More...
 
void readRequirements ()
 Function reads requirements from unicado xml. More...
 
void readDesignSpecs ()
 Function reads design specifications from unicado xml. More...
 

Public Attributes

node & unicadoXML
 
std::vector< std::string > Input
 
std::vector< std::string > Output
 
std::string acType
 
std::string acModel
 
std::string acftName
 
std::string engineDataFile
 
std::string engineDataDir
 
bool propulsionAlreadyRead
 
unicadoMassesAndLoadings theUnicadoMassesAndLoadings
 
unicadoGeometry theUnicadoGeo
 
unicadoAccommodation theUnicadoAccommodation
 
unicadoPropulsion theUnicadoPropulsion
 
unicadoSystems theUnicadoSystems
 
unicadoAerodynamics theUnicadoAerodynamics
 
unicadoStabilityAndControlCharacteristics theUnicadoStabilityAndControlCharacteristics
 
unicadoPerformance theUnicadoPerformance
 
unicadoMonetaryValues theUnicadoMonetaryValues
 
unicadoEcologicalValues theUnicadoEcologicalValues
 
unicadoRequirements theUnicadoReqs
 
unicadoDesignSpecs theUnicadoDesignSpecs
 

Private Member Functions

double *** dtensor (const int &n, const int &m, const int &p)
 Function builds tensor containing input params. More...
 
void readMassBreakdown (const std::string &massElementPath, unicadoAcft::unicadoMassesAndLoadings::massBreakdown::massElement &element)
 Function that reads mass breakdown from unicado. More...
 
unicadoAcft::unicadoAccommodation::seat readASeat (const std::string &seatpath)
 Function to read a seat (class) type from UNICADO-file. More...
 
unicadoAcft::unicadoAccommodation::galley readAGalley (const std::string &galleypath)
 Function to read a galley type from UNICADO-file. More...
 
unicadoAcft::unicadoAccommodation::lavatory readALavatory (const std::string &lavatorypath)
 Function to read a lavatory type from UNICADO-file. More...
 
unicadoAcft::unicadoAccommodation::cabin::cabinDeck readACabinDeck (const std::string &cabindeckpath)
 Function to read a cabin deck from UNICADO-file. More...
 
unicadoAcft::unicadoAccommodation::cargo::cargoDeck readACargoDeck (const std::string &cargodeckpath)
 Function to read a cargo deck from UNICADO-file. More...
 
unicadoAcft::unicadoPropulsion::nacellePositioning::nacelleLocationType readANaclleLocation (const std::string &nacelleLocationPath)
 Function to read a scaled nacelle location from UNICADO-file. More...
 
unicadoAcft::unicadoPropulsion::scaledPerformanceCharacteristics readAScaledPerformance (const std::string &performancePath)
 Function to read a scaled scaled performance characteristics from UNICADO-file. More...
 
std::vector< unicadoAcft::unicadoSystems::fuelTankreadTanks (const std::string &tanksPath, const int &noOfTanks)
 Function to read tanks from UNICADO-file. More...
 
unicadoAcft::unicadoEcologicalValues::noiseCertLevels::certificationPoint readANoiseCertPoint (const std::string &noiseCertPointPath, const std::string &noisePointName)
 Function to read a certification point from UNICADO-file. More...
 
unicadoAcft::unicadoEcologicalValues::Emissions readAnEmission (const std::string &emissionPath)
 Function to read an emission from UNICADO-file. More...
 
unicadoAcft::unicadoEcologicalValues::Operations::OperationComponents::EngineEmissons readAnEngineEmission (const std::string &engineEmissionsPath)
 Function to read an engine emission from UNICADO-file. More...
 
Vec3 readCOGVector (const std::string &vectorpath)
 Function reads a Center of Gravity Vector from UNICADO-file. More...
 

Private Attributes

const convertUNICADO2CPACSSettingsmySettingsPt
 

Detailed Description

Class that represents the UNICADO XML Structure.

Constructor & Destructor Documentation

◆ unicadoAcft()

unicadoAcft::unicadoAcft ( const convertUNICADO2CPACSSettings mySettings)
explicit

Constructor for unicadoAcft.

Parameters
mySettingssettings

◆ ~unicadoAcft()

unicadoAcft::~unicadoAcft ( )
virtual

Destructor for unicadoAcft.

Member Function Documentation

◆ dtensor()

double *** unicadoAcft::dtensor ( const int &  n,
const int &  m,
const int &  p 
)
private

Function builds tensor containing input params.

Parameters
nlines
mcolumns
pdepth
Returns
t: 3-dimensional tensor
Here is the caller graph for this function:

◆ readACabinDeck()

unicadoAcft::unicadoAccommodation::cabin::cabinDeck unicadoAcft::readACabinDeck ( const std::string &  cabindeckpath)
private

Function to read a cabin deck from UNICADO-file.

Parameters
cabindeckPathpath to cabin deck in unicado xml
Returns
aCabinDeck
Here is the caller graph for this function:

◆ readACargoDeck()

unicadoAcft::unicadoAccommodation::cargo::cargoDeck unicadoAcft::readACargoDeck ( const std::string &  cargodeckpath)
private

Function to read a cargo deck from UNICADO-file.

Parameters
cargodeckPathpath to cargo deck in unicado xml
Returns
aCargoDeck
Here is the caller graph for this function:

◆ readAccommodation()

void unicadoAcft::readAccommodation ( )

Function reads accommodation from unicado xml.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ readAerodynamics()

void unicadoAcft::readAerodynamics ( )

Function reads aerodynamics from unicado xml.

Here is the caller graph for this function:

◆ readAGalley()

unicadoAcft::unicadoAccommodation::galley unicadoAcft::readAGalley ( const std::string &  galleypath)
private

Function to read a galley type from UNICADO-file.

Parameters
galleypathpath to galley in unicado xml
Returns
aGalley
Here is the caller graph for this function:

◆ readALavatory()

unicadoAcft::unicadoAccommodation::lavatory unicadoAcft::readALavatory ( const std::string &  lavatorypath)
private

Function to read a lavatory type from UNICADO-file.

Parameters
lavatoryPathpath to lavatory in unicado xml
Returns
aLavatory
Here is the caller graph for this function:

◆ readAMissionAnalysisCruiseStep()

void unicadoAcft::readAMissionAnalysisCruiseStep ( const std::string &  missionPath,
unicadoAcft::unicadoPerformance::missionAnalysis aMission 
)

Function reads CruiseSteps from Performance from UNICADO-file.

Parameters
missionPathpath to mission in xml file
aMissionpointer to missionAnalysis object
Here is the caller graph for this function:

◆ readANaclleLocation()

unicadoAcft::unicadoPropulsion::nacellePositioning::nacelleLocationType unicadoAcft::readANaclleLocation ( const std::string &  nacelleLocationPath)
private

Function to read a scaled nacelle location from UNICADO-file.

Parameters
nacelleLocationPathpath to nacelle location in unicado xml
Returns
aNacelleLocation
Here is the caller graph for this function:

◆ readAnEmission()

unicadoAcft::unicadoEcologicalValues::Emissions unicadoAcft::readAnEmission ( const std::string &  emissionPath)
private

Function to read an emission from UNICADO-file.

Parameters
emissionPathpath to emission in unicado xml
Returns
anEmission
Here is the caller graph for this function:

◆ readAnEngineEmission()

unicadoAcft::unicadoEcologicalValues::Operations::OperationComponents::EngineEmissons unicadoAcft::readAnEngineEmission ( const std::string &  engineEmissionsPath)
private

Function to read an engine emission from UNICADO-file.

Parameters
engineEmissionPathpath to engine emission in unicado xml
Returns
anEngineEmission
Here is the caller graph for this function:

◆ readANoiseCertPoint()

unicadoAcft::unicadoEcologicalValues::noiseCertLevels::certificationPoint unicadoAcft::readANoiseCertPoint ( const std::string &  noiseCertPointPath,
const std::string &  noisePointName 
)
private

Function to read a certification point from UNICADO-file.

Parameters
noiseCertPointPathpath to certification point in unicado xml
noisePointNamename of certification point
Returns
aCertPoint
Here is the caller graph for this function:

◆ readAScaledPerformance()

unicadoAcft::unicadoPropulsion::scaledPerformanceCharacteristics unicadoAcft::readAScaledPerformance ( const std::string &  performancePath)
private

Function to read a scaled scaled performance characteristics from UNICADO-file.

Parameters
performancePathpath to performance in unicado xml
Returns
aScaledPerformance
Here is the caller graph for this function:

◆ readASeat()

unicadoAcft::unicadoAccommodation::seat unicadoAcft::readASeat ( const std::string &  seatpath)
private

Function to read a seat (class) type from UNICADO-file.

Parameters
seatpathpath to seat in unicado xml
Returns
aSeat
Here is the caller graph for this function:

◆ readCOGVector()

Vec3 unicadoAcft::readCOGVector ( const std::string &  vectorpath)
private

Function reads a Center of Gravity Vector from UNICADO-file.

Parameters
vectorpathpath to center of gravity vector
Returns
vec: Center of Gravity Vector --> Vec3 variable from UNICADO-file containing coordinates [m]
Here is the caller graph for this function:

◆ readDesignSpecs()

void unicadoAcft::readDesignSpecs ( )

Function reads design specifications from unicado xml.

Here is the caller graph for this function:

◆ readEcologicalValues()

void unicadoAcft::readEcologicalValues ( )

Function reads ecological values from unicado xml.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ readEnginePerformance()

double *** unicadoAcft::readEnginePerformance ( const std::string &  filename,
std::vector< double > *  FL,
std::vector< double > *  N,
std::vector< double > *  Mach 
)

function reads engine performance decks

Parameters
filenamename of the engine deck csv file
*FLvector containing the different altitudes [m]
*Nvector containing the different spool speeds [-]
*Machvector containing the different Mach numbers [-]
Returns
values: values of the engine performance deck
Here is the call graph for this function:
Here is the caller graph for this function:

◆ readGeometry()

void unicadoAcft::readGeometry ( )

Function reads geometry from unicado xml.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ readMassBreakdown()

void unicadoAcft::readMassBreakdown ( const std::string &  massElementPath,
unicadoAcft::unicadoMassesAndLoadings::massBreakdown::massElement element 
)
private

Function that reads mass breakdown from unicado.

Parameters
massElementPathpath to mass element in unicado xml
elementelement with mass and reference point

<

Todo:
[T1220] (https://unicado.ilr.rwth-aachen.de/T1220)(ohm#1#): function could be used to read subelements
Here is the caller graph for this function:

◆ readMassesAndLoadings()

void unicadoAcft::readMassesAndLoadings ( )

Function reads masses and loadings from unicado xml.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ readMission()

void unicadoAcft::readMission ( const std::string &  uniadoDir,
const std::string &  missionPath,
unicadoAcft::unicadoPerformance::missionAnalysis aMission 
)

Function reads mission from unicado xml.

Parameters
uniadoDirpath to the UNICADO result folder
missionPathpath to mission in xml file
aMission:pointerto missionAnalysis object
Here is the call graph for this function:
Here is the caller graph for this function:

◆ readMonetaryValues()

void unicadoAcft::readMonetaryValues ( )

Function reads monetary values from unicado xml.

Here is the caller graph for this function:

◆ readPerformance()

void unicadoAcft::readPerformance ( )

Function reads performance from unicado xml.

Todo:
[T1145] (https://unicado.ilr.rwth-aachen.de/T1145): Specification of vn-diagram is missing -> add data
Here is the call graph for this function:
Here is the caller graph for this function:

◆ readPropulsion()

void unicadoAcft::readPropulsion ( )

Function reads propulsion from unicado xml.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ readRequirements()

void unicadoAcft::readRequirements ( )

Function reads requirements from unicado xml.

Here is the caller graph for this function:

◆ readStabilityAndControlCharacteristics()

void unicadoAcft::readStabilityAndControlCharacteristics ( )

Function reads stability and control characteristics from unicado xml.

Here is the caller graph for this function:

◆ readSystems()

void unicadoAcft::readSystems ( )

Function reads systems from unicado xml.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ readTanks()

std::vector< unicadoAcft::unicadoSystems::fuelTank > unicadoAcft::readTanks ( const std::string &  tanksPath,
const int &  noOfTanks 
)
private

Function to read tanks from UNICADO-file.

Parameters
tanksPathpath to tanks in unicado xml
noOfTanks:numberof tanks
Returns
aTankVektor
Here is the caller graph for this function:

Member Data Documentation

◆ acftName

std::string unicadoAcft::acftName

Aircraft name i.e. CeRAS CSR-01

◆ acModel

std::string unicadoAcft::acModel

Aircraft Type i.e.: A320

◆ acType

std::string unicadoAcft::acType

Aircraft Type i.e.: Airbus

◆ engineDataDir

std::string unicadoAcft::engineDataDir

directory of the engine data folder

◆ engineDataFile

std::string unicadoAcft::engineDataFile

path to the engine xml-file

◆ Input

std::vector<std::string> unicadoAcft::Input

Vector for input data (to be written in _info.txt & _guiSettings.xml files)<

◆ mySettingsPt

const convertUNICADO2CPACSSettings* unicadoAcft::mySettingsPt
private

Pointer to the settings

◆ Output

std::vector<std::string> unicadoAcft::Output

Vector for output data (to be written in _info.txt & _guiSettings.xml files)<

◆ propulsionAlreadyRead

bool unicadoAcft::propulsionAlreadyRead

Switch if propulsion block is already read in

◆ theUnicadoAccommodation

unicadoAccommodation unicadoAcft::theUnicadoAccommodation

unicadoAccomodation class object

◆ theUnicadoAerodynamics

unicadoAerodynamics unicadoAcft::theUnicadoAerodynamics

class unicadoAerodynamics object

◆ theUnicadoDesignSpecs

unicadoDesignSpecs unicadoAcft::theUnicadoDesignSpecs

class unicadoDesignSpecs object

◆ theUnicadoEcologicalValues

unicadoEcologicalValues unicadoAcft::theUnicadoEcologicalValues

◆ theUnicadoGeo

unicadoGeometry unicadoAcft::theUnicadoGeo

unicadoGeometry class object

◆ theUnicadoMassesAndLoadings

unicadoMassesAndLoadings unicadoAcft::theUnicadoMassesAndLoadings

◆ theUnicadoMonetaryValues

unicadoMonetaryValues unicadoAcft::theUnicadoMonetaryValues

class unicadoMonetaryValues object

◆ theUnicadoPerformance

unicadoPerformance unicadoAcft::theUnicadoPerformance

class unikcadoPerformance object

◆ theUnicadoPropulsion

unicadoPropulsion unicadoAcft::theUnicadoPropulsion

class unicadoPropulsion object

◆ theUnicadoReqs

unicadoRequirements unicadoAcft::theUnicadoReqs

class unicadoRequirements object

◆ theUnicadoStabilityAndControlCharacteristics

unicadoStabilityAndControlCharacteristics unicadoAcft::theUnicadoStabilityAndControlCharacteristics

◆ theUnicadoSystems

unicadoSystems unicadoAcft::theUnicadoSystems

class unicadoSystems object

◆ unicadoXML

node& unicadoAcft::unicadoXML

XML Parameter to read and write into UNICADO XML-file


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