Declaration of the TIGL C interface. More...
#include "tixi.h"
#include <stdio.h>
Macros | |
#define | TIGL_COMMON_EXPORT |
#define | TIGL_H |
Functions | |
TiglReturnCode | tiglCheckPointInside (TiglCPACSConfigurationHandle cpacsHandle, double px, double py, double pz, const char *componentUID, TiglBoolean *isInside) |
Checks whether a point lies inside the given geometric object. Note that the symmetry attribute is ignored. More... | |
TiglReturnCode | tiglCloseCPACSConfiguration (TiglCPACSConfigurationHandle cpacsHandle) |
Closes a CPACS configuration and cleans up all memory used by the configuration. After closing a configuration the associated configuration handle is no longer valid. When the CPACS configuration has been closed, the companion tixi document can also be closed. More... | |
TiglReturnCode | tiglComponentGetHashCode (TiglCPACSConfigurationHandle cpacsHandle, const char *componentUID, int *hashCodePtr) |
Returns a unique HashCode for a geometric component. More... | |
TiglReturnCode | tiglComponentGetType (TiglCPACSConfigurationHandle cpacsHandle, const char *componentUID, TiglGeometricComponentType *typePtr) |
Returns the type of a geometric component. More... | |
TiglReturnCode | tiglConfigurationGetBoundingBox (TiglCPACSConfigurationHandle cpacsHandle, double *minX, double *minY, double *minZ, double *maxX, double *maxY, double *maxZ) |
Computes the bounding box coordinates of the configuration. More... | |
TiglReturnCode | tiglConfigurationGetLength (TiglCPACSConfigurationHandle cpacsHandle, double *pLength) |
Returns the length of the plane. More... | |
TiglReturnCode | tiglControlSurfaceGetControlParameter (TiglCPACSConfigurationHandle cpacsHandle, const char *controlSurfaceUID, double *controlParameter) |
Returns the current value for the control parameter of a control device. More... | |
TiglReturnCode | tiglControlSurfaceGetDeflection (TiglCPACSConfigurationHandle cpacsHandle, const char *controlSurfaceUID, double *deflection) |
This function is deprecated. It has been renamed to tiglControlSurfaceGetControlParameter. More... | |
TiglReturnCode | tiglControlSurfaceGetMaximumControlParameter (TiglCPACSConfigurationHandle cpacsHandle, const char *controlSurfaceUID, double *maxParameter) |
Returns the maximum value for the control parameter of a control device. More... | |
TiglReturnCode | tiglControlSurfaceGetMaximumDeflection (TiglCPACSConfigurationHandle cpacsHandle, const char *controlSurfaceUID, double *maxDeflection) |
This function is deprecated. It has been renamed to tiglControlSurfaceGetMaximumControlParameter. More... | |
TiglReturnCode | tiglControlSurfaceGetMinimumControlParameter (TiglCPACSConfigurationHandle cpacsHandle, const char *controlSurfaceUID, double *minParameter) |
Returns the minimum value for the control parameter of a control device. More... | |
TiglReturnCode | tiglControlSurfaceGetMinimumDeflection (TiglCPACSConfigurationHandle cpacsHandle, const char *controlSurfaceUID, double *minDeflection) |
This function is deprecated. It has been renamed to tiglControlSurfaceGetMinimumControlParameter. More... | |
TiglReturnCode | tiglControlSurfaceSetControlParameter (TiglCPACSConfigurationHandle cpacsHandle, const char *controlSurfaceUID, double controlParameter) |
Sets the current value for the control parameter of a control device. More... | |
TiglReturnCode | tiglControlSurfaceSetDeflection (TiglCPACSConfigurationHandle cpacsHandle, const char *controlSurfaceUID, double deflection) |
This function is deprecated. It has been renamed to tiglControlSurfaceSetControlParameter. More... | |
TiglReturnCode | tiglExportComponent (TiglCPACSConfigurationHandle cpacsHandle, const char *uid, const char *fileName, double deflection) |
Exports a geometric component (e.g. a wing, a fuselage etc.) More... | |
TiglReturnCode | tiglExportConfiguration (TiglCPACSConfigurationHandle cpacsHandle, const char *fileName, TiglBoolean fuseAllShapes, double deflection) |
Exports the whole configuration into a file. More... | |
TiglReturnCode | tiglExportFusedBREP (TiglCPACSConfigurationHandle cpacsHandle, const char *filename) |
Exports the fused/trimmed geometry of a CPACS configuration to BREP format. More... | |
TiglReturnCode | tiglExportFusedSTEP (TiglCPACSConfigurationHandle cpacsHandle, const char *filenamePtr) |
Exports the fused/trimmed geometry of a CPACS configuration to STEP format. More... | |
TiglReturnCode | tiglExportFusedWingFuselageIGES (TiglCPACSConfigurationHandle cpacsHandle, const char *filenamePtr) |
Exports the boolean fused geometry of a CPACS configuration to IGES format. More... | |
TiglReturnCode | tiglExportFuselageBREPByUID (TiglCPACSConfigurationHandle cpacsHandle, const char *fuselageUID, const char *filename) |
Exports the boolean fused geometry of a fuselage (selected by uid) to BREP format. More... | |
TiglReturnCode | tiglExportFuselageColladaByUID (const TiglCPACSConfigurationHandle cpacsHandle, const char *fuselageUID, const char *filename, double deflection) |
Exports the boolean fused geometry of a fuselage (selected by uid) meshed to Collada (*.dae) format. More... | |
TiglReturnCode | tiglExportIGES (TiglCPACSConfigurationHandle cpacsHandle, const char *filenamePtr) |
Exports the geometry of a CPACS configuration to IGES format. More... | |
TiglReturnCode | tiglExportMeshedFuselageSTL (TiglCPACSConfigurationHandle cpacsHandle, int fuselageIndex, const char *filenamePtr, double deflection) |
Exports the boolean fused geometry of a fuselage meshed to STL format. More... | |
TiglReturnCode | tiglExportMeshedFuselageSTLByUID (TiglCPACSConfigurationHandle cpacsHandle, const char *fuselageUID, const char *filenamePtr, double deflection) |
Exports the boolean fused geometry of a fuselage meshed to STL format. More... | |
TiglReturnCode | tiglExportMeshedFuselageVTKByIndex (const TiglCPACSConfigurationHandle cpacsHandle, const int fuselageIndex, const char *filenamePtr, double deflection) |
Exports the boolean fused geometry of a fuselage (selected by index) meshed to VTK format. More... | |
TiglReturnCode | tiglExportMeshedFuselageVTKByUID (const TiglCPACSConfigurationHandle cpacsHandle, const char *fuselageUID, const char *filenamePtr, double deflection) |
Exports the boolean fused geometry of a fuselage (selected by uid) meshed to VTK format. More... | |
TiglReturnCode | tiglExportMeshedGeometrySTL (TiglCPACSConfigurationHandle cpacsHandle, const char *filenamePtr, double deflection) |
Exports the boolean fused geometry of the whole configuration meshed to STL format. More... | |
TiglReturnCode | tiglExportMeshedGeometryVTK (const TiglCPACSConfigurationHandle cpacsHandle, const char *filenamePtr, double deflection) |
Exports the boolean fused geometry of the whole configuration meshed to VTK format. More... | |
TiglReturnCode | tiglExportMeshedGeometryVTKSimple (const TiglCPACSConfigurationHandle cpacsHandle, const char *filenamePtr, double deflection) |
Exports the boolean fused geometry of the whole configuration meshed to VTK format. More... | |
TiglReturnCode | tiglExportMeshedWingSTL (TiglCPACSConfigurationHandle cpacsHandle, int wingIndex, const char *filenamePtr, double deflection) |
Exports the boolean fused geometry of a wing meshed to STL format. More... | |
TiglReturnCode | tiglExportMeshedWingSTLByUID (TiglCPACSConfigurationHandle cpacsHandle, const char *wingUID, const char *filenamePtr, double deflection) |
Exports the boolean fused geometry of a wing meshed to STL format. More... | |
TiglReturnCode | tiglExportMeshedWingVTKByIndex (const TiglCPACSConfigurationHandle cpacsHandle, const int wingIndex, const char *filenamePtr, const double deflection) |
Exports the boolean fused geometry of a wing (selected by id) meshed to VTK format. More... | |
TiglReturnCode | tiglExportMeshedWingVTKByUID (const TiglCPACSConfigurationHandle cpacsHandle, const char *wingUID, const char *filenamePtr, double deflection) |
Exports the boolean fused geometry of a wing (selected by UID) meshed to VTK format. More... | |
TiglReturnCode | tiglExportMeshedWingVTKSimpleByUID (const TiglCPACSConfigurationHandle cpacsHandle, const char *wingUID, const char *filenamePtr, double deflection) |
Exports the boolean fused geometry of a wing (selected by UID) meshed to VTK format. More... | |
TiglReturnCode | tiglExportSTEP (TiglCPACSConfigurationHandle cpacsHandle, const char *filenamePtr) |
Exports the geometry of a CPACS configuration to STEP format. More... | |
TiglReturnCode | tiglExportWingBREPByUID (TiglCPACSConfigurationHandle cpacsHandle, const char *wingUID, const char *filename) |
Exports the boolean fused geometry of a wing (selected by uid) to BREP format. More... | |
TiglReturnCode | tiglExportWingColladaByUID (const TiglCPACSConfigurationHandle cpacsHandle, const char *wingUID, const char *filename, double deflection) |
Exports the boolean fused geometry of a wing (selected by uid) meshed to Collada (*.dae) format. More... | |
TiglReturnCode | tiglFuselageGetCenterLineLength (TiglCPACSConfigurationHandle cpacsHandle, const char *fuselageUID, double *length) |
Returns the length of center line of the given fuselage with all its segments which connects all the center points of the cross sections of the fuselage. More... | |
TiglReturnCode | tiglFuselageGetCircumference (TiglCPACSConfigurationHandle cpacsHandle, int fuselageIndex, int segmentIndex, double eta, double *circumferencePtr) |
Returns the circumference of a fuselage surface for a given fuselage and segment index and an eta. More... | |
TiglReturnCode | tiglFuselageGetCrossSectionArea (TiglCPACSConfigurationHandle cpacsHandle, const char *fuselageSegmentUID, double eta, double *area) |
Returns the value of the area of a cross section of a fuselage. More... | |
TiglReturnCode | tiglFuselageGetEndConnectedSegmentCount (TiglCPACSConfigurationHandle cpacsHandle, int fuselageIndex, int segmentIndex, int *segmentCountPtr) |
Returns the count of segments connected to the end section of a given fuselage segment. More... | |
TiglReturnCode | tiglFuselageGetEndConnectedSegmentIndex (TiglCPACSConfigurationHandle cpacsHandle, int fuselageIndex, int segmentIndex, int n, int *connectedIndexPtr) |
Returns the index (number) of the n-th segment connected to the end section of a given fuselage segment. n starts at 1. More... | |
TiglReturnCode | tiglFuselageGetEndSectionAndElementIndex (TiglCPACSConfigurationHandle cpacsHandle, int fuselageIndex, int segmentIndex, int *sectionIndexPtr, int *elementIndexPtr) |
Returns the section index and section element index of the end side of a given fuselage segment. More... | |
TiglReturnCode | tiglFuselageGetEndSectionAndElementUID (TiglCPACSConfigurationHandle cpacsHandle, int fuselageIndex, int segmentIndex, char **sectionUIDPtr, char **elementUIDPtr) |
Returns the section UID and section element UID of the end side of a given fuselage segment. More... | |
TiglReturnCode | tiglFuselageGetIndex (TiglCPACSConfigurationHandle cpacsHandle, const char *fuselageUID, int *fuselageIndexPtr) |
Returns the index of a fuselage. More... | |
TiglReturnCode | tiglFuselageGetMinumumDistanceToGround (TiglCPACSConfigurationHandle cpacsHandle, char *fuselageUID, double axisPntX, double axisPntY, double axisPntZ, double axisDirX, double axisDirY, double axisDirZ, double angle, double *pointXPtr, double *pointYPtr, double *pointZPtr) |
Returns the point where the distance between the selected fuselage and the ground is at minimum. The Fuselage could be turned with a given angle at at given axis, specified by a point and a direction. More... | |
TiglReturnCode | tiglFuselageGetNumPointsOnXPlane (TiglCPACSConfigurationHandle cpacsHandle, int fuselageIndex, int segmentIndex, double eta, double xpos, int *numPointsPtr) |
Returns the number of points on a fuselage surface for a given fuselage and a give x-position. More... | |
TiglReturnCode | tiglFuselageGetNumPointsOnYPlane (TiglCPACSConfigurationHandle cpacsHandle, int fuselageIndex, int segmentIndex, double eta, double ypos, int *numPointsPtr) |
Returns the number of points on a fuselage surface for a given fuselage and a give y-position. More... | |
TiglReturnCode | tiglFuselageGetPoint (TiglCPACSConfigurationHandle cpacsHandle, int fuselageIndex, int segmentIndex, double eta, double zeta, double *pointXPtr, double *pointYPtr, double *pointZPtr) |
Returns a point on a fuselage surface for a given fuselage and segment index. More... | |
TiglReturnCode | tiglFuselageGetPointAngle (TiglCPACSConfigurationHandle cpacsHandle, int fuselageIndex, int segmentIndex, double eta, double alpha, double *pointXPtr, double *pointYPtr, double *pointZPtr) |
Returns a point on a fuselage surface for a given fuselage and segment index and an angle alpha (degree). More... | |
TiglReturnCode | tiglFuselageGetPointAngleTranslated (TiglCPACSConfigurationHandle cpacsHandle, int fuselageIndex, int segmentIndex, double eta, double alpha, double y_cs, double z_cs, double *pointXPtr, double *pointYPtr, double *pointZPtr) |
Returns a point on a fuselage surface for a given fuselage and segment index and an angle alpha (degree). 0 degree of the angle alpha is meant to be "up" in the direction of the positive z-axis like specifies in cpacs. The origin of the line that will be rotated with the angle alpha could be translated via the parameters y_cs and z_cs. More... | |
TiglReturnCode | tiglFuselageGetPointOnXPlane (TiglCPACSConfigurationHandle cpacsHandle, int fuselageIndex, int segmentIndex, double eta, double xpos, int pointIndex, double *pointXPtr, double *pointYPtr, double *pointZPtr) |
Returns a point on a fuselage surface for a given fuselage and segment index. More... | |
TiglReturnCode | tiglFuselageGetPointOnYPlane (TiglCPACSConfigurationHandle cpacsHandle, int fuselageIndex, int segmentIndex, double eta, double ypos, int pointIndex, double *pointXPtr, double *pointYPtr, double *pointZPtr) |
Returns a point on a fuselage surface for a given fuselage and segment index. More... | |
TiglReturnCode | tiglFuselageGetProfileName (TiglCPACSConfigurationHandle cpacsHandle, int fuselageIndex, int sectionIndex, int elementIndex, char **profileNamePtr) |
Returns the name of a fuselage profile. The string returned must not be deleted by the caller via free(). It will be deleted when the CPACS configuration is closed. More... | |
TiglReturnCode | tiglFuselageGetSectionCenter (TiglCPACSConfigurationHandle cpacsHandle, const char *fuselageSegmentUID, double eta, double *pointX, double *pointY, double *pointZ) |
Returns the section center of a fuselage. More... | |
TiglReturnCode | tiglFuselageGetSectionCount (TiglCPACSConfigurationHandle cpacsHandle, int fuselageIndex, int *sectionCount) |
Returns the number of sections of a fuselage. More... | |
TiglReturnCode | tiglFuselageGetSectionUID (TiglCPACSConfigurationHandle cpacsHandle, int fuselageIndex, int sectionIndex, char **uidNamePtr) |
Returns the UID of a section of a fuselage. The string returned must not be deleted by the caller via free(). It will be deleted when the CPACS configuration is closed. More... | |
TiglReturnCode | tiglFuselageGetSegmentCount (TiglCPACSConfigurationHandle cpacsHandle, int fuselageIndex, int *segmentCountPtr) |
Returns the number of segments for a fuselage in a CPACS configuration. More... | |
TiglReturnCode | tiglFuselageGetSegmentIndex (TiglCPACSConfigurationHandle cpacsHandle, const char *segmentUID, int *segmentIndexPtr, int *fuselageIndexPtr) |
Returns the Index of a segment of a fuselage. More... | |
TiglReturnCode | tiglFuselageGetSegmentSurfaceArea (TiglCPACSConfigurationHandle cpacsHandle, int fuselageIndex, int segmentIndex, double *surfaceAreaPtr) |
Returns the surface area of a segment of a fuselage. More... | |
TiglReturnCode | tiglFuselageGetSegmentUID (TiglCPACSConfigurationHandle cpacsHandle, int fuselageIndex, int segmentIndex, char **uidNamePtr) |
Returns the UID of a segment of a fuselage. The string returned must not be deleted by the caller via free(). It will be deleted when the CPACS configuration is closed. More... | |
TiglReturnCode | tiglFuselageGetSegmentVolume (TiglCPACSConfigurationHandle cpacsHandle, int fuselageIndex, int segmentIndex, double *volumePtr) |
Returns the volume of a segment of a fuselage. More... | |
TiglReturnCode | tiglFuselageGetStartConnectedSegmentCount (TiglCPACSConfigurationHandle cpacsHandle, int fuselageIndex, int segmentIndex, int *segmentCountPtr) |
Returns the count of segments connected to the start section of a given fuselage segment. More... | |
TiglReturnCode | tiglFuselageGetStartConnectedSegmentIndex (TiglCPACSConfigurationHandle cpacsHandle, int fuselageIndex, int segmentIndex, int n, int *connectedIndexPtr) |
Returns the index (number) of the n-th segment connected to the start section of a given fuselage segment. n starts at 1. More... | |
TiglReturnCode | tiglFuselageGetStartSectionAndElementIndex (TiglCPACSConfigurationHandle cpacsHandle, int fuselageIndex, int segmentIndex, int *sectionIndexPtr, int *elementIndexPtr) |
Returns the section index and section element index of the start side of a given fuselage segment. More... | |
TiglReturnCode | tiglFuselageGetStartSectionAndElementUID (TiglCPACSConfigurationHandle cpacsHandle, int fuselageIndex, int segmentIndex, char **sectionUIDPtr, char **elementUIDPtr) |
Returns the section UID and section element UID of the start side of a given fuselage segment. More... | |
TiglReturnCode | tiglFuselageGetSurfaceArea (TiglCPACSConfigurationHandle cpacsHandle, int fuselageIndex, double *surfaceAreaPtr) |
Returns the surface area of the fuselage. Currently, the area includes also the faces on the fuselage symmetry plane (in case of a symmetric wing). This is in particular a problem for fuselages, where only one half side is defined in CPACS. In future releases, these faces will not belong anymore to the surface area calculation. More... | |
TiglReturnCode | tiglFuselageGetSymmetry (TiglCPACSConfigurationHandle cpacsHandle, int fuselageIndex, TiglSymmetryAxis *symmetryAxisPtr) |
Returns the Symmetry Enum if the fuselage has symmetry-axis. More... | |
TiglReturnCode | tiglFuselageGetUID (TiglCPACSConfigurationHandle cpacsHandle, int fuselageIndex, char **uidNamePtr) |
Returns the UID of a fuselage. The string returned must not be deleted by the caller via free(). It will be deleted when the CPACS configuration is closed. More... | |
TiglReturnCode | tiglFuselageGetVolume (TiglCPACSConfigurationHandle cpacsHandle, int fuselageIndex, double *volumePtr) |
Returns the volume of the fuselage. More... | |
TiglReturnCode | tiglFuselageSetGetPointBehavior (TiglCPACSConfigurationHandle cpacsHandle, TiglGetPointBehavior behavior) |
Sets the behavior of the tiglFuselageGetPoint function. More... | |
TiglReturnCode | tiglGetControlSurfaceCount (TiglCPACSConfigurationHandle cpacsHandle, const char *componentSegmentUID, int *numControlSurfaces) |
Returns the number of control surfaces belonging to a component segment. More... | |
TiglReturnCode | tiglGetControlSurfaceType (TiglCPACSConfigurationHandle cpacsHandle, const char *controlSurfaceUID, TiglControlSurfaceType *controlSurfaceType) |
Returns the type of a control surface given its UID. More... | |
TiglReturnCode | tiglGetControlSurfaceUID (TiglCPACSConfigurationHandle cpacsHandle, const char *componentSegmentUID, int controlSurfaceIndex, char **controlSurfaceUID) |
Returns the UID of a control surface given its index in a component segment. More... | |
TiglReturnCode | tiglGetCPACSTixiHandle (TiglCPACSConfigurationHandle cpacsHandle, TixiDocumentHandle *tixiHandlePtr) |
Returns the underlying TixiDocumentHandle for a given CPACS configuration handle. More... | |
TiglReturnCode | tiglGetCurveIntersection (TiglCPACSConfigurationHandle cpacsHandle, const char *curvesID1, int curve1Idx, const char *curvesID2, int curve2Idx, double tolerance, char **intersectionID) |
tiglGetCurveIntersection computes intersection point of two (intersection) curves. Both curves are the result of a previous intersection (e.g. Fuselage-Wing Intersection). More... | |
TiglReturnCode | tiglGetCurveIntersectionCount (TiglCPACSConfigurationHandle cpacsHandle, const char *intersectionID, int *pointCount) |
tiglGetCurveIntersectionCount returns the number of intersection points computed by tiglGetCurveIntersection for the given intersectionID. More... | |
TiglReturnCode | tiglGetCurveIntersectionPoint (TiglCPACSConfigurationHandle cpacsHandle, const char *intersectionID, int pointIdx, double *pointX, double *pointY, double *pointZ) |
tiglGetCurveIntersectionPoint returns an intersection point calculated by tiglGetCurveIntersection More... | |
TiglReturnCode | tiglGetCurveParameter (TiglCPACSConfigurationHandle cpacsHandle, const char *curveID, int curveIdx, double pointX, double pointY, double pointZ, double *eta) |
tiglGetCurveParameter projects a point onto a curve of an intersection line. The intersection line is specified by a curveID. The curveID can be calculated using tiglIntersectComponents, tiglIntersectWithPlane or tiglIntersectWithPlaneSegment. The function returns the parameter eta of the projected point on the curve. More... | |
const char * | tiglGetErrorString (TiglReturnCode errorCode) |
Translates an error code into a string. More... | |
TiglReturnCode | tiglGetFuselageCount (TiglCPACSConfigurationHandle cpacsHandle, int *fuselageCountPtr) |
Returns the number of fuselages in a CPACS configuration. More... | |
TiglReturnCode | tiglGetRotorCount (TiglCPACSConfigurationHandle cpacsHandle, int *rotorCountPtr) |
Returns the number of rotors in a CPACS configuration. More... | |
const char * | tiglGetVersion () |
Returns the version number of this TIGL version. More... | |
TiglReturnCode | tiglGetWingCount (TiglCPACSConfigurationHandle cpacsHandle, int *wingCountPtr) |
Returns the number of wings in a CPACS configuration. More... | |
TiglReturnCode | tiglIntersectComponents (TiglCPACSConfigurationHandle cpacsHandle, const char *componentUidOne, const char *componentUidTwo, char **intersectionID) |
tiglIntersectComponents computes the intersection line(s) between two shapes specified by their CPACS uid. It returns an intersection ID for further computations on the result. To query points on the intersection line, tiglIntersectGetPoint has to be called. More... | |
TiglReturnCode | tiglIntersectGetLineCount (TiglCPACSConfigurationHandle cpacsHandle, const char *intersectionID, int *lineCount) |
tiglIntersectGetLineCount returns the number of intersection lines computed by tiglIntersectComponents, tiglIntersectWithPlane or tiglIntersectWithPlaneSegment for the given intersectionID. More... | |
TiglReturnCode | tiglIntersectGetPoint (TiglCPACSConfigurationHandle cpacsHandle, const char *intersectionID, int lineIdx, double eta, double *pointX, double *pointY, double *pointZ) |
tiglIntersectGetPoint samples a point on an intersection line calculated by tiglIntersectComponents, tiglIntersectWithPlane or tiglIntersectWithPlaneSegment. More... | |
TiglReturnCode | tiglIntersectWithPlane (TiglCPACSConfigurationHandle cpacsHandle, const char *componentUid, double px, double py, double pz, double nx, double ny, double nz, char **intersectionID) |
tiglIntersectWithPlane computes the intersection line(s) between a shape and a plane. It returns an intersection ID for further computations on the result. To query points on the intersection line, tiglIntersectGetPoint has to be called. More... | |
TiglReturnCode | tiglIntersectWithPlaneSegment (TiglCPACSConfigurationHandle cpacsHandle, const char *componentUid, double p1x, double p1y, double p1z, double p2x, double p2y, double p2z, double wx, double wy, double wz, char **intersectionID) |
tiglIntersectWithPlaneSegment computes the intersection line(s) between a shape and a plane segment. The plane segment is defined by p(u,v) = P1*(1-u) + P2*u + w*v, with u in [0,1] (see image). More... | |
TiglReturnCode | tiglIsCPACSConfigurationHandleValid (TiglCPACSConfigurationHandle cpacsHandle, TiglBoolean *isValidPtr) |
Checks if a given CPACS configuration handle is a valid. More... | |
TiglReturnCode | tiglLogSetFileEnding (const char *ending) |
Sets the file ending for logging files. Default is "log". More... | |
TiglReturnCode | tiglLogSetTimeInFilenameEnabled (TiglBoolean enabled) |
Enables or disables appending a unique date/time identifier inside the log file name (behind the file prefix). By default, the time identifier is enabled. More... | |
TiglReturnCode | tiglLogSetVerbosity (TiglLogLevel level) |
Set the console verbosity level. More... | |
TiglReturnCode | tiglLogToFileDisabled () |
Disabled file logging. If a log file is currently opened by TiGL it will be closed. The log messages are printed to console. This is the default logging mechanism of TIGL. More... | |
TiglReturnCode | tiglLogToFileEnabled (const char *filePrefix) |
Sets up the tigl logging mechanism to send all log messages into a file. More... | |
TiglReturnCode | tiglLogToFileStreamEnabled (FILE *fp) |
Sets up the tigl logging mechanism to send all log messages into an already opened file. More... | |
TiglReturnCode | tiglOpenCPACSConfiguration (TixiDocumentHandle tixiHandle, const char *configurationUID, TiglCPACSConfigurationHandle *cpacsHandlePtr) |
Opens a CPACS configuration and builds up the data and geometry structure in memory. More... | |
TiglReturnCode | tiglProfileGetBSplineCount (TiglCPACSConfigurationHandle cpacsHandle, const char *profileUID, int *curveCount) |
Returns the number of curves the given profile is made of. More... | |
TiglReturnCode | tiglProfileGetBSplineData (TiglCPACSConfigurationHandle cpacsHandle, const char *profileUID, int curveid, int nControlPoints, double *cpx, double *cpy, double *cpz, int nKnots, double *knots) |
Returns the B-Spline data of the given profile curve. This includes the knot vector and the control points of the B-Spline. More... | |
TiglReturnCode | tiglProfileGetBSplineDataSizes (TiglCPACSConfigurationHandle cpacsHandle, const char *profileUID, int curveid, int *degree, int *nControlPoints, int *nKnots) |
Returns the B-Spline data sizes for a given curve on a profile. This includes size of the knot vector, size of the control point vector and degree of the spline. More... | |
TiglReturnCode | tiglRotorBladeGetAzimuthAngle (TiglCPACSConfigurationHandle cpacsHandle, int rotorIndex, int rotorBladeIndex, double *azimuthAnglePtr) |
Returns the azimuth angle of a rotor blade in degrees. More... | |
TiglReturnCode | tiglRotorBladeGetLocalChord (TiglCPACSConfigurationHandle cpacsHandle, int rotorIndex, int rotorBladeIndex, int segmentIndex, double eta, double *chordPtr) |
Returns the local chord length of a rotor blade. More... | |
TiglReturnCode | tiglRotorBladeGetLocalRadius (TiglCPACSConfigurationHandle cpacsHandle, int rotorIndex, int rotorBladeIndex, int segmentIndex, double eta, double *radiusPtr) |
Returns the local radius of a rotor blade. More... | |
TiglReturnCode | tiglRotorBladeGetLocalTwistAngle (TiglCPACSConfigurationHandle cpacsHandle, int rotorIndex, int rotorBladeIndex, int segmentIndex, double eta, double *twistAnglePtr) |
Returns the local twist angle [deg] of a rotor blade. More... | |
TiglReturnCode | tiglRotorBladeGetPlanformArea (TiglCPACSConfigurationHandle cpacsHandle, int rotorIndex, int rotorBladeIndex, double *planformAreaPtr) |
Returns the planform area of the rotor blade. More... | |
TiglReturnCode | tiglRotorBladeGetRadius (TiglCPACSConfigurationHandle cpacsHandle, int rotorIndex, int rotorBladeIndex, double *radiusPtr) |
Returns the radius of a rotor blade. More... | |
TiglReturnCode | tiglRotorBladeGetSurfaceArea (TiglCPACSConfigurationHandle cpacsHandle, int rotorIndex, int rotorBladeIndex, double *surfaceAreaPtr) |
Returns the surface area of the rotor blade. More... | |
TiglReturnCode | tiglRotorBladeGetTipSpeed (TiglCPACSConfigurationHandle cpacsHandle, int rotorIndex, int rotorBladeIndex, double *tipSpeedPtr) |
Returns the tip speed of a rotor blade [m/s]. More... | |
TiglReturnCode | tiglRotorBladeGetVolume (TiglCPACSConfigurationHandle cpacsHandle, int rotorIndex, int rotorBladeIndex, double *volumePtr) |
Returns the volume of the rotor blade. More... | |
TiglReturnCode | tiglRotorBladeGetWingIndex (TiglCPACSConfigurationHandle cpacsHandle, int rotorIndex, int rotorBladeIndex, int *wingIndexPtr) |
Returns the index of the parent wing definition of a rotor blade. More... | |
TiglReturnCode | tiglRotorBladeGetWingUID (TiglCPACSConfigurationHandle cpacsHandle, int rotorIndex, int rotorBladeIndex, char **wingUIDPtr) |
Returns the UID of the parent wing definition of a rotor blade. More... | |
TiglReturnCode | tiglRotorGetIndex (TiglCPACSConfigurationHandle cpacsHandle, const char *rotorUID, int *rotorIndexPtr) |
Returns the Index of a rotor. More... | |
TiglReturnCode | tiglRotorGetRadius (TiglCPACSConfigurationHandle cpacsHandle, int rotorIndex, double *radiusPtr) |
Returns the radius of the rotor. More... | |
TiglReturnCode | tiglRotorGetReferenceArea (TiglCPACSConfigurationHandle cpacsHandle, int rotorIndex, double *referenceAreaPtr) |
Returns the reference area of the rotor. More... | |
TiglReturnCode | tiglRotorGetRotorBladeCount (TiglCPACSConfigurationHandle cpacsHandle, int rotorIndex, int *rotorBladeCountPtr) |
Returns the total number of rotor blades attached to a rotor. More... | |
TiglReturnCode | tiglRotorGetSolidity (TiglCPACSConfigurationHandle cpacsHandle, int rotorIndex, double *solidityPtr) |
Returns the solidity of the rotor. More... | |
TiglReturnCode | tiglRotorGetSurfaceArea (TiglCPACSConfigurationHandle cpacsHandle, int rotorIndex, double *surfaceAreaPtr) |
Returns the surface area of the rotor. More... | |
TiglReturnCode | tiglRotorGetTipSpeed (TiglCPACSConfigurationHandle cpacsHandle, int rotorIndex, double *tipSpeedPtr) |
Returns the tip speed of the rotor in [m/s]. More... | |
TiglReturnCode | tiglRotorGetTotalBladePlanformArea (TiglCPACSConfigurationHandle cpacsHandle, int rotorIndex, double *totalBladePlanformAreaPtr) |
Returns the total blade planform area of the rotor. More... | |
TiglReturnCode | tiglRotorGetUID (TiglCPACSConfigurationHandle cpacsHandle, int rotorIndex, char **uidNamePtr) |
Returns the UID of a rotor. The string returned must not be deleted by the caller via free(). It will be deleted when the CPACS configuration is closed. More... | |
TiglReturnCode | tiglRotorGetVolume (TiglCPACSConfigurationHandle cpacsHandle, int rotorIndex, double *volumePtr) |
Returns the volume of the rotor. More... | |
TiglReturnCode | tiglSaveCPACSConfiguration (const char *configurationUID, TiglCPACSConfigurationHandle cpacsHandle) |
Writes a CPACS configuration based on the data and geometry structure in memory. More... | |
void | tiglSetDebugDataDirectory (const char *directory) |
Set the directory path for debug data. More... | |
TiglReturnCode | tiglSetExportOptions (const char *exporter_name, const char *option_name, const char *option_value) |
Sets options for the geometry export. More... | |
TiglReturnCode | tiglWingComponentSegmentComputeEtaIntersection (TiglCPACSConfigurationHandle cpacsHandle, const char *componentSegmentUID, double csEta1, double csXsi1, double csEta2, double csXsi2, double eta, double *xsi, TiglBoolean *hasWarning) |
This function is deprecated. Use the generalized function tiglWingInterpolateXsi. More... | |
TiglReturnCode | tiglWingComponentSegmentFindSegment (TiglCPACSConfigurationHandle cpacsHandle, const char *componentSegmentUID, double x, double y, double z, char **segmentUID, char **wingUID) |
Returns the segmentUID and wingUID for a given point on a componentSegment. The returned strings must not be freed by the user anymore. More... | |
TiglReturnCode | tiglWingComponentSegmentGetMaterialCount (TiglCPACSConfigurationHandle cpacsHandle, const char *compSegmentUID, TiglStructureType structureType, double eta, double xsi, int *materialCount) |
Returns the number of materials defined at a point on the wing component segment surface. More... | |
TiglReturnCode | tiglWingComponentSegmentGetMaterialThickness (TiglCPACSConfigurationHandle cpacsHandle, const char *compSegmentUID, TiglStructureType structureType, double eta, double xsi, int materialIndex, double *thickness) |
Returns one of the material thicknesses of a given point on the wing component segment surface. The number of materials on that point has to be first queried using tiglWingComponentSegmentGetMaterialCount. More... | |
TiglReturnCode | tiglWingComponentSegmentGetMaterialUID (TiglCPACSConfigurationHandle cpacsHandle, const char *compSegmentUID, TiglStructureType structureType, double eta, double xsi, int materialIndex, char **uid) |
Returns one of the material UIDs of a given point on the wing component segment surface. The number of materials on that point has to be first queried using tiglWingComponentSegmentGetMaterialCount. More... | |
TiglReturnCode | tiglWingComponentSegmentGetNumberOfSegments (TiglCPACSConfigurationHandle cpacsHandle, const char *componentSegmentUID, int *nsegments) |
Returns the number of segments belonging to a component segment. More... | |
TiglReturnCode | tiglWingComponentSegmentGetPoint (TiglCPACSConfigurationHandle cpacsHandle, const char *componentSegmentUID, double eta, double xsi, double *x, double *y, double *z) |
Returns x,y,z coordinates for a given eta and xsi on a componentSegment. More... | |
TiglReturnCode | tiglWingComponentSegmentGetSegmentIntersection (TiglCPACSConfigurationHandle cpacsHandle, const char *componentSegmentUID, const char *segmentUID, double csEta1, double csXsi1, double csEta2, double csXsi2, double segmentEta, double *segmentXsi, TiglBoolean *hasWarning) |
This function is deprecated. Use the generalized function tiglWingInterpolateXsi. More... | |
TiglReturnCode | tiglWingComponentSegmentGetSegmentUID (TiglCPACSConfigurationHandle cpacsHandle, const char *componentSegmentUID, int segmentIndex, char **segmentUID) |
Returns the segment UID of a segment belonging to a component segment. The segment is specified with its index, which is in the 1...nsegments. The number of segments nsegments can be queried with tiglWingComponentSegmentGetNumberOfSegments. More... | |
TiglReturnCode | tiglWingComponentSegmentPointGetEtaXsi (TiglCPACSConfigurationHandle cpacsHandle, const char *componentSegmentUID, double pX, double pY, double pZ, double *eta, double *xsi, double *errorDistance) |
Projects a points onto the chord face of the wing component segment and returns the eta/xsi coordinates of the point of projection. More... | |
TiglReturnCode | tiglWingComponentSegmentPointGetSegmentEtaXsi (TiglCPACSConfigurationHandle cpacsHandle, const char *componentSegmentUID, double eta, double xsi, char **wingUID, char **segmentUID, double *segmentEta, double *segmentXsi) |
Returns eta, xsi, segmentUID and wingUID for a given eta and xsi on a componentSegment. More... | |
TiglReturnCode | tiglWingGetChordNormal (TiglCPACSConfigurationHandle cpacsHandle, int wingIndex, int segmentIndex, double eta, double xsi, double *normalXPtr, double *normalYPtr, double *normalZPtr) |
Returns a normal vector on the wing chord surface for a a given wing and segment index. More... | |
TiglReturnCode | tiglWingGetChordPoint (TiglCPACSConfigurationHandle cpacsHandle, int wingIndex, int segmentIndex, double eta, double xsi, double *pointXPtr, double *pointYPtr, double *pointZPtr) |
Returns a point on the wing chord surface for a a given wing and segment index. More... | |
TiglReturnCode | tiglWingGetComponentSegmentCount (TiglCPACSConfigurationHandle cpacsHandle, int wingIndex, int *compSegmentCountPtr) |
Returns the number of component segments for a wing in a CPACS configuration. More... | |
TiglReturnCode | tiglWingGetComponentSegmentIndex (TiglCPACSConfigurationHandle cpacsHandle, int wingIndex, const char *compSegmentUID, int *segmentIndexPtr) |
Returns the Index of a component segment of a wing. More... | |
TiglReturnCode | tiglWingGetComponentSegmentUID (TiglCPACSConfigurationHandle cpacsHandle, int wingIndex, int compSegmentIndex, char **uidNamePtr) |
Returns the UID of a component segment of a wing. The string returned must not be deleted by the caller via free(). It will be deleted when the CPACS configuration is closed. More... | |
TiglReturnCode | tiglWingGetIndex (TiglCPACSConfigurationHandle cpacsHandle, const char *wingUID, int *wingIndexPtr) |
Returns the Index of a wing. More... | |
TiglReturnCode | tiglWingGetInnerConnectedSegmentCount (TiglCPACSConfigurationHandle cpacsHandle, int wingIndex, int segmentIndex, int *segmentCountPtr) |
Returns the count of wing segments connected to the inner section of a given segment. More... | |
TiglReturnCode | tiglWingGetInnerConnectedSegmentIndex (TiglCPACSConfigurationHandle cpacsHandle, int wingIndex, int segmentIndex, int n, int *connectedIndexPtr) |
Returns the index (number) of the n-th wing segment connected to the inner section of a given segment. n starts at 1. More... | |
TiglReturnCode | tiglWingGetInnerSectionAndElementIndex (TiglCPACSConfigurationHandle cpacsHandle, int wingIndex, int segmentIndex, int *sectionIndexPtr, int *elementIndexPtr) |
Returns the section index and section element index of the inner side of a given wing segment. More... | |
TiglReturnCode | tiglWingGetInnerSectionAndElementUID (TiglCPACSConfigurationHandle cpacsHandle, int wingIndex, int segmentIndex, char **sectionUIDPtr, char **elementUIDPtr) |
Returns the section UID and section element UID of the inner side of a given wing segment. More... | |
TiglReturnCode | tiglWingGetLowerPoint (TiglCPACSConfigurationHandle cpacsHandle, int wingIndex, int segmentIndex, double eta, double xsi, double *pointXPtr, double *pointYPtr, double *pointZPtr) |
Returns a point on the lower wing surface for a a given wing and segment index. More... | |
TiglReturnCode | tiglWingGetLowerPointAtDirection (TiglCPACSConfigurationHandle cpacsHandle, int wingIndex, int segmentIndex, double eta, double xsi, double dirx, double diry, double dirz, double *pointXPtr, double *pointYPtr, double *pointZPtr, double *errorDistance) |
Returns a point on the lower wing surface for a a given wing and segment index. This function is different from tiglWingGetLowerPoint: First, a point on the wing chord surface is computed (defined by segment index and eta,xsi). Then, a line is constructed, which is defined by this point and a direction given by the user. The intersection of this line with the lower wing surface is finally returned. The point is returned in absolute world coordinates. More... | |
TiglReturnCode | tiglWingGetMAC (TiglCPACSConfigurationHandle cpacsHandle, const char *wingUID, double *mac_chord, double *mac_x, double *mac_y, double *mac_z) |
This function calculates location of the quarter of mean aerodynamic chord, and gives the chord lenght as well. More... | |
TiglReturnCode | tiglWingGetOuterConnectedSegmentCount (TiglCPACSConfigurationHandle cpacsHandle, int wingIndex, int segmentIndex, int *segmentCountPtr) |
Returns the count of wing segments connected to the outer section of a given segment. More... | |
TiglReturnCode | tiglWingGetOuterConnectedSegmentIndex (TiglCPACSConfigurationHandle cpacsHandle, int wingIndex, int segmentIndex, int n, int *connectedIndexPtr) |
Returns the index (number) of the n-th wing segment connected to the outer section of a given segment. n starts at 1. More... | |
TiglReturnCode | tiglWingGetOuterSectionAndElementIndex (TiglCPACSConfigurationHandle cpacsHandle, int wingIndex, int segmentIndex, int *sectionIndexPtr, int *elementIndexPtr) |
Returns the section index and section element index of the outer side of a given wing segment. More... | |
TiglReturnCode | tiglWingGetOuterSectionAndElementUID (TiglCPACSConfigurationHandle cpacsHandle, int wingIndex, int segmentIndex, char **sectionUIDPtr, char **elementUIDPtr) |
Returns the section UID and section element UID of the outer side of a given wing segment. More... | |
TiglReturnCode | tiglWingGetProfileName (TiglCPACSConfigurationHandle cpacsHandle, int wingIndex, int sectionIndex, int elementIndex, char **profileNamePtr) |
Returns the name of a wing profile. The string returned must not be deleted by the caller via free(). It will be deleted when the CPACS configuration is closed. More... | |
TiglReturnCode | tiglWingGetReferenceArea (TiglCPACSConfigurationHandle cpacsHandle, int wingIndex, TiglSymmetryAxis symPlane, double *referenceAreaPtr) |
Returns the reference area of the wing. More... | |
TiglReturnCode | tiglWingGetSectionCount (TiglCPACSConfigurationHandle cpacsHandle, int wingIndex, int *sectionCount) |
Returns the number of sections of a wing. More... | |
TiglReturnCode | tiglWingGetSectionUID (TiglCPACSConfigurationHandle cpacsHandle, int wingIndex, int sectionIndex, char **uidNamePtr) |
Returns the UID of a section of a wing. The string returned must not be deleted by the caller via free(). It will be deleted when the CPACS configuration is closed. More... | |
TiglReturnCode | tiglWingGetSegmentCount (TiglCPACSConfigurationHandle cpacsHandle, int wingIndex, int *segmentCountPtr) |
Returns the number of segments for a wing in a CPACS configuration. More... | |
TiglReturnCode | tiglWingGetSegmentEtaXsi (TiglCPACSConfigurationHandle cpacsHandle, int wingIndex, double pointX, double pointY, double pointZ, int *segmentIndex, double *eta, double *xsi, int *isOnTop) |
Inverse function to tiglWingGetLowerPoint and tiglWingGetLowerPoint. Calculates to a point (x,y,z) in global coordinates the wing segment coordinates and the wing segment index. More... | |
TiglReturnCode | tiglWingGetSegmentIndex (TiglCPACSConfigurationHandle cpacsHandle, const char *segmentUID, int *segmentIndexPtr, int *wingIndexPtr) |
Returns the Index of a segment of a wing. More... | |
TiglReturnCode | tiglWingGetSegmentLowerSurfaceAreaTrimmed (TiglCPACSConfigurationHandle cpacsHandle, int wingIndex, int segmentIndex, double eta1, double xsi1, double eta2, double xsi2, double eta3, double xsi3, double eta4, double xsi4, double *surfaceArea) |
Computes the area of the trimmed lower wing segment surface. This function can be e.g. used to determine the area of the wing flaps. More... | |
TiglReturnCode | tiglWingGetSegmentSurfaceArea (TiglCPACSConfigurationHandle cpacsHandle, int wingIndex, int segmentIndex, double *surfaceAreaPtr) |
Returns the surface area of a segment of a wing. This includes only the area of the upper and lower wing segment surface and does not include the trailing egde or any closing faces. More... | |
TiglReturnCode | tiglWingGetSegmentUID (TiglCPACSConfigurationHandle cpacsHandle, int wingIndex, int segmentIndex, char **uidNamePtr) |
Returns the UID of a segment of a wing. The string returned must not be deleted by the caller via free(). It will be deleted when the CPACS configuration is closed. More... | |
TiglReturnCode | tiglWingGetSegmentUpperSurfaceAreaTrimmed (TiglCPACSConfigurationHandle cpacsHandle, int wingIndex, int segmentIndex, double eta1, double xsi1, double eta2, double xsi2, double eta3, double xsi3, double eta4, double xsi4, double *surfaceArea) |
Computes the area of the trimmed upper wing segment surface. This function can be e.g. used to determine the area of the wing flaps. More... | |
TiglReturnCode | tiglWingGetSegmentVolume (TiglCPACSConfigurationHandle cpacsHandle, int wingIndex, int segmentIndex, double *volumePtr) |
Returns the volume of a segment of a wing. More... | |
TiglReturnCode | tiglWingGetSpan (TiglCPACSConfigurationHandle cpacsHandle, const char *wingUID, double *pSpan) |
Returns the span of a wing. More... | |
TiglReturnCode | tiglWingGetSurfaceArea (TiglCPACSConfigurationHandle cpacsHandle, int wingIndex, double *surfaceAreaPtr) |
Returns the surface area of the wing. Currently, the area includes also the faces on the wing symmetry plane (in case of a symmetric wing). In coming releases, these faces will not belong anymore to the surface area calculation. More... | |
TiglReturnCode | tiglWingGetSymmetry (TiglCPACSConfigurationHandle cpacsHandle, int wingIndex, TiglSymmetryAxis *symmetryAxisPtr) |
Returns the Symmetry Enum if the wing has symmetry-axis. More... | |
TiglReturnCode | tiglWingGetUID (TiglCPACSConfigurationHandle cpacsHandle, int wingIndex, char **uidNamePtr) |
Returns the UID of a wing. The string returned must not be deleted by the caller via free(). It will be deleted when the CPACS configuration is closed. More... | |
TiglReturnCode | tiglWingGetUpperPoint (TiglCPACSConfigurationHandle cpacsHandle, int wingIndex, int segmentIndex, double eta, double xsi, double *pointXPtr, double *pointYPtr, double *pointZPtr) |
Returns a point on the upper wing surface for a a given wing and segment index. More... | |
TiglReturnCode | tiglWingGetUpperPointAtDirection (TiglCPACSConfigurationHandle cpacsHandle, int wingIndex, int segmentIndex, double eta, double xsi, double dirx, double diry, double dirz, double *pointXPtr, double *pointYPtr, double *pointZPtr, double *errorDistance) |
Returns a point on the upper wing surface for a a given wing and segment index. This function is different from tiglWingGetUpperPoint: First, a point on the wing chord surface is computed (defined by segment index and eta,xsi). Then, a line is constructed, which is defined by this point and a direction given by the user. The intersection of this line with the upper wing surface is finally returned. The point is returned in absolute world coordinates. More... | |
TiglReturnCode | tiglWingGetVolume (TiglCPACSConfigurationHandle cpacsHandle, int wingIndex, double *volumePtr) |
Returns the volume of the wing. More... | |
TiglReturnCode | tiglWingGetWettedArea (TiglCPACSConfigurationHandle cpacsHandle, const char *wingUID, double *wettedAreaPtr) |
Returns the wetted area of the wing. If the wing has no parent (fuselage), it returns the surface area of the wing. More... | |
TiglReturnCode | tiglWingInterpolateXsi (TiglCPACSConfigurationHandle cpacsHandle, const char *firstUID, double firstEta, double firstXsi, const char *secondUID, double secondEta, double secondXsi, const char *intersectionUID, double intersectionEta, double *intersectionXsi, TiglBoolean *hasWarning) |
Given a straight line in space defined by a pair of segment / component segment (eta,xsi) coordinates, the function computes the intersection of the line with an iso-eta line of a segment or component segment. More... | |
TiglReturnCode | tiglWingSegmentPointGetComponentSegmentEtaXsi (TiglCPACSConfigurationHandle cpacsHandle, const char *segmentUID, const char *componentSegmentUID, double segmentEta, double segmentXsi, double *eta, double *xsi) |
Returns eta, xsi coordinates of a componentSegment given segmentEta and segmentXsi on a wing segment. More... | |
TiglReturnCode | tiglWingSetGetPointBehavior (TiglCPACSConfigurationHandle cpacsHandle, TiglGetPointBehavior behavior) |
Sets the behavior of the tiglWingGetUpperPoint and tiglWingGetLowerPoint functions. More... | |
Variables | |
const typedef char ** | TiglStringList |
Declaration of the TIGL C interface.
#define TIGL_COMMON_EXPORT |
#define TIGL_H |
typedef enum TiglAlgorithmCode TiglAlgorithmCode |
Typedef for possible algorithm types used in calculations.
Possible values for variables of type TiglAlgorithmCode are:
typedef enum TiglBoolean TiglBoolean |
Definition of boolean type used in TIGL.
Possible values are:
typedef enum TiglContinuity TiglContinuity |
typedef enum TiglControlSurfaceType TiglControlSurfaceType |
typedef enum TiglCoordinateSystem TiglCoordinateSystem |
typedef int TiglCPACSConfigurationHandle |
Datatype for a CPACS configuration handle.
typedef unsigned long TiglGeometricComponentIntent |
typedef enum TiglGeometricComponentType TiglGeometricComponentType |
typedef enum TiglGetPointBehavior TiglGetPointBehavior |
typedef enum TiglImportExportFormat TiglImportExportFormat |
Definition of the different file formats used for import/export used in TIGL.
Possible values are:
typedef enum TiglLoftSide TiglLoftSide |
typedef enum TiglLogLevel TiglLogLevel |
Definition of logging levels.
Possible values are:
typedef enum TiglReturnCode TiglReturnCode |
Definition of error return type.
Possible values are:
typedef enum TiglShapeModifier TiglShapeModifier |
typedef enum TiglStructureType TiglStructureType |
typedef enum TiglSymmetryAxis TiglSymmetryAxis |
Definition of Symmetry Axis used in TIGL.
Possible values are:
enum TiglContinuity |
enum TiglCoordinateSystem |
enum TiglGetPointBehavior |
Options for the behavior of the GetPoint functions.
Enumerator | |
---|---|
asParameterOnSurface | |
onLinearLoft | |
numGetPointBehaviors |
enum TiglLoftSide |
enum TiglShapeModifier |
enum TiglStructureType |
TiglReturnCode tiglCheckPointInside | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
double | px, | ||
double | py, | ||
double | pz, | ||
const char * | componentUID, | ||
TiglBoolean * | isInside | ||
) |
Checks whether a point lies inside the given geometric object. Note that the symmetry attribute is ignored.
This function works only for solid objects!
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | px | X coordinate of point |
[in] | py | Y coordinate of point |
[in] | pz | Z coordinate of point |
[in] | componentUID | UID of the component (e.g. a fuselage UID, wing UID, wing segment UID ...) |
[out] | isInside | Returns, whether the point lies inside the object or not. |
TiglReturnCode tiglCloseCPACSConfiguration | ( | TiglCPACSConfigurationHandle | cpacsHandle | ) |
Closes a CPACS configuration and cleans up all memory used by the configuration. After closing a configuration the associated configuration handle is no longer valid. When the CPACS configuration has been closed, the companion tixi document can also be closed.
[in] | cpacsHandle | Handle for the CPACS configuration. |
TiglReturnCode tiglComponentGetHashCode | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | componentUID, | ||
int * | hashCodePtr | ||
) |
Returns a unique HashCode for a geometric component.
The component, for example a wing or a fuselage, could be specified via its UID. The HashCode is the same as long as the geometry of this component has not changed. The HashCode is valid through the current session only! The hash value is computed from the value of the underlying shape reference.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | componentUID | The uid of the component for which the hash should be computed |
[out] | hashCodePtr | The pointer to a hash value to represent this shape |
TiglReturnCode tiglComponentGetType | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | componentUID, | ||
TiglGeometricComponentType * | typePtr | ||
) |
Returns the type of a geometric component.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | componentUID | The uid of the component for which the hash should be computed |
[out] | typePtr | A pointer to a TiglGeometricComponentType to store the result |
TiglReturnCode tiglConfigurationGetBoundingBox | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
double * | minX, | ||
double * | minY, | ||
double * | minZ, | ||
double * | maxX, | ||
double * | maxY, | ||
double * | maxZ | ||
) |
Computes the bounding box coordinates of the configuration.
Note, that the resulting values are a fast but very rough approximation!
[in] | cpacsHandle | Handle for the CPACS configuration |
[out] | minX | Minimum x value |
[out] | minY | Minimum y value |
[out] | minZ | Minimum z value |
[out] | maxX | Maximum x value |
[out] | maxY | Maximum y value |
[out] | maxZ | Maximum z value |
TiglReturnCode tiglConfigurationGetLength | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
double * | pLength | ||
) |
Returns the length of the plane.
The calculation of the airplane lenght is realized as follows:
All part of the configuration (currently all wing and fuselage segments) are put into a bounding box. The length of the plane is returned as the length of the box in x-direction.
Note, that this resulting value is a fast but very rough approximation!
[in] | cpacsHandle | Handle for the CPACS configuration |
[out] | pLength | Length of plane |
TiglReturnCode tiglControlSurfaceGetControlParameter | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | controlSurfaceUID, | ||
double * | controlParameter | ||
) |
Returns the current value for the control parameter of a control device.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | controlSurfaceUID | UID of the control surface |
[out] | controlParameter | Value for the controlParameter |
TiglReturnCode tiglControlSurfaceGetDeflection | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | controlSurfaceUID, | ||
double * | deflection | ||
) |
This function is deprecated. It has been renamed to tiglControlSurfaceGetControlParameter.
TiglReturnCode tiglControlSurfaceGetMaximumControlParameter | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | controlSurfaceUID, | ||
double * | maxParameter | ||
) |
Returns the maximum value for the control parameter of a control device.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | controlSurfaceUID | UID of the control surface |
[out] | maxParameter | Maximum value for the control parameter |
TiglReturnCode tiglControlSurfaceGetMaximumDeflection | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | controlSurfaceUID, | ||
double * | maxDeflection | ||
) |
This function is deprecated. It has been renamed to tiglControlSurfaceGetMaximumControlParameter.
TiglReturnCode tiglControlSurfaceGetMinimumControlParameter | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | controlSurfaceUID, | ||
double * | minParameter | ||
) |
Returns the minimum value for the control parameter of a control device.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | controlSurfaceUID | UID of the control surface |
[out] | minParameter | Minimum value for the control parameter |
TiglReturnCode tiglControlSurfaceGetMinimumDeflection | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | controlSurfaceUID, | ||
double * | minDeflection | ||
) |
This function is deprecated. It has been renamed to tiglControlSurfaceGetMinimumControlParameter.
TiglReturnCode tiglControlSurfaceSetControlParameter | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | controlSurfaceUID, | ||
double | controlParameter | ||
) |
Sets the current value for the control parameter of a control device.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | controlSurfaceUID | UID of the control surface |
[out] | controlParameter | Value for the control parameter |
TiglReturnCode tiglControlSurfaceSetDeflection | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | controlSurfaceUID, | ||
double | deflection | ||
) |
This function is deprecated. It has been renamed to tiglControlSurfaceSetControlParameter.
TiglReturnCode tiglExportComponent | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | uid, | ||
const char * | fileName, | ||
double | deflection | ||
) |
Exports a geometric component (e.g. a wing, a fuselage etc.)
The component to be exported is definied via its uid. The export format is specified with the file extension of fileName.
The export can be configured in more detail using tiglSetExportOptions.
Supported file formats are: STEP (*.stp), IGES (*.igs), VTK (*.vtp), Collada (*.dae), STL (*.stl) and BREP (*.brep)
Example: Export a wing to IGES format
tiglExportComponent(handle, "MyWingUID", "wing.igs", 0.);
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | uid | Uid of the component to be exported |
[in] | fileName | File name of the exported file |
[in] | deflection | Deflection parameter. This is only used for meshed exports (e.g. VTK, STL, Collada). |
TiglReturnCode tiglExportConfiguration | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | fileName, | ||
TiglBoolean | fuseAllShapes, | ||
double | deflection | ||
) |
Exports the whole configuration into a file.
It can be specified, whether the configuration should be exported as a fused geometry (i.e. all shapes are trimmed with each other). The export format is specified with the file extension of fileName.
The export can be configured in more detail using tiglSetExportOptions.
Supported file formats are: STEP (*.stp), IGES (*.igs), VTK (*.vtp), Collada (*.dae), STL (*.stl) and BREP (*.brep)
Example: Export the fused configuration to STEP format
tiglExportConfiguration(handle, "aircraft.stp", TIGL_TRUE, 0.);
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | fileName | File name of the exported file |
[in] | fuseAllShapes | Whether to fuse the geometry of not. Fusing can take a lot of time! |
[in] | deflection | Deflection parameter. This is only used for meshed exports (e.g. VTK, STL, Collada). |
TiglReturnCode tiglExportFusedBREP | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | filename | ||
) |
Exports the fused/trimmed geometry of a CPACS configuration to BREP format.
In order to fuse the geometry, boolean operations are performed. Depending on the complexity of the configuration, the fusing can take several minutes.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | filename | BREP export file name |
TiglReturnCode tiglExportFusedSTEP | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | filenamePtr | ||
) |
Exports the fused/trimmed geometry of a CPACS configuration to STEP format.
In order to fuse the geometry, boolean operations are performed. Depending on the complexity of the configuration, the fusing can take several minutes.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | filenamePtr | Pointer to an STEP export file name |
TiglReturnCode tiglExportFusedWingFuselageIGES | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | filenamePtr | ||
) |
Exports the boolean fused geometry of a CPACS configuration to IGES format.
To maintain compatibility with CATIA, the file suffix should be ".igs".
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | filenamePtr | Pointer to an IGES export file name |
TiglReturnCode tiglExportFuselageBREPByUID | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | fuselageUID, | ||
const char * | filename | ||
) |
Exports the boolean fused geometry of a fuselage (selected by uid) to BREP format.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | fuselageUID | UID of the Fuselage to export |
[in] | filename | BREP export file name |
TiglReturnCode tiglExportFuselageColladaByUID | ( | const TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | fuselageUID, | ||
const char * | filename, | ||
double | deflection | ||
) |
Exports the boolean fused geometry of a fuselage (selected by uid) meshed to Collada (*.dae) format.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | fuselageUID | UID of the Fuselage to export |
[in] | filename | Filename of the resulting collada file. It should contain the .dae file name ending. |
[in] | deflection | Maximum deflection of the triangulation from the real surface |
TiglReturnCode tiglExportIGES | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | filenamePtr | ||
) |
Exports the geometry of a CPACS configuration to IGES format.
To maintain compatibility with CATIA, the file suffix should be ".igs".
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | filenamePtr | Pointer to an IGES export file name |
TiglReturnCode tiglExportMeshedFuselageSTL | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | fuselageIndex, | ||
const char * | filenamePtr, | ||
double | deflection | ||
) |
Exports the boolean fused geometry of a fuselage meshed to STL format.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | fuselageIndex | Index of the Fuselage to export |
[in] | filenamePtr | Pointer to an STL export file name |
[in] | deflection | Maximum deflection of the triangulation from the real surface |
TiglReturnCode tiglExportMeshedFuselageSTLByUID | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | fuselageUID, | ||
const char * | filenamePtr, | ||
double | deflection | ||
) |
Exports the boolean fused geometry of a fuselage meshed to STL format.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | fuselageUID | UID of the Fuselage to export |
[in] | filenamePtr | Pointer to an STL export file name |
[in] | deflection | Maximum deflection of the triangulation from the real surface |
TiglReturnCode tiglExportMeshedFuselageVTKByIndex | ( | const TiglCPACSConfigurationHandle | cpacsHandle, |
const int | fuselageIndex, | ||
const char * | filenamePtr, | ||
double | deflection | ||
) |
Exports the boolean fused geometry of a fuselage (selected by index) meshed to VTK format.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | fuselageIndex | Index of the Fuselage to export |
[in] | filenamePtr | Pointer to an VTK export file name (*.vtp = polygonal XML_VTK) |
[in] | deflection | Maximum deflection of the triangulation from the real surface |
TiglReturnCode tiglExportMeshedFuselageVTKByUID | ( | const TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | fuselageUID, | ||
const char * | filenamePtr, | ||
double | deflection | ||
) |
Exports the boolean fused geometry of a fuselage (selected by uid) meshed to VTK format.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | fuselageUID | UID of the Fuselage to export |
[in] | filenamePtr | Pointer to an VTK export file name (*.vtp = polygonal XML_VTK) |
[in] | deflection | Maximum deflection of the triangulation from the real surface |
TiglReturnCode tiglExportMeshedGeometrySTL | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | filenamePtr, | ||
double | deflection | ||
) |
Exports the boolean fused geometry of the whole configuration meshed to STL format.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | filenamePtr | Pointer to an STL export file name |
[in] | deflection | Maximum deflection of the triangulation from the real surface |
TiglReturnCode tiglExportMeshedGeometryVTK | ( | const TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | filenamePtr, | ||
double | deflection | ||
) |
Exports the boolean fused geometry of the whole configuration meshed to VTK format.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | filenamePtr | Pointer to an VTK export file name (*.vtp = polygonal XML_VTK) |
[in] | deflection | Maximum deflection of the triangulation from the real surface |
TiglReturnCode tiglExportMeshedGeometryVTKSimple | ( | const TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | filenamePtr, | ||
double | deflection | ||
) |
Exports the boolean fused geometry of the whole configuration meshed to VTK format.
This function does only a very simple, but also very fast meshing on the geometry and exports them to a VTK file. No additional CPACS relevant information are computed.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | filenamePtr | Pointer to an VTK export file name (*.vtp = polygonal XML_VTK) |
[in] | deflection | Maximum deflection of the triangulation from the real surface |
TiglReturnCode tiglExportMeshedWingSTL | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | wingIndex, | ||
const char * | filenamePtr, | ||
double | deflection | ||
) |
Exports the boolean fused geometry of a wing meshed to STL format.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | wingIndex | Index of the Wing to export |
[in] | filenamePtr | Pointer to an STL export file name |
[in] | deflection | Maximum deflection of the triangulation from the real surface |
TiglReturnCode tiglExportMeshedWingSTLByUID | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | wingUID, | ||
const char * | filenamePtr, | ||
double | deflection | ||
) |
Exports the boolean fused geometry of a wing meshed to STL format.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | wingUID | UID of the Wing to export |
[in] | filenamePtr | Pointer to an STL export file name |
[in] | deflection | Maximum deflection of the triangulation from the real surface |
TiglReturnCode tiglExportMeshedWingVTKByIndex | ( | const TiglCPACSConfigurationHandle | cpacsHandle, |
const int | wingIndex, | ||
const char * | filenamePtr, | ||
const double | deflection | ||
) |
Exports the boolean fused geometry of a wing (selected by id) meshed to VTK format.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | wingIndex | Index of the Wing to export |
[in] | filenamePtr | Pointer to an VTK export file name (*.vtp = polygonal XML_VTK) |
[in] | deflection | Maximum deflection of the triangulation from the real surface |
TiglReturnCode tiglExportMeshedWingVTKByUID | ( | const TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | wingUID, | ||
const char * | filenamePtr, | ||
double | deflection | ||
) |
Exports the boolean fused geometry of a wing (selected by UID) meshed to VTK format.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | wingUID | UID of the Wing to export |
[in] | filenamePtr | Pointer to an VTK export file name (*.vtp = polygonal XML_VTK) |
[in] | deflection | Maximum deflection of the triangulation from the real surface |
TiglReturnCode tiglExportMeshedWingVTKSimpleByUID | ( | const TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | wingUID, | ||
const char * | filenamePtr, | ||
double | deflection | ||
) |
Exports the boolean fused geometry of a wing (selected by UID) meshed to VTK format.
This function does only a very simple, but also very fast meshing on the wing segments and exports them to a VTK file. No additional CPACS relevant information are computed.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | wingUID | UID of the Wing to export |
[in] | filenamePtr | Pointer to an VTK export file name (*.vtp = polygonal XML_VTK) |
[in] | deflection | Maximum deflection of the triangulation from the real surface |
TiglReturnCode tiglExportSTEP | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | filenamePtr | ||
) |
Exports the geometry of a CPACS configuration to STEP format.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | filenamePtr | Pointer to an STEP export file name |
TiglReturnCode tiglExportWingBREPByUID | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | wingUID, | ||
const char * | filename | ||
) |
Exports the boolean fused geometry of a wing (selected by uid) to BREP format.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | wingUID | UID of the Fuselage to export |
[in] | filename | BREP export file name |
TiglReturnCode tiglExportWingColladaByUID | ( | const TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | wingUID, | ||
const char * | filename, | ||
double | deflection | ||
) |
Exports the boolean fused geometry of a wing (selected by uid) meshed to Collada (*.dae) format.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | wingUID | UID of the Wing to export |
[in] | filename | Filename of the resulting collada file. It should contain the .dae file name ending. |
[in] | deflection | Maximum deflection of the triangulation from the real surface |
TiglReturnCode tiglFuselageGetCenterLineLength | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | fuselageUID, | ||
double * | length | ||
) |
Returns the length of center line of the given fuselage with all its segments which connects all the center points of the cross sections of the fuselage.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | fuselageUID | UID of the fuselage |
[out] | length | the sum of the lengths of all the fuselage segments |
TiglReturnCode tiglFuselageGetCircumference | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | fuselageIndex, | ||
int | segmentIndex, | ||
double | eta, | ||
double * | circumferencePtr | ||
) |
Returns the circumference of a fuselage surface for a given fuselage and segment index and an eta.
Returns the circumference of a fuselage segment of a given fuselage in dependence of parameters eta with 0.0 <= eta <= 1.0. For eta = 0.0 the point lies on the start profile of the segment, for eta = 1.0 it lies on the end profile of the segment.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | fuselageIndex | The index of the fuselage, starting at 1 |
[in] | segmentIndex | The index of the segment of the fuselage, starting at 1 |
[in] | eta | eta in the range 0.0 <= eta <= 1.0 |
[out] | circumferencePtr | The Circumference of the fuselage at the given position |
TiglReturnCode tiglFuselageGetCrossSectionArea | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | fuselageSegmentUID, | ||
double | eta, | ||
double * | area | ||
) |
Returns the value of the area of a cross section of a fuselage.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | fuselageSegmentUID | UID of the segment |
[in] | eta | Parameter value from where on the given object the section is cut out, eta in the range 0.0 <= eta <= 1.0 |
[out] | area | the area of the given cross section of a given fuselage |
TiglReturnCode tiglFuselageGetEndConnectedSegmentCount | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | fuselageIndex, | ||
int | segmentIndex, | ||
int * | segmentCountPtr | ||
) |
Returns the count of segments connected to the end section of a given fuselage segment.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | fuselageIndex | The index of a fuselage, starting at 1 |
[in] | segmentIndex | The index of a segment, starting at 1 |
[out] | segmentCountPtr | Pointer to the count of connected segments |
TiglReturnCode tiglFuselageGetEndConnectedSegmentIndex | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | fuselageIndex, | ||
int | segmentIndex, | ||
int | n, | ||
int * | connectedIndexPtr | ||
) |
Returns the index (number) of the n-th segment connected to the end section of a given fuselage segment. n starts at 1.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | fuselageIndex | The index of a fuselage, starting at 1 |
[in] | segmentIndex | The index of a segment, starting at 1 |
[in] | n | n-th segment searched, 1 <= n <= tiglFuselageGetEndConnectedSegmentCount(...) |
[out] | connectedIndexPtr | Pointer to the segment index of the n-th connected segment |
TiglReturnCode tiglFuselageGetEndSectionAndElementIndex | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | fuselageIndex, | ||
int | segmentIndex, | ||
int * | sectionIndexPtr, | ||
int * | elementIndexPtr | ||
) |
Returns the section index and section element index of the end side of a given fuselage segment.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | fuselageIndex | The index of a fuselage, starting at 1 |
[in] | segmentIndex | The index of a segment, starting at 1 |
[out] | sectionIndexPtr | The section index UID the end side |
[out] | elementIndexPtr | The section element UID of the end side |
TiglReturnCode tiglFuselageGetEndSectionAndElementUID | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | fuselageIndex, | ||
int | segmentIndex, | ||
char ** | sectionUIDPtr, | ||
char ** | elementUIDPtr | ||
) |
Returns the section UID and section element UID of the end side of a given fuselage segment.
Important change: The memory necessary for the two UIDs must not to be freed by the user anymore.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | fuselageIndex | The index of a fuselage, starting at 1 |
[in] | segmentIndex | The index of a segment, starting at 1 |
[out] | sectionUIDPtr | The section UID the end side |
[out] | elementUIDPtr | The section element UID of the end side |
TiglReturnCode tiglFuselageGetIndex | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | fuselageUID, | ||
int * | fuselageIndexPtr | ||
) |
Returns the index of a fuselage.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | fuselageUID | The uid of the fuselage |
[out] | fuselageIndexPtr | The index of a fuselage, starting at 1 |
Usage example:
TiglReturnCode returnCode; int fuselageIndex; returnCode = tiglFuselageGetIndex(cpacsHandle, fuselageUID, &fuselageIndex); printf("The Index of the fuselage is %d\n", fuselageIndex);
TiglReturnCode tiglFuselageGetMinumumDistanceToGround | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
char * | fuselageUID, | ||
double | axisPntX, | ||
double | axisPntY, | ||
double | axisPntZ, | ||
double | axisDirX, | ||
double | axisDirY, | ||
double | axisDirZ, | ||
double | angle, | ||
double * | pointXPtr, | ||
double * | pointYPtr, | ||
double * | pointZPtr | ||
) |
Returns the point where the distance between the selected fuselage and the ground is at minimum. The Fuselage could be turned with a given angle at at given axis, specified by a point and a direction.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | fuselageUID | The uid of the fuselage |
[in] | axisPntX | X-coordinate of the point that specifies the axis of rotation |
[in] | axisPntY | Y-coordinate of the point that specifies the axis of rotation |
[in] | axisPntZ | Z-coordinate of the point that specifies the axis of rotation |
[in] | axisDirX | X-coordinate of the direction that specifies the axis of rotation |
[in] | axisDirY | Y-coordinate of the direction that specifies the axis of rotation |
[in] | axisDirZ | Z-coordinate of the direction that specifies the axis of rotation |
[in] | angle | The angle (in Degree) by which the fuselage should be turned on the axis of rotation |
[out] | pointXPtr | Pointer to the x-coordinate of the point in absolute world coordinates |
[out] | pointYPtr | Pointer to the y-coordinate of the point in absolute world coordinates |
[out] | pointZPtr | Pointer to the z-coordinate of the point in absolute world coordinates |
TiglReturnCode tiglFuselageGetNumPointsOnXPlane | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | fuselageIndex, | ||
int | segmentIndex, | ||
double | eta, | ||
double | xpos, | ||
int * | numPointsPtr | ||
) |
Returns the number of points on a fuselage surface for a given fuselage and a give x-position.
Returns the number of points on a fuselage segment of a given fuselage in dependence of parameters eta and at all x-positions with 0.0 <= eta <= 1.0. For eta = 0.0 the point lies on the start profile of the segment, for eta = 1.0 it lies on the end profile of the segment.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | fuselageIndex | The index of the fuselage, starting at 1 |
[in] | segmentIndex | The index of the segment of the fuselage, starting at 1 |
[in] | eta | eta in the range 0.0 <= eta <= 1.0 |
[in] | xpos | X position |
[out] | numPointsPtr | Pointer to a integer for the number of intersection points |
TiglReturnCode tiglFuselageGetNumPointsOnYPlane | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | fuselageIndex, | ||
int | segmentIndex, | ||
double | eta, | ||
double | ypos, | ||
int * | numPointsPtr | ||
) |
Returns the number of points on a fuselage surface for a given fuselage and a give y-position.
Returns the number of points on a fuselage segment of a given fuselage in dependence of parameters eta and at all y-positions with 0.0 <= eta <= 1.0. For eta = 0.0 the point lies on the start profile of the segment, for eta = 1.0 it lies on the end profile of the segment.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | fuselageIndex | The index of the fuselage, starting at 1 |
[in] | segmentIndex | The index of the segment of the fuselage, starting at 1 |
[in] | eta | eta in the range 0.0 <= eta <= 1.0 |
[in] | ypos | Y position |
[out] | numPointsPtr | Pointer to a interger for the number of intersection points |
TiglReturnCode tiglFuselageGetPoint | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | fuselageIndex, | ||
int | segmentIndex, | ||
double | eta, | ||
double | zeta, | ||
double * | pointXPtr, | ||
double * | pointYPtr, | ||
double * | pointZPtr | ||
) |
Returns a point on a fuselage surface for a given fuselage and segment index.
Returns a point on a fuselage segment of a given fuselage in dependence of parameters eta and zeta with 0.0 <= eta <= 1.0 and 0.0 <= zeta <= 1.0. For eta = 0.0 the point lies on the start profile of the segment, for eta = 1.0 it lies on the end profile of the segment. For zeta = 0.0 the point is the identical to the start point of the profile wire, for zeta = 1.0 it is identical to the last profile point. The point is returned in absolute world coordinates.
The behavior of this function can be modified using tiglFuselageSetGetPointBehavior. The options are asParametersOnSurface or onLinearLoft. For the first, the inputs are interpreted as normalized parameters on the surface and the point corresponding to these parameters is returned (default). For the second, the inputs are interpreted as eta coordinates along the center line of the fuselage segment, xsi is interpreted as a relative circumference between 0 and 1, and the resulting point lies on the linear loft of the fuselage segment.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | fuselageIndex | The index of the fuselage, starting at 1 |
[in] | segmentIndex | The index of the segment of the fuselage, starting at 1 |
[in] | eta | eta in the range 0.0 <= eta <= 1.0 |
[in] | zeta | zeta in the range 0.0 <= zeta <= 1.0 |
[out] | pointXPtr | Pointer to the x-coordinate of the point in absolute world coordinates |
[out] | pointYPtr | Pointer to the y-coordinate of the point in absolute world coordinates |
[out] | pointZPtr | Pointer to the z-coordinate of the point in absolute world coordinates |
TiglReturnCode tiglFuselageGetPointAngle | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | fuselageIndex, | ||
int | segmentIndex, | ||
double | eta, | ||
double | alpha, | ||
double * | pointXPtr, | ||
double * | pointYPtr, | ||
double * | pointZPtr | ||
) |
Returns a point on a fuselage surface for a given fuselage and segment index and an angle alpha (degree).
Returns a point on a fuselage segment of a given fuselage in dependence of parameters eta and at all y-positions with 0.0 <= eta <= 1.0. For eta = 0.0 the point lies on the start profile of the segment, for eta = 1.0 it lies on the end profile of the segment. The angle alpha is calculated in degrees. Alpha=0 degree is meant to be "up" in the direction of the positive z-axis like specifies in cpacs. It's orientation is the mathematical negative rotation direction around the X-axis, i.e. looking in flight direction, an angle of 45 degrees resembles a point on the top-left fuselage. The point is returned in absolute world coordinates.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | fuselageIndex | The index of the fuselage, starting at 1 |
[in] | segmentIndex | The index of the segment of the fuselage, starting at 1 |
[in] | eta | Eta in the range 0.0 <= eta <= 1.0 |
[in] | alpha | Angle alpha in degrees. No range restrictions. |
[out] | pointXPtr | Pointer to the x-coordinate of the point in absolute world coordinates |
[out] | pointYPtr | Pointer to the y-coordinate of the point in absolute world coordinates |
[out] | pointZPtr | Pointer to the z-coordinate of the point in absolute world coordinates |
TiglReturnCode tiglFuselageGetPointAngleTranslated | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | fuselageIndex, | ||
int | segmentIndex, | ||
double | eta, | ||
double | alpha, | ||
double | y_cs, | ||
double | z_cs, | ||
double * | pointXPtr, | ||
double * | pointYPtr, | ||
double * | pointZPtr | ||
) |
Returns a point on a fuselage surface for a given fuselage and segment index and an angle alpha (degree). 0 degree of the angle alpha is meant to be "up" in the direction of the positive z-axis like specifies in cpacs. The origin of the line that will be rotated with the angle alpha could be translated via the parameters y_cs and z_cs.
Returns a point on a fuselage segment of a given fuselage in dependence of parameters eta and at all y-positions with 0.0 <= eta <= 1.0. For eta = 0.0 the point lies on the start profile of the segment, for eta = 1.0 it lies on the end profile of the segment. The angle alpha is calculated in degrees. It's orientation is the mathematical negative rotation direction around the X-axis, i.e. looking in flight direction, an angle of 45 degrees resembles a point on the top-left fuselage. The parameters y_cs and z_cs must be in absolute world coordinates. The point is returned in absolute world coordinates.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | fuselageIndex | The index of the fuselage, starting at 1 |
[in] | segmentIndex | The index of the segment of the fuselage, starting at 1 |
[in] | eta | eta in the range 0.0 <= eta <= 1.0 |
[in] | alpha | Angle alpha in degrees. No range restrictions. |
[in] | y_cs | Shifts the origin of the angle alpha in y-direction. |
[in] | z_cs | Shifts the origin of the angle alpha in z-direction. |
[out] | pointXPtr | Pointer to the x-coordinate of the point in absolute world coordinates |
[out] | pointYPtr | Pointer to the y-coordinate of the point in absolute world coordinates |
[out] | pointZPtr | Pointer to the z-coordinate of the point in absolute world coordinates |
TiglReturnCode tiglFuselageGetPointOnXPlane | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | fuselageIndex, | ||
int | segmentIndex, | ||
double | eta, | ||
double | xpos, | ||
int | pointIndex, | ||
double * | pointXPtr, | ||
double * | pointYPtr, | ||
double * | pointZPtr | ||
) |
Returns a point on a fuselage surface for a given fuselage and segment index.
Returns a point on a fuselage segment of a given fuselage in dependence of parameters eta and at all y-positions with 0.0 <= eta <= 1.0. For eta = 0.0 the point lies on the start profile of the segment, for eta = 1.0 it lies on the end profile of the segment. The point is returned in absolute world coordinates.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | fuselageIndex | The index of the fuselage, starting at 1 |
[in] | segmentIndex | The index of the segment of the fuselage, starting at 1 |
[in] | eta | eta in the range 0.0 <= eta <= 1.0 |
[in] | xpos | x position of a cutting plane |
[in] | pointIndex | Defines witch point if more than one. |
[out] | pointXPtr | Pointer to the x-coordinate of the point in absolute world coordinates |
[out] | pointYPtr | Pointer to the y-coordinate of the point in absolute world coordinates |
[out] | pointZPtr | Pointer to the z-coordinate of the point in absolute world coordinates |
TiglReturnCode tiglFuselageGetPointOnYPlane | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | fuselageIndex, | ||
int | segmentIndex, | ||
double | eta, | ||
double | ypos, | ||
int | pointIndex, | ||
double * | pointXPtr, | ||
double * | pointYPtr, | ||
double * | pointZPtr | ||
) |
Returns a point on a fuselage surface for a given fuselage and segment index.
Returns a point on a fuselage segment of a given fuselage in dependence of parameters eta and at all y-positions with 0.0 <= eta <= 1.0. For eta = 0.0 the point lies on the start profile of the segment, for eta = 1.0 it lies on the end profile of the segment. The point is returned in absolute world coordinates.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | fuselageIndex | The index of the fuselage, starting at 1 |
[in] | segmentIndex | The index of the segment of the fuselage, starting at 1 |
[in] | eta | eta in the range 0.0 <= eta <= 1.0 |
[in] | ypos | Y position |
[in] | pointIndex | Defines witch point if more than one. |
[out] | pointXPtr | Pointer to the x-coordinate of the point in absolute world coordinates |
[out] | pointYPtr | Pointer to the y-coordinate of the point in absolute world coordinates |
[out] | pointZPtr | Pointer to the z-coordinate of the point in absolute world coordinates |
TiglReturnCode tiglFuselageGetProfileName | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | fuselageIndex, | ||
int | sectionIndex, | ||
int | elementIndex, | ||
char ** | profileNamePtr | ||
) |
Returns the name of a fuselage profile. The string returned must not be deleted by the caller via free(). It will be deleted when the CPACS configuration is closed.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | fuselageIndex | The index of a fuselage, starting at 1 |
[in] | sectionIndex | The index of a section, starting at 1 |
[in] | elementIndex | The index of an element on the section |
[out] | profileNamePtr | The name of the wing profile |
Usage example:
TiglReturnCode returnCode; char* namePtr = 0; returnCode = tiglFuselageGetProfileName(cpacsHandle, fuselage, section, element, &namePtr); printf("Profile name is %s\n", namePtr);
TiglReturnCode tiglFuselageGetSectionCenter | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | fuselageSegmentUID, | ||
double | eta, | ||
double * | pointX, | ||
double * | pointY, | ||
double * | pointZ | ||
) |
Returns the section center of a fuselage.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | fuselageSegmentUID | UID of the segment |
[in] | eta | Parameter value from where on the given object the section is cut out, eta in the range 0.0 <= eta <= 1.0 |
[out] | pointX | Pointer to the x-coordinate of the section center point |
[out] | pointY | Pointer to the y-coordinate of the section center point |
[out] | pointZ | Pointer to the z-coordinate of the section center point |
TiglReturnCode tiglFuselageGetSectionCount | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | fuselageIndex, | ||
int * | sectionCount | ||
) |
Returns the number of sections of a fuselage.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | fuselageIndex | The index of a fuselage, starting at 1 |
[out] | sectionCount | The number of sections of the fuselage |
Usage example:
TiglReturnCode returnCode; int sectionCount = 0; returnCode = tiglFuselageGetSectionUID(cpacsHandle, fuselageIndex, §ionCount); printf("The Number of sections of fuselage %d is %d\n", fuselageIndex, sectionCount);
TiglReturnCode tiglFuselageGetSectionUID | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | fuselageIndex, | ||
int | sectionIndex, | ||
char ** | uidNamePtr | ||
) |
Returns the UID of a section of a fuselage. The string returned must not be deleted by the caller via free(). It will be deleted when the CPACS configuration is closed.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | fuselageIndex | The index of a fuselage, starting at 1 |
[in] | sectionIndex | The index of a section, starting at 1 |
[out] | uidNamePtr | The uid of the fuselage |
Usage example:
TiglReturnCode returnCode; char* uidPtr = 0; returnCode = tiglFuselageGetSectionUID(cpacsHandle, fuselage, sectionUID, &uidPtr); printf("The UID of the section of fuselage %d is %s\n", fuselage, uidPtr);
TiglReturnCode tiglFuselageGetSegmentCount | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | fuselageIndex, | ||
int * | segmentCountPtr | ||
) |
Returns the number of segments for a fuselage in a CPACS configuration.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | fuselageIndex | The index of the fuselage, starting at 1 |
[out] | segmentCountPtr | Pointer to the number of segments |
TiglReturnCode tiglFuselageGetSegmentIndex | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | segmentUID, | ||
int * | segmentIndexPtr, | ||
int * | fuselageIndexPtr | ||
) |
Returns the Index of a segment of a fuselage.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | segmentUID | The uid of the fuselage |
[out] | segmentIndexPtr | The index of a segment, starting at 1 |
[out] | fuselageIndexPtr | The index of a fuselage, starting at 1 |
Usage example:
TiglReturnCode returnCode; int segmentIndex, fuselageIndex; returnCode = tiglFuselageGetSegmentIndex(cpacsHandle, segmentUID, &segmentIndex, &fuselageIndex); printf("The Index of the segment of fuselage %d is %d\n", fuselageIndex, segmentIndex);
TiglReturnCode tiglFuselageGetSegmentSurfaceArea | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | fuselageIndex, | ||
int | segmentIndex, | ||
double * | surfaceAreaPtr | ||
) |
Returns the surface area of a segment of a fuselage.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | fuselageIndex | The index of a fuselage, starting at 1 |
[in] | segmentIndex | The index of a segment, starting at 1 |
[out] | surfaceAreaPtr | The pointer to a variable for the surface area of the fuselage-segment |
TiglReturnCode tiglFuselageGetSegmentUID | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | fuselageIndex, | ||
int | segmentIndex, | ||
char ** | uidNamePtr | ||
) |
Returns the UID of a segment of a fuselage. The string returned must not be deleted by the caller via free(). It will be deleted when the CPACS configuration is closed.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | fuselageIndex | The index of a fuselage, starting at 1 |
[in] | segmentIndex | The index of a segment, starting at 1 |
[out] | uidNamePtr | The uid of the fuselage |
Usage example:
TiglReturnCode returnCode; char* uidPtr = 0; returnCode = tiglFuselageGetSegmentUID(cpacsHandle, fuselage, segmentID, &uidPtr); printf("The UID of the segment of fuselage %d is %s\n", fuselage, uidPtr);
TiglReturnCode tiglFuselageGetSegmentVolume | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | fuselageIndex, | ||
int | segmentIndex, | ||
double * | volumePtr | ||
) |
Returns the volume of a segment of a fuselage.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | fuselageIndex | The index of a fuselage, starting at 1 |
[in] | segmentIndex | The index of a segment, starting at 1 |
[out] | volumePtr | The pointer to a variable for the volume of the fuselage |
TiglReturnCode tiglFuselageGetStartConnectedSegmentCount | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | fuselageIndex, | ||
int | segmentIndex, | ||
int * | segmentCountPtr | ||
) |
Returns the count of segments connected to the start section of a given fuselage segment.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | fuselageIndex | The index of a fuselage, starting at 1 |
[in] | segmentIndex | The index of a segment, starting at 1 |
[out] | segmentCountPtr | Pointer to the count of connected segments |
TiglReturnCode tiglFuselageGetStartConnectedSegmentIndex | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | fuselageIndex, | ||
int | segmentIndex, | ||
int | n, | ||
int * | connectedIndexPtr | ||
) |
Returns the index (number) of the n-th segment connected to the start section of a given fuselage segment. n starts at 1.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | fuselageIndex | The index of a fuselage, starting at 1 |
[in] | segmentIndex | The index of a segment, starting at 1 |
[in] | n | n-th segment searched, 1 <= n <= tiglFuselageGetStartConnectedSegmentCount(...) |
[out] | connectedIndexPtr | Pointer to the segment index of the n-th connected segment |
TiglReturnCode tiglFuselageGetStartSectionAndElementIndex | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | fuselageIndex, | ||
int | segmentIndex, | ||
int * | sectionIndexPtr, | ||
int * | elementIndexPtr | ||
) |
Returns the section index and section element index of the start side of a given fuselage segment.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | fuselageIndex | The index of a fuselage, starting at 1 |
[in] | segmentIndex | The index of a segment, starting at 1 |
[out] | sectionIndexPtr | The section UID of the start side |
[out] | elementIndexPtr | The section element UID of the start side |
TiglReturnCode tiglFuselageGetStartSectionAndElementUID | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | fuselageIndex, | ||
int | segmentIndex, | ||
char ** | sectionUIDPtr, | ||
char ** | elementUIDPtr | ||
) |
Returns the section UID and section element UID of the start side of a given fuselage segment.
Important change: The memory necessary for the two UIDs must not to be freed by the user anymore.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | fuselageIndex | The index of a fuselage, starting at 1 |
[in] | segmentIndex | The index of a segment, starting at 1 |
[out] | sectionUIDPtr | The section UID of the start side |
[out] | elementUIDPtr | The section element UID of the start side |
TiglReturnCode tiglFuselageGetSurfaceArea | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | fuselageIndex, | ||
double * | surfaceAreaPtr | ||
) |
Returns the surface area of the fuselage. Currently, the area includes also the faces on the fuselage symmetry plane (in case of a symmetric wing). This is in particular a problem for fuselages, where only one half side is defined in CPACS. In future releases, these faces will not belong anymore to the surface area calculation.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | fuselageIndex | Index of the Fuselage to calculate the area, starting at 1 |
[out] | surfaceAreaPtr | The surface area of the wing |
TiglReturnCode tiglFuselageGetSymmetry | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | fuselageIndex, | ||
TiglSymmetryAxis * | symmetryAxisPtr | ||
) |
Returns the Symmetry Enum if the fuselage has symmetry-axis.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | fuselageIndex | Index of the fuselage in the cpacs file |
[out] | symmetryAxisPtr | Returning TiglSymmetryAxis enum pointer |
TiglReturnCode tiglFuselageGetUID | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | fuselageIndex, | ||
char ** | uidNamePtr | ||
) |
Returns the UID of a fuselage. The string returned must not be deleted by the caller via free(). It will be deleted when the CPACS configuration is closed.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | fuselageIndex | The index of a fuselage, starting at 1 |
[out] | uidNamePtr | The uid of the fuselage |
Usage example:
TiglReturnCode returnCode; char* uidPtr = 0; returnCode = tiglFuselageGetUID(cpacsHandle, fuselage, &uidPtr); printf("The UID of the fuselage is %s\n", uidPtr);
TiglReturnCode tiglFuselageGetVolume | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | fuselageIndex, | ||
double * | volumePtr | ||
) |
Returns the volume of the fuselage.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | fuselageIndex | Index of the fuselage to calculate the volume, starting at 1 |
[out] | volumePtr | The volume of the fuselage |
TiglReturnCode tiglFuselageSetGetPointBehavior | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
TiglGetPointBehavior | behavior | ||
) |
Sets the behavior of the tiglFuselageGetPoint function.
This function sets the behavior of the tiglFuselageGetPoint function. The options are asParameterOnSurface or onLinearLoft. For the first, the inputs are interpreted as normalized parameters on the surface and the point corresponding to these parameters is returned. For the second, the inputs are interpreted as eta coordinates along the center line of the fuselage segment, xsi is interpreted as a relative circumference between 0 and 1, and the resulting point lies on the linear loft of the fuselage segment.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | behavior | enum describing the desired behavior of the function. Possible values are asParameterOnSurface and onLinearLoft. |
TiglReturnCode tiglGetControlSurfaceCount | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | componentSegmentUID, | ||
int * | numControlSurfaces | ||
) |
Returns the number of control surfaces belonging to a component segment.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | componentSegmentUID | UID of the componentSegment |
[out] | numControlSurfaces | number of control surfaces of the componentSegment |
TiglReturnCode tiglGetControlSurfaceType | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | controlSurfaceUID, | ||
TiglControlSurfaceType * | controlSurfaceType | ||
) |
Returns the type of a control surface given its UID.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | controlSurfaceUID | UID of the control surface |
[out] | controlSurfaceType | Type of the control surface |
TiglReturnCode tiglGetControlSurfaceUID | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | componentSegmentUID, | ||
int | controlSurfaceIndex, | ||
char ** | controlSurfaceUID | ||
) |
Returns the UID of a control surface given its index in a component segment.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | componentSegmentUID | UID of the componentSegment |
[in] | controlSurfaceIndex | Index of the control surface, starting at 1 |
[out] | controlSurfaceUID | UID of the control surface |
TiglReturnCode tiglGetCPACSTixiHandle | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
TixiDocumentHandle * | tixiHandlePtr | ||
) |
Returns the underlying TixiDocumentHandle for a given CPACS configuration handle.
[in] | cpacsHandle | Handle for the CPACS configuration |
[out] | tixiHandlePtr | Handle for the TIXI document associated with the CPACS configuration |
TiglReturnCode tiglGetCurveIntersection | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | curvesID1, | ||
int | curve1Idx, | ||
const char * | curvesID2, | ||
int | curve2Idx, | ||
double | tolerance, | ||
char ** | intersectionID | ||
) |
tiglGetCurveIntersection computes intersection point of two (intersection) curves. Both curves are the result of a previous intersection (e.g. Fuselage-Wing Intersection).
The curves must be specified by their intersectionIDs and an index of the wire in the intersection. For each calculated intersection, the distance between the point on the first curve to the point on the second curve is smaller than the tolerance specified by the user.
It returns an intersection ID for further computations on the result. To query the number of intersection points, call tiglGetCurveIntersectionCount. To query intersection points, tiglGetCurveIntersectionPoint or tiglGetCurveParameter has to be called.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | curvesID1 | ID of the first intersection |
[in] | curve1Idx | Index of the curve in the first intersection |
[in] | curvesID2 | ID of the second intersection |
[in] | curve2Idx | Index of the curve in the second intersection |
[in] | tolerance | tolerance to specify the required accuracy of the intersection point |
[out] | intersectionID | A unique identifier that is associated with the computed intersection. |
TiglReturnCode tiglGetCurveIntersectionCount | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | intersectionID, | ||
int * | pointCount | ||
) |
tiglGetCurveIntersectionCount returns the number of intersection points computed by tiglGetCurveIntersection for the given intersectionID.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | intersectionID | The intersection identifier returned by tiglGetCurveIntersection |
[out] | pointCount | Number of intersection points computed by tiglGetCurveIntersection If no intersection could be computed, pointCount is 0. |
TiglReturnCode tiglGetCurveIntersectionPoint | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | intersectionID, | ||
int | pointIdx, | ||
double * | pointX, | ||
double * | pointY, | ||
double * | pointZ | ||
) |
tiglGetCurveIntersectionPoint returns an intersection point calculated by tiglGetCurveIntersection
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | intersectionID | The intersection identifier returned by tiglGetCurveIntersection |
[in] | pointIdx | Index of the intersection point. To get the number of intersection points, call tiglGetCurveIntersectionCount with 1 <= pointIdx <= pointCount. |
[out] | pointX | X coordinate of the resulting point. |
[out] | pointY | Y coordinate of the resulting point. |
[out] | pointZ | Z coordinate of the resulting point. |
TiglReturnCode tiglGetCurveParameter | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | curveID, | ||
int | curveIdx, | ||
double | pointX, | ||
double | pointY, | ||
double | pointZ, | ||
double * | eta | ||
) |
tiglGetCurveParameter projects a point onto a curve of an intersection line. The intersection line is specified by a curveID. The curveID can be calculated using tiglIntersectComponents, tiglIntersectWithPlane or tiglIntersectWithPlaneSegment. The function returns the parameter eta of the projected point on the curve.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | curveID | The id of the intersection line. |
[in] | curveIdx | The index of curve in the intersection. |
[in] | pointX | X coordinate of the point to be projected. |
[in] | pointY | Y coordinate of the point to be projected. |
[in] | pointZ | Z coordinate of the point to be projected. |
[out] | eta | The parameter along the first curve. |
const char* tiglGetErrorString | ( | TiglReturnCode | errorCode | ) |
Translates an error code into a string.
[in] | errorCode | Return value of a tigl function |
TiglReturnCode tiglGetFuselageCount | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int * | fuselageCountPtr | ||
) |
Returns the number of fuselages in a CPACS configuration.
[in] | cpacsHandle | Handle for the CPACS configuration |
[out] | fuselageCountPtr | Pointer to the number of fuselages |
TiglReturnCode tiglGetRotorCount | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int * | rotorCountPtr | ||
) |
Returns the number of rotors in a CPACS configuration.
Fortran syntax:
tigl_get_rotor_count(integer cpacsHandle, integer rotorCountPtr, integer returnCode)
[in] | cpacsHandle | Handle for the CPACS configuration |
[out] | rotorCountPtr | Pointer to the number of rotors |
const char* tiglGetVersion | ( | ) |
Returns the version number of this TIGL version.
TiglReturnCode tiglGetWingCount | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int * | wingCountPtr | ||
) |
Returns the number of wings in a CPACS configuration.
[in] | cpacsHandle | Handle for the CPACS configuration |
[out] | wingCountPtr | Pointer to the number of wings |
TiglReturnCode tiglIntersectComponents | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | componentUidOne, | ||
const char * | componentUidTwo, | ||
char ** | intersectionID | ||
) |
tiglIntersectComponents computes the intersection line(s) between two shapes specified by their CPACS uid. It returns an intersection ID for further computations on the result. To query points on the intersection line, tiglIntersectGetPoint has to be called.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | componentUidOne | The UID of the first component |
[in] | componentUidTwo | The UID of the second component |
[out] | intersectionID | A unique identifier that is associated with the computed intersection. |
TiglReturnCode tiglIntersectGetLineCount | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | intersectionID, | ||
int * | lineCount | ||
) |
tiglIntersectGetLineCount returns the number of intersection lines computed by tiglIntersectComponents, tiglIntersectWithPlane or tiglIntersectWithPlaneSegment for the given intersectionID.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | intersectionID | The intersection identifier returned by tiglIntersectComponents or tiglIntersectWithPlane |
[out] | lineCount | Number of intersection lines computed by tiglIntersectComponents or tiglIntersectWithPlane. If no intersection could be computed, line count is 0. |
TiglReturnCode tiglIntersectGetPoint | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | intersectionID, | ||
int | lineIdx, | ||
double | eta, | ||
double * | pointX, | ||
double * | pointY, | ||
double * | pointZ | ||
) |
tiglIntersectGetPoint samples a point on an intersection line calculated by tiglIntersectComponents, tiglIntersectWithPlane or tiglIntersectWithPlaneSegment.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | intersectionID | The intersection identifier returned by tiglIntersectComponents or tiglIntersectWithPlane |
[in] | lineIdx | Line index to sample from. To get the number of lines, call tiglIntersectGetLineCount. 1 <= lineIdx <= lineCount. |
[in] | eta | Parameter on the curve that determines the point position, with 0 <= eta <= 1. |
[out] | pointX | X coordinate of the resulting point. |
[out] | pointY | Y coordinate of the resulting point. |
[out] | pointZ | Z coordinate of the resulting point. |
TiglReturnCode tiglIntersectWithPlane | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | componentUid, | ||
double | px, | ||
double | py, | ||
double | pz, | ||
double | nx, | ||
double | ny, | ||
double | nz, | ||
char ** | intersectionID | ||
) |
tiglIntersectWithPlane computes the intersection line(s) between a shape and a plane. It returns an intersection ID for further computations on the result. To query points on the intersection line, tiglIntersectGetPoint has to be called.
The shape has to be specified by its CPACS UID. The plane is specified by a central point p on the plane and a normal vector n, which is perpendicular to the plane. The normal vector must not be zero!
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | componentUid | The UID of the CPACS shape |
[in] | px | X Coordinate of the plane center point |
[in] | py | Y Coordinate of the plane center point |
[in] | pz | Z Coordinate of the plane center point |
[in] | nx | X value of the plane normal vector |
[in] | ny | Y value of the plane normal vector |
[in] | nz | Z value of the plane normal vector |
[out] | intersectionID | A unique identifier that is associated with the computed intersection. |
TiglReturnCode tiglIntersectWithPlaneSegment | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | componentUid, | ||
double | p1x, | ||
double | p1y, | ||
double | p1z, | ||
double | p2x, | ||
double | p2y, | ||
double | p2z, | ||
double | wx, | ||
double | wy, | ||
double | wz, | ||
char ** | intersectionID | ||
) |
tiglIntersectWithPlaneSegment computes the intersection line(s) between a shape and a plane segment. The plane segment is defined by p(u,v) = P1*(1-u) + P2*u + w*v, with u in [0,1] (see image).
It returns an intersection ID for further computations on the result. To query points on the intersection line, tiglIntersectGetPoint has to be called.
The shape has to be specified by its CPACS UID. The plane segment is specified by two points p1 and p2 and a normal vector w, which (ideally) is perpendicular to (p2 - p1). The normal vector w must not be zero!
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | componentUid | The UID of the CPACS shape |
[in] | p1x | X Coordinate of the first point P1 |
[in] | p1y | Y Coordinate of the first point P1 |
[in] | p1z | Z Coordinate of the first point P1 |
[in] | p2x | X Coordinate of the second point P2 |
[in] | p2y | Y Coordinate of the second point P2 |
[in] | p2z | Z Coordinate of the second point P2 |
[in] | wx | X value of the normal vector w |
[in] | wy | Y value of the normal vector w |
[in] | wz | Z value of the normal vector w |
[out] | intersectionID | A unique identifier that is associated with the computed intersection. |
TiglReturnCode tiglIsCPACSConfigurationHandleValid | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
TiglBoolean * | isValidPtr | ||
) |
Checks if a given CPACS configuration handle is a valid.
[in] | cpacsHandle | CPACS configuration handle to check |
[out] | isValidPtr | Contains TIGL_TRUE, if handle is valid, otherwise contains TIGL_FALSE |
TiglReturnCode tiglLogSetFileEnding | ( | const char * | ending | ) |
Sets the file ending for logging files. Default is "log".
This function has to be called before tiglLogToFileEnabled to have the desired effect.
[in] | ending | File ending of the logging file. Default is "log". |
TiglReturnCode tiglLogSetTimeInFilenameEnabled | ( | TiglBoolean | enabled | ) |
Enables or disables appending a unique date/time identifier inside the log file name (behind the file prefix). By default, the time identifier is enabled.
This function has to be called before tiglLogToFileEnabled to have the desired effect.
[in] | enabled | Set to true, if time identifier should be enabled. |
TiglReturnCode tiglLogSetVerbosity | ( | TiglLogLevel | level | ) |
Set the console verbosity level.
This function shall be used change, what kind of logging information is displayed on the console. By default, only errors and warnings are printed on console.
[in] | level | Verbosity level for console messages. |
TiglReturnCode tiglLogToFileDisabled | ( | ) |
Disabled file logging. If a log file is currently opened by TiGL it will be closed. The log messages are printed to console. This is the default logging mechanism of TIGL.
TiglReturnCode tiglLogToFileEnabled | ( | const char * | filePrefix | ) |
Sets up the tigl logging mechanism to send all log messages into a file.
Typically this function has to be called before opening any cpacs configuration. The console logging mechanism remains untouched.
[in] | filePrefix | Prefix of the filename to be created. The filename consists of the prefix, a date and time string and the ending ".log". |
TiglReturnCode tiglLogToFileStreamEnabled | ( | FILE * | fp | ) |
Sets up the tigl logging mechanism to send all log messages into an already opened file.
In contrast to tiglLogToFileEnabled, the messages are appended to an already opened file. This file might be an already opened logging file set up by another library or program. The console logging mechanism remains untouched.
Typically this function has to be called before opening any cpacs configuration.
[in] | fp | File pointer to an already opened file. |
TiglReturnCode tiglOpenCPACSConfiguration | ( | TixiDocumentHandle | tixiHandle, |
const char * | configurationUID, | ||
TiglCPACSConfigurationHandle * | cpacsHandlePtr | ||
) |
Opens a CPACS configuration and builds up the data and geometry structure in memory.
[in] | tixiHandle | Handle to a TIXI document. The TIXI document should not be closed until the CPACS configuration is closed. First close the CPACS configuration, then the TIXI document. |
[in] | configurationUID | The UID of the configuration that should be loaded by TIGL. Could be NULL or an empty string if the data set contains only one configuration. |
[out] | cpacsHandlePtr | Handle to the CPACS configuration. This handle is used in calls to other TIGL functions. |
TiglReturnCode tiglProfileGetBSplineCount | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | profileUID, | ||
int * | curveCount | ||
) |
Returns the number of curves the given profile is made of.
The given profile may be a fuselage profile or a wing profile. Typically, wing profiles consist of two curves (lower and upper curve), fuselage profiles consist of only one curve.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | profileUID | UID of the profile |
[out] | curveCount | Number of curves |
TiglReturnCode tiglProfileGetBSplineData | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | profileUID, | ||
int | curveid, | ||
int | nControlPoints, | ||
double * | cpx, | ||
double * | cpy, | ||
double * | cpz, | ||
int | nKnots, | ||
double * | knots | ||
) |
Returns the B-Spline data of the given profile curve. This includes the knot vector and the control points of the B-Spline.
The output arrays cpx, cpy, cpz, and knots have to be allocated by the user first. The control point vector arrays must have the size nControlPoints. This value must be queried with tiglProfileGetBSplineDataSizes first. The knot vector array must have the size kKnots. This value has to be queried also using the function tiglProfileGetBSplineDataSizes.
The given profile may be a fuselage profile or a wing profile. Typically, wing profiles consist of two curves (lower and upper curve), fuselage profiles consist of only one curve.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | profileUID | UID of the profile |
[in] | curveid | Index of the curve. Number of curves must be queried with tiglProfileGetBSplineCount. 1 <= index <= count |
[in] | nControlPoints | Size of the control point vector. To be queried with tiglProfileGetBSplineDataSizes first. |
[out] | cpx | X-values of the control point vector. |
[out] | cpy | Y-values of the control point vector. |
[out] | cpz | Z-values of the control point vector. |
[in] | nKnots | Size of the knot vector. To be queried with tiglProfileGetBSplineDataSizes first. |
[out] | knots | Knot vector values. |
TiglReturnCode tiglProfileGetBSplineDataSizes | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | profileUID, | ||
int | curveid, | ||
int * | degree, | ||
int * | nControlPoints, | ||
int * | nKnots | ||
) |
Returns the B-Spline data sizes for a given curve on a profile. This includes size of the knot vector, size of the control point vector and degree of the spline.
The given profile may be a fuselage profile or a wing profile. Typically, wing profiles consist of two curves (lower and upper curve), fuselage profiles consist of only one curve.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | profileUID | UID of the profile |
[in] | curveid | Index of the curve. Number of curves must be queried with tiglProfileGetBSplineCount. 1 <= index <= count |
[out] | degree | Degree of the B-Spline |
[out] | nControlPoints | Size of the control point vector |
[out] | nKnots | Size of the knot vector |
TiglReturnCode tiglRotorBladeGetAzimuthAngle | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | rotorIndex, | ||
int | rotorBladeIndex, | ||
double * | azimuthAnglePtr | ||
) |
Returns the azimuth angle of a rotor blade in degrees.
Returns the azimuth angle in degrees of the rotor blade with the index rotorBladeIndex attached to the rotor with the index rotorIndex.
Fortran syntax:
tigl_get_rotor_blade_azimuth(integer cpacsHandle, integer rotorIndex, integer rotorBladeIndex, real azimuthAngle, integer returnCode)
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | rotorIndex | Index of the rotor |
[in] | rotorBladeIndex | Index of the rotor blade |
[out] | azimuthAnglePtr | Pointer to the azimuth angle |
TiglReturnCode tiglRotorBladeGetLocalChord | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | rotorIndex, | ||
int | rotorBladeIndex, | ||
int | segmentIndex, | ||
double | eta, | ||
double * | chordPtr | ||
) |
Returns the local chord length of a rotor blade.
Returns the local chord length of the section at the relative spanwise coordinate eta of the segment segmentIndex of the rotor blade with the index rotorBladeIndex attached to the rotor with the index rotorIndex.
Fortran syntax:
tigl_get_rotor_blade_local_chord(integer cpacsHandle, integer rotorIndex, integer rotorBladeIndex, integer segmentIndex, real eta, real chordPtr, integer returnCode)
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | rotorIndex | Index of the rotor |
[in] | rotorBladeIndex | Index of the rotor blade |
[in] | segmentIndex | Index of the segment of the referenced wing definition |
[in] | eta | Relative spanwise segment coordinate: eta in the range 0.0 <= eta <= 1.0; eta = 0 for inner section , eta = 1 for outer section |
[out] | chordPtr | Pointer to the local chord length |
TiglReturnCode tiglRotorBladeGetLocalRadius | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | rotorIndex, | ||
int | rotorBladeIndex, | ||
int | segmentIndex, | ||
double | eta, | ||
double * | radiusPtr | ||
) |
Returns the local radius of a rotor blade.
Returns the local radius of the rotor blade with the index rotorBladeIndex attached to the rotor with the index rotorIndex. The distance of the point with relative spanwise coordinate eta on the quarter chord line of the rotor blade segment segmentIndex from the z axis of the rotor coordinate system is taken as the local radius. It is calculated for the rotor blade at azimuth=0 and with no hinge transformations applied.
Fortran syntax:
tigl_get_rotor_blade_local_radius(integer cpacsHandle, integer rotorIndex, integer rotorBladeIndex, integer segmentIndex, real eta, real radiusPtr, integer returnCode)
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | rotorIndex | Index of the rotor |
[in] | rotorBladeIndex | Index of the rotor blade |
[in] | segmentIndex | Index of the segment of the referenced wing definition |
[in] | eta | Relative spanwise segment coordinate: eta in the range 0.0 <= eta <= 1.0; eta = 0 for inner section , eta = 1 for outer section |
[out] | radiusPtr | Pointer to the local radius |
TiglReturnCode tiglRotorBladeGetLocalTwistAngle | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | rotorIndex, | ||
int | rotorBladeIndex, | ||
int | segmentIndex, | ||
double | eta, | ||
double * | twistAnglePtr | ||
) |
Returns the local twist angle [deg] of a rotor blade.
Returns the twist angle in degrees of the section at the relative spanwise coordinate eta of the segment segmentIndex of the rotor blade with the index rotorBladeIndex attached to the rotor with the index rotorIndex.
Fortran syntax:
tigl_get_rotor_blade_local_twist_angle(integer cpacsHandle, integer rotorIndex, integer rotorBladeIndex, integer segmentIndex, real eta, real twistAnglePtr, integer returnCode)
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | rotorIndex | Index of the rotor |
[in] | rotorBladeIndex | Index of the rotor blade |
[in] | segmentIndex | Index of the segment of the referenced wing definition |
[in] | eta | Relative spanwise segment coordinate: eta in the range 0.0 <= eta <= 1.0; eta = 0 for inner section , eta = 1 for outer section |
[out] | twistAnglePtr | Pointer to the local twist angle |
TiglReturnCode tiglRotorBladeGetPlanformArea | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | rotorIndex, | ||
int | rotorBladeIndex, | ||
double * | planformAreaPtr | ||
) |
Returns the planform area of the rotor blade.
Fortran syntax:
tigl_rotor_blade_get_planform_area(integer cpacsHandle, int rotorIndex, int rotorBladeIndex, real planformAreaPtr, integer returnCode)
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | rotorIndex | Index of the rotor |
[in] | rotorBladeIndex | Index of the rotor blade to calculate the area, starting at 1 |
[out] | planformAreaPtr | The planform area of the rotor blade |
TiglReturnCode tiglRotorBladeGetRadius | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | rotorIndex, | ||
int | rotorBladeIndex, | ||
double * | radiusPtr | ||
) |
Returns the radius of a rotor blade.
Returns the radius of the rotor blade with the index rotorBladeIndex attached to the rotor with the index rotorIndex. The maximum distance of a point on the quarter chord line of the rotor blade from the z axis of the rotor coordinate system is taken as the rotor blade radius. It is calculated for the rotor blade at azimuth=0 and with no hinge transformations applied.
Fortran syntax:
tigl_get_rotor_blade_radius(integer cpacsHandle, integer rotorIndex, integer rotorBladeIndex, real radiusPtr, integer returnCode)
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | rotorIndex | Index of the rotor |
[in] | rotorBladeIndex | Index of the rotor blade |
[out] | radiusPtr | Pointer to the radius |
TiglReturnCode tiglRotorBladeGetSurfaceArea | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | rotorIndex, | ||
int | rotorBladeIndex, | ||
double * | surfaceAreaPtr | ||
) |
Returns the surface area of the rotor blade.
Fortran syntax:
tigl_rotor_blade_get_surface_area(integer cpacsHandle, int rotorIndex, int rotorBladeIndex, real surfaceAreaPtr, integer returnCode)
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | rotorIndex | Index of the rotor |
[in] | rotorBladeIndex | Index of the rotor blade to calculate the area, starting at 1 |
[out] | surfaceAreaPtr | The surface area of the rotor blade |
TiglReturnCode tiglRotorBladeGetTipSpeed | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | rotorIndex, | ||
int | rotorBladeIndex, | ||
double * | tipSpeedPtr | ||
) |
Returns the tip speed of a rotor blade [m/s].
The rotor blade tip speed is calculated using the nominal rotation speed of the rotor and the rotor blade radius.
Fortran syntax:
tigl_get_rotor_blade_tip_speed(integer cpacsHandle, integer rotorIndex, integer rotorBladeIndex, real tipSpeedPtr, integer returnCode)
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | rotorIndex | Index of the rotor |
[in] | rotorBladeIndex | Index of the rotor blade |
[out] | tipSpeedPtr | Pointer to the radius |
TiglReturnCode tiglRotorBladeGetVolume | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | rotorIndex, | ||
int | rotorBladeIndex, | ||
double * | volumePtr | ||
) |
Returns the volume of the rotor blade.
Fortran syntax:
tigl_rotor_blade_get_volume(integer cpacsHandle, int rotorIndex, int rotorBladeIndex, real volumePtr, integer returnCode)
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | rotorIndex | Index of the rotor |
[in] | rotorBladeIndex | Index of the rotor blade to calculate the volume, starting at 1 |
[out] | volumePtr | The volume of the rotor blade |
TiglReturnCode tiglRotorBladeGetWingIndex | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | rotorIndex, | ||
int | rotorBladeIndex, | ||
int * | wingIndexPtr | ||
) |
Returns the index of the parent wing definition of a rotor blade.
Returns the index of the wing definition referenced by the parent rotor blade attachment of the rotor blade with the index rotorBladeIndex.
Fortran syntax:
tigl_get_rotor_blade_wing_index(integer cpacsHandle, integer rotorIndex, integer rotorBladeIndex, integer wingIndexPtr, integer returnCode)
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | rotorIndex | Index of the rotor |
[in] | rotorBladeIndex | Index of the rotor blade |
[out] | wingIndexPtr | Pointer to the wing index |
TiglReturnCode tiglRotorBladeGetWingUID | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | rotorIndex, | ||
int | rotorBladeIndex, | ||
char ** | wingUIDPtr | ||
) |
Returns the UID of the parent wing definition of a rotor blade.
Returns the UID of the wing definition referenced by the parent rotor blade attachment of the rotor blade with the index rotorBladeIndex.
Fortran syntax:
tigl_get_rotor_blade_wing_uid(integer cpacsHandle, integer rotorIndex, integer rotorBladeIndex, character*n wingUIDPtr, integer returnCode)
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | rotorIndex | Index of the rotor |
[in] | rotorBladeIndex | Index of the rotor blade |
[out] | wingUIDPtr | Pointer to the wing index |
TiglReturnCode tiglRotorGetIndex | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | rotorUID, | ||
int * | rotorIndexPtr | ||
) |
Returns the Index of a rotor.
Fortran syntax:
tigl_rotor_get_index(integer cpacsHandle, character*n uIDNamePtr, integer rotorIndex, integer returnCode)
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | rotorUID | The uid of the rotor |
[out] | rotorIndexPtr | The index of a rotor, starting at 1 |
Usage example:
TiglReturnCode returnCode; int rotorIndex; returnCode = tiglRotorGetUID(cpacsHandle, rotorUID, &rotorIndex); printf("The Index of the rotor is %d\n", rotorIndex);
TiglReturnCode tiglRotorGetRadius | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | rotorIndex, | ||
double * | radiusPtr | ||
) |
Returns the radius of the rotor.
This function returns the radius of the largest blade attached to the rotor hub.
Fortran syntax:
tigl_rotor_get_radius(integer cpacsHandle, int rotorIndex, real radiusPtr, integer returnCode)
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | rotorIndex | Index of the rotor to calculate the radius, starting at 1 |
[out] | radiusPtr | The radius of the rotor |
TiglReturnCode tiglRotorGetReferenceArea | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | rotorIndex, | ||
double * | referenceAreaPtr | ||
) |
Returns the reference area of the rotor.
The area of the rotor disk is taken as reference area of the rotor. It is calculated using the formula pi*r^2, where r denotes the radius of the largest attached blade.
Fortran syntax:
tigl_rotor_get_reference_area(integer cpacsHandle, int rotorIndex, real referenceAreaPtr, integer returnCode)
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | rotorIndex | Index of the rotor to calculate the area, starting at 1 |
[out] | referenceAreaPtr | The reference area of the rotor |
TiglReturnCode tiglRotorGetRotorBladeCount | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | rotorIndex, | ||
int * | rotorBladeCountPtr | ||
) |
Returns the total number of rotor blades attached to a rotor.
Fortran syntax:
tigl_get_rotor_blade_count(integer cpacsHandle, integer rotorIndex, integer rotorBladeCountPtr, integer returnCode)
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | rotorIndex | Index of the rotor to count the attached rotor blades |
[out] | rotorBladeCountPtr | Pointer to the number of rotor blades |
TiglReturnCode tiglRotorGetSolidity | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | rotorIndex, | ||
double * | solidityPtr | ||
) |
Returns the solidity of the rotor.
The rotor solidity ratio is calculated by dividing the total blade planform area by the rotor disk area.
Fortran syntax:
tigl_rotor_get_solidity(integer cpacsHandle, int rotorIndex, real solidityPtr, integer returnCode)
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | rotorIndex | Index of the rotor to calculate the area, starting at 1 |
[out] | solidityPtr | The reference area of the rotor |
TiglReturnCode tiglRotorGetSurfaceArea | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | rotorIndex, | ||
double * | surfaceAreaPtr | ||
) |
Returns the surface area of the rotor.
The returned surface area is the sum of the surface areas of all attached rotor blades.
Fortran syntax:
tigl_rotor_get_surface_area(integer cpacsHandle, int rotorIndex, real surfaceAreaPtr, integer returnCode)
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | rotorIndex | Index of the Rotor to calculate the area, starting at 1 |
[out] | surfaceAreaPtr | The surface area of the rotor |
TiglReturnCode tiglRotorGetTipSpeed | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | rotorIndex, | ||
double * | tipSpeedPtr | ||
) |
Returns the tip speed of the rotor in [m/s].
The rotor tip speed is calculated using the nominal rotation speed of the rotor and the rotor radius.
Fortran syntax:
tigl_rotor_get_tip_speed(integer cpacsHandle, int rotorIndex, real tipSpeedPtr, integer returnCode)
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | rotorIndex | Index of the rotor to calculate the area, starting at 1 |
[out] | tipSpeedPtr | The tip speed of the rotor |
TiglReturnCode tiglRotorGetTotalBladePlanformArea | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | rotorIndex, | ||
double * | totalBladePlanformAreaPtr | ||
) |
Returns the total blade planform area of the rotor.
This function calculates the sum of the planform areas of all blades attached to the rotor hub.
Fortran syntax:
tigl_rotor_get_total_blade_planform_area(integer cpacsHandle, int rotorIndex, real totalBladePlanformAreaPtr, integer returnCode)
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | rotorIndex | Index of the rotor to calculate the area, starting at 1 |
[out] | totalBladePlanformAreaPtr | The total blade planform area of the rotor |
TiglReturnCode tiglRotorGetUID | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | rotorIndex, | ||
char ** | uidNamePtr | ||
) |
Returns the UID of a rotor. The string returned must not be deleted by the caller via free(). It will be deleted when the CPACS configuration is closed.
Fortran syntax:
tigl_rotor_get_uid(integer cpacsHandle, integer rotorIndex, character*n uIDNamePtr, integer returnCode)
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | rotorIndex | The index of a rotor, starting at 1 |
[out] | uidNamePtr | The uid of the rotor |
Usage example:
TiglReturnCode returnCode; char* uidPtr = 0; returnCode = tiglRotorGetUID(cpacsHandle, rotor, &uidPtr); printf("The UID of the rotor is %s\n", uidPtr);
TiglReturnCode tiglRotorGetVolume | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | rotorIndex, | ||
double * | volumePtr | ||
) |
Returns the volume of the rotor.
The returned volume is the sum of the volumes of all attached rotor blades.
Fortran syntax:
tigl_rotor_get_volume(integer cpacsHandle, int rotorIndex, real volumePtr, integer returnCode)
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | rotorIndex | Index of the rotor to calculate the volume, starting at 1 |
[out] | volumePtr | The volume of the rotor |
TiglReturnCode tiglSaveCPACSConfiguration | ( | const char * | configurationUID, |
TiglCPACSConfigurationHandle | cpacsHandle | ||
) |
Writes a CPACS configuration based on the data and geometry structure in memory.
[in] | configurationUID | The UID of the configuration that should be written. |
[in] | cpacsHandle | Handle to the CPACS configuration. This handle is used in calls to other TIGL functions. |
void tiglSetDebugDataDirectory | ( | const char * | directory | ) |
Set the directory path for debug data.
These data are written, in case a tigl function has an internal error.
By default (directory==NULL), these files are written into the current working directory. There, the subdirectory CrashInfo is created.
[in] | directory | Path of the debugging directory. |
TiglReturnCode tiglSetExportOptions | ( | const char * | exporter_name, |
const char * | option_name, | ||
const char * | option_value | ||
) |
Sets options for the geometry export.
Generic options for all exporters:
Exporter-specific options:
Example: The IGES export normally does only write half-models. It does not apply symmetries. to change this, just call
tiglSetExportOptions("iges", "ApplySymmetries", "true");
[in] | exporter_name | File format of the export. E.g. "vtk", "iges", "step", "collada", "brep" or "stl" |
[in] | option_name | Name of the option to be set |
[in] | option_value | Value of the options to be set |
TiglReturnCode tiglWingComponentSegmentComputeEtaIntersection | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | componentSegmentUID, | ||
double | csEta1, | ||
double | csXsi1, | ||
double | csEta2, | ||
double | csXsi2, | ||
double | eta, | ||
double * | xsi, | ||
TiglBoolean * | hasWarning | ||
) |
This function is deprecated. Use the generalized function tiglWingInterpolateXsi.
Given a straight line in space defined by a pair of component segment (eta,xsi) coordinates, the function computes the intersection of the line with a component segment iso-eta line.
The function is similar to tiglWingComponentSegmentGetSegmentIntersection, with the difference, that an iso-line of the component segment is used instead of an iso-line of a segment. The line is defined by its inner and outer point, both given in component segment coordinates. Typically, these might be spar positions or leading edge coordinates of flaps. The eta value for the iso-eta line should be in the range [csEta1, csEta2]. The function returns the xsi coordinate (depth coordinate) of the intersection point. This coordinate is given in the component segment coordinate system. See image below for details.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | componentSegmentUID | UID of the componentSegment |
[in] | csEta1,csEta2 | Start and end eta coordinates of the intersection line (given as component segment coordinates) |
[in] | csXsi1,csXsi2 | Start and end xsi coordinates of the intersection line (given as component segment coordinates) |
[in] | eta | Eta coordinate of the iso-eta component segment intersection line |
[out] | xsi | Xsi coordinate of the intersection point on the wing component segment |
[out] | hasWarning | The hasWarning flag is true (1), if the resulting xsi value is either outside the valid range [0,1]. It is up to the user to handle these cases properly. This flag is only valid, if the function returns TIGL_SUCCESS. |
TiglReturnCode tiglWingComponentSegmentFindSegment | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | componentSegmentUID, | ||
double | x, | ||
double | y, | ||
double | z, | ||
char ** | segmentUID, | ||
char ** | wingUID | ||
) |
Returns the segmentUID and wingUID for a given point on a componentSegment. The returned strings must not be freed by the user anymore.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | componentSegmentUID | UID of the componentSegment to search for |
[in] | x,y,z | Coordinates of the point of the componentSegment |
[out] | segmentUID | UID of the segment that fits to the given point and componentSegment. In contrast to old releases, the returned string must not be freed by the user! |
[out] | wingUID | UID of the wing that fits to the given point and componentSegment In contrast to old releases, the returned string must not be freed by the user! |
TiglReturnCode tiglWingComponentSegmentGetMaterialCount | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | compSegmentUID, | ||
TiglStructureType | structureType, | ||
double | eta, | ||
double | xsi, | ||
int * | materialCount | ||
) |
Returns the number of materials defined at a point on the wing component segment surface.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | compSegmentUID | UID of the component segment |
[in] | structureType | Type of structure, where the materials are queried |
[in] | eta | eta in the range 0.0 <= eta <= 1.0 |
[in] | xsi | xsi in the range 0.0 <= xsi <= 1.0 |
[out] | materialCount | Number of materials defined at the given coordinate |
TiglReturnCode tiglWingComponentSegmentGetMaterialThickness | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | compSegmentUID, | ||
TiglStructureType | structureType, | ||
double | eta, | ||
double | xsi, | ||
int | materialIndex, | ||
double * | thickness | ||
) |
Returns one of the material thicknesses of a given point on the wing component segment surface. The number of materials on that point has to be first queried using tiglWingComponentSegmentGetMaterialCount.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | compSegmentUID | UID of the component segment |
[in] | structureType | Type of structure, where the materials are queried |
[in] | eta | eta in the range 0.0 <= eta <= 1.0 |
[in] | xsi | xsi in the range 0.0 <= xsi <= 1.0 |
[in] | materialIndex | Index of the material to query (1 <= index <= materialCount) |
[out] | thickness | Material thickness at the given coordinate. If no thickness is defined, thickness gets a negative value and TIGL_UNINITIALIZED is returned. |
TiglReturnCode tiglWingComponentSegmentGetMaterialUID | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | compSegmentUID, | ||
TiglStructureType | structureType, | ||
double | eta, | ||
double | xsi, | ||
int | materialIndex, | ||
char ** | uid | ||
) |
Returns one of the material UIDs of a given point on the wing component segment surface. The number of materials on that point has to be first queried using tiglWingComponentSegmentGetMaterialCount.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | compSegmentUID | UID of the component segment |
[in] | structureType | Type of structure, where the materials are queried |
[in] | eta | eta in the range 0.0 <= eta <= 1.0 |
[in] | xsi | xsi in the range 0.0 <= xsi <= 1.0 |
[in] | materialIndex | Index of the material to query (1 <= index <= materialCount) |
[out] | uid | Material uid at the given coordinate |
TiglReturnCode tiglWingComponentSegmentGetNumberOfSegments | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | componentSegmentUID, | ||
int * | nsegments | ||
) |
Returns the number of segments belonging to a component segment.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | componentSegmentUID | UID of the componentSegment |
[out] | nsegments | Number of segments belonging to the component segment |
TiglReturnCode tiglWingComponentSegmentGetPoint | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | componentSegmentUID, | ||
double | eta, | ||
double | xsi, | ||
double * | x, | ||
double * | y, | ||
double * | z | ||
) |
Returns x,y,z coordinates for a given eta and xsi on a componentSegment.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | componentSegmentUID | UID of the componentSegment to search for |
[in] | eta,xsi | Eta and Xsi of the point of the componentSegment |
[out] | x | X coordinate of the point on the corresponding segment. |
[out] | y | Y coordinate of the point on the corresponding segment. |
[out] | z | Z coordinate of the point on the corresponding segment. |
TiglReturnCode tiglWingComponentSegmentGetSegmentIntersection | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | componentSegmentUID, | ||
const char * | segmentUID, | ||
double | csEta1, | ||
double | csXsi1, | ||
double | csEta2, | ||
double | csXsi2, | ||
double | segmentEta, | ||
double * | segmentXsi, | ||
TiglBoolean * | hasWarning | ||
) |
This function is deprecated. Use the generalized function tiglWingInterpolateXsi.
Computes the intersection of a line (defined by component segment coordinates) with an iso-eta line on a specified wing segment.
The component segment line is defined by its inner and outer point, both defined in component segment coordinates. Typically, these might be spar positions or leading edge coordinates of flaps. The segment line is defined by a iso-eta line. Typically, the intersection with a wing section would be computed (i.e. eta=1 or eta=0). The function returns the xsi coordinate (depth coordinate) of the intersection point. This coordinate is given in the segment coordinate system. See image below for details.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | componentSegmentUID | UID of the componentSegment |
[in] | segmentUID | UID of the segment, the intersection should be calculated with |
[in] | csEta1,csEta2 | Start and end eta coordinates of the intersection line (given as component segment coordinates) |
[in] | csXsi1,csXsi2 | Start and end xsi coordinates of the intersection line (given as component segment coordinates) |
[in] | segmentEta | Eta coordinate of the iso-eta segment intersection line |
[out] | segmentXsi | Xsi coordinate of the intersection point on the wing segment |
[out] | hasWarning | The hasWarning flag is true (1), if the resulting xsi value is outside the valid range [0,1]. It is up to the user to handle these cases properly. This flag is only valid, if the function returns TIGL_SUCCESS. |
TiglReturnCode tiglWingComponentSegmentGetSegmentUID | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | componentSegmentUID, | ||
int | segmentIndex, | ||
char ** | segmentUID | ||
) |
Returns the segment UID of a segment belonging to a component segment. The segment is specified with its index, which is in the 1...nsegments. The number of segments nsegments can be queried with tiglWingComponentSegmentGetNumberOfSegments.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | componentSegmentUID | UID of the componentSegment |
[in] | segmentIndex | Index of the segment (1 <= index <= nsegments) |
[out] | segmentUID | UID of the segment |
TiglReturnCode tiglWingComponentSegmentPointGetEtaXsi | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | componentSegmentUID, | ||
double | pX, | ||
double | pY, | ||
double | pZ, | ||
double * | eta, | ||
double * | xsi, | ||
double * | errorDistance | ||
) |
Projects a points onto the chord face of the wing component segment and returns the eta/xsi coordinates of the point of projection.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | componentSegmentUID | UID of the componentSegment to search for |
[in] | pX | X coordinate of the point to project |
[in] | pY | Y coordinate of the point to project |
[in] | pZ | Z coordinate of the point to project |
[out] | eta | Eta coordinate of the projected point |
[out] | xsi | Xsi coordinate of the projected point |
[out] | errorDistance | Distance between the point and the projected point on the component segment. If the point already lies on the component segment's chord face, the errorDistance should be zero! |
TiglReturnCode tiglWingComponentSegmentPointGetSegmentEtaXsi | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | componentSegmentUID, | ||
double | eta, | ||
double | xsi, | ||
char ** | wingUID, | ||
char ** | segmentUID, | ||
double * | segmentEta, | ||
double * | segmentXsi | ||
) |
Returns eta, xsi, segmentUID and wingUID for a given eta and xsi on a componentSegment.
If the given component segment point lies outside the wing chord surface, the function returns an error distance > 0. If this distance is larger than 1 mm, the point is first projected onto the segment (see image). Then, this point is transformed into segment coordinates. It is up to the user to handle this case correctly.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | componentSegmentUID | UID of the componentSegment to search for |
[in] | eta,xsi | Eta and Xsi of the point of the componentSegment |
[out] | wingUID | UID of the wing that fits to the given point and componentSegment. In contrast to old releases, the returned string must not be freed by the user! |
[out] | segmentUID | UID of the segment that fits to the given point and componentSegment. In contrast to old releases, the returned string must not be freed by the user! |
[out] | segmentEta | Eta of the point on the corresponding segment. |
[out] | segmentXsi | Xsi of the point on the corresponding segment. |
TiglReturnCode tiglWingGetChordNormal | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | wingIndex, | ||
int | segmentIndex, | ||
double | eta, | ||
double | xsi, | ||
double * | normalXPtr, | ||
double * | normalYPtr, | ||
double * | normalZPtr | ||
) |
Returns a normal vector on the wing chord surface for a a given wing and segment index.
Returns a normal vector on the wing chord surface in dependence of parameters eta and xsi, which range from 0.0 to 1.0.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | wingIndex | The index of the wing, starting at 1 |
[in] | segmentIndex | The index of the segment of the wing, starting at 1 |
[in] | eta | eta in the range 0.0 <= eta <= 1.0 |
[in] | xsi | xsi in the range 0.0 <= xsi <= 1.0 |
[out] | normalXPtr | Pointer to the x-coordinate of the resulting normal vector |
[out] | normalYPtr | Pointer to the y-coordinate of the resulting normal vector |
[out] | normalZPtr | Pointer to the z-coordinate of the resulting normal vector |
TiglReturnCode tiglWingGetChordPoint | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | wingIndex, | ||
int | segmentIndex, | ||
double | eta, | ||
double | xsi, | ||
double * | pointXPtr, | ||
double * | pointYPtr, | ||
double * | pointZPtr | ||
) |
Returns a point on the wing chord surface for a a given wing and segment index.
Returns a point on the wing chord surface in dependence of parameters eta and xsi, which range from 0.0 to 1.0. For eta = 0.0, xsi = 0.0 the point is equal to the leading edge on the inner section of the given segment. For eta = 1.0, xsi = 1.0 the point is equal to the trailing edge on the outer section of the given segment. The point is returned in absolute world coordinates.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | wingIndex | The index of the wing, starting at 1 |
[in] | segmentIndex | The index of the segment of the wing, starting at 1 |
[in] | eta | eta in the range 0.0 <= eta <= 1.0 |
[in] | xsi | xsi in the range 0.0 <= xsi <= 1.0 |
[out] | pointXPtr | Pointer to the x-coordinate of the point in absolute world coordinates |
[out] | pointYPtr | Pointer to the y-coordinate of the point in absolute world coordinates |
[out] | pointZPtr | Pointer to the z-coordinate of the point in absolute world coordinates |
TiglReturnCode tiglWingGetComponentSegmentCount | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | wingIndex, | ||
int * | compSegmentCountPtr | ||
) |
Returns the number of component segments for a wing in a CPACS configuration.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | wingIndex | The index of the wing, starting at 1 |
[out] | compSegmentCountPtr | Pointer to the number of component segments |
TiglReturnCode tiglWingGetComponentSegmentIndex | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | wingIndex, | ||
const char * | compSegmentUID, | ||
int * | segmentIndexPtr | ||
) |
Returns the Index of a component segment of a wing.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | wingIndex | The index of a wing, starting at 1 |
[in] | compSegmentUID | The uid of the wing |
[out] | segmentIndexPtr | The index of a segment, starting at 1 |
Usage example:
TiglReturnCode returnCode; int segmentIndex; returnCode = tiglWingGetComponentSegmentIndex(cpacsHandle, wing, uidName, &segmentIndex); printf("The Index of the component segment of wing %d is %d\n", wing, segmentIndex);
TiglReturnCode tiglWingGetComponentSegmentUID | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | wingIndex, | ||
int | compSegmentIndex, | ||
char ** | uidNamePtr | ||
) |
Returns the UID of a component segment of a wing. The string returned must not be deleted by the caller via free(). It will be deleted when the CPACS configuration is closed.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | wingIndex | The index of a wing, starting at 1 |
[in] | compSegmentIndex | The index of a segment, starting at 1 |
[out] | uidNamePtr | The uid of the wing |
Usage example:
TiglReturnCode returnCode; char* uidPtr = 0; returnCode = tiglWingGetComponentSegmentUID(cpacsHandle, wing, segmentID, &uidPtr); printf("The UID of the component segment of wing %d is %s\n", wing, uidPtr);
TiglReturnCode tiglWingGetIndex | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | wingUID, | ||
int * | wingIndexPtr | ||
) |
Returns the Index of a wing.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | wingUID | The uid of the wing |
[out] | wingIndexPtr | The index of a wing, starting at 1 |
Usage example:
TiglReturnCode returnCode; int wingIndex; returnCode = tiglWingGetUID(cpacsHandle, wingUID, &wingIndex); printf("The Index of the wing is %d\n", wingIndex);
TiglReturnCode tiglWingGetInnerConnectedSegmentCount | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | wingIndex, | ||
int | segmentIndex, | ||
int * | segmentCountPtr | ||
) |
Returns the count of wing segments connected to the inner section of a given segment.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | wingIndex | The index of a wing, starting at 1 |
[in] | segmentIndex | The index of a segment, starting at 1 |
[out] | segmentCountPtr | Pointer to the count of connected segments |
TiglReturnCode tiglWingGetInnerConnectedSegmentIndex | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | wingIndex, | ||
int | segmentIndex, | ||
int | n, | ||
int * | connectedIndexPtr | ||
) |
Returns the index (number) of the n-th wing segment connected to the inner section of a given segment. n starts at 1.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | wingIndex | The index of a wing, starting at 1 |
[in] | segmentIndex | The index of a segment, starting at 1 |
[in] | n | n-th segment searched, 1 <= n <= tiglWingGetInnerConnectedSegmentCount(...) |
[out] | connectedIndexPtr | Pointer to the segment index of the n-th connected segment |
TiglReturnCode tiglWingGetInnerSectionAndElementIndex | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | wingIndex, | ||
int | segmentIndex, | ||
int * | sectionIndexPtr, | ||
int * | elementIndexPtr | ||
) |
Returns the section index and section element index of the inner side of a given wing segment.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | wingIndex | The index of a wing, starting at 1 |
[in] | segmentIndex | The index of a segment, starting at 1 |
[out] | sectionIndexPtr | The section index of the inner side |
[out] | elementIndexPtr | The section element index of the inner side |
TiglReturnCode tiglWingGetInnerSectionAndElementUID | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | wingIndex, | ||
int | segmentIndex, | ||
char ** | sectionUIDPtr, | ||
char ** | elementUIDPtr | ||
) |
Returns the section UID and section element UID of the inner side of a given wing segment.
Important change: The memory necessary for the two UIDs must not be freed by the user anymore.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | wingIndex | The index of a wing, starting at 1 |
[in] | segmentIndex | The index of a segment, starting at 1 |
[out] | sectionUIDPtr | The section UID of the inner side |
[out] | elementUIDPtr | The section element UID of the inner side |
TiglReturnCode tiglWingGetLowerPoint | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | wingIndex, | ||
int | segmentIndex, | ||
double | eta, | ||
double | xsi, | ||
double * | pointXPtr, | ||
double * | pointYPtr, | ||
double * | pointZPtr | ||
) |
Returns a point on the lower wing surface for a a given wing and segment index.
Returns a point on the lower wing surface in dependence of parameters eta and xsi, which range from 0.0 to 1.0. For eta = 0.0, xsi = 0.0 the point is equal to the leading edge on the inner section of the given segment. For eta = 1.0, xsi = 1.0 the point is equal to the trailing edge on the outer section of the given segment. The point is returned in absolute world coordinates.
The behavior of this function can be modified using tiglWingSetGetPointBehavior. The options are asParametersOnSurface or onLinearLoft. For the first, the inputs are interpreted as normalized parameters on the surface and the point corresponding to these parameters is returned (default). For the second, the inputs are interpreted as eta-xsi coordinates on the chordface spanned by the leading edge and trailing edge points of the inner and outer elements.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | wingIndex | The index of the wing, starting at 1 |
[in] | segmentIndex | The index of the segment of the wing, starting at 1 |
[in] | eta | eta in the range 0.0 <= eta <= 1.0 |
[in] | xsi | xsi in the range 0.0 <= xsi <= 1.0 |
[out] | pointXPtr | Pointer to the x-coordinate of the point in absolute world coordinates |
[out] | pointYPtr | Pointer to the y-coordinate of the point in absolute world coordinates |
[out] | pointZPtr | Pointer to the z-coordinate of the point in absolute world coordinates |
TiglReturnCode tiglWingGetLowerPointAtDirection | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | wingIndex, | ||
int | segmentIndex, | ||
double | eta, | ||
double | xsi, | ||
double | dirx, | ||
double | diry, | ||
double | dirz, | ||
double * | pointXPtr, | ||
double * | pointYPtr, | ||
double * | pointZPtr, | ||
double * | errorDistance | ||
) |
Returns a point on the lower wing surface for a a given wing and segment index. This function is different from tiglWingGetLowerPoint: First, a point on the wing chord surface is computed (defined by segment index and eta,xsi). Then, a line is constructed, which is defined by this point and a direction given by the user. The intersection of this line with the lower wing surface is finally returned. The point is returned in absolute world coordinates.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | wingIndex | The index of the wing, starting at 1 |
[in] | segmentIndex | The index of the segment of the wing, starting at 1 |
[in] | eta | eta in the range 0.0 <= eta <= 1.0; eta = 0 for inner section , eta = 1 for outer section |
[in] | xsi | xsi in the range 0.0 <= xsi <= 1.0; xsi = 0 for Leading Edge, xsi = 1 for Trailing Edge |
[in] | dirx | X-component of the direction vector. |
[in] | diry | Y-component of the direction vector. |
[in] | dirz | Z-component of the direction vector. |
[out] | pointXPtr | Pointer to the x-coordinate of the point in absolute world coordinates |
[out] | pointYPtr | Pointer to the y-coordinate of the point in absolute world coordinates |
[out] | pointZPtr | Pointer to the z-coordinate of the point in absolute world coordinates |
[out] | errorDistance | If the lower surface is missed by the line, the absolute distance between line and the nearest point on the surface is returned. The distance is zero in case of successful intersection. It's up to the user to decide, if the distance is too large and the result has to be treated as an error. |
TiglReturnCode tiglWingGetMAC | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | wingUID, | ||
double * | mac_chord, | ||
double * | mac_x, | ||
double * | mac_y, | ||
double * | mac_z | ||
) |
This function calculates location of the quarter of mean aerodynamic chord, and gives the chord lenght as well.
It uses the classical method that can be applied to trapozaidal wings. This method is used for each segment. The values are found by taking into account of sweep and dihedral. But the effect of insidance angle is neglected. These values should coinside with the values found with tornado tool.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | wingUID | UID of the Wing |
[out] | mac_chord | Mean areadynamic chord length |
[out] | mac_x,mac_y,mac_z | - Position of the MAC |
TiglReturnCode tiglWingGetOuterConnectedSegmentCount | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | wingIndex, | ||
int | segmentIndex, | ||
int * | segmentCountPtr | ||
) |
Returns the count of wing segments connected to the outer section of a given segment.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | wingIndex | The index of a wing, starting at 1 |
[in] | segmentIndex | The index of a segment, starting at 1 |
[out] | segmentCountPtr | Pointer to the count of connected segments |
TiglReturnCode tiglWingGetOuterConnectedSegmentIndex | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | wingIndex, | ||
int | segmentIndex, | ||
int | n, | ||
int * | connectedIndexPtr | ||
) |
Returns the index (number) of the n-th wing segment connected to the outer section of a given segment. n starts at 1.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | wingIndex | The index of a wing, starting at 1 |
[in] | segmentIndex | The index of a segment, starting at 1 |
[in] | n | n-th segment searched, 1 <= n <= tiglWingGetOuterConnectedSegmentCount(...) |
[out] | connectedIndexPtr | Pointer to the segment index of the n-th connected segment |
TiglReturnCode tiglWingGetOuterSectionAndElementIndex | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | wingIndex, | ||
int | segmentIndex, | ||
int * | sectionIndexPtr, | ||
int * | elementIndexPtr | ||
) |
Returns the section index and section element index of the outer side of a given wing segment.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | wingIndex | The index of a wing, starting at 1 |
[in] | segmentIndex | The index of a segment, starting at 1 |
[out] | sectionIndexPtr | The section index of the outer side |
[out] | elementIndexPtr | The section element index of the outer side |
TiglReturnCode tiglWingGetOuterSectionAndElementUID | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | wingIndex, | ||
int | segmentIndex, | ||
char ** | sectionUIDPtr, | ||
char ** | elementUIDPtr | ||
) |
Returns the section UID and section element UID of the outer side of a given wing segment.
Important change: The memory necessary for the two UIDs must not be freed by the user anymore.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | wingIndex | The index of a wing, starting at 1 |
[in] | segmentIndex | The index of a segment, starting at 1 |
[out] | sectionUIDPtr | The section UID of the outer side |
[out] | elementUIDPtr | The section element UID of the outer side |
TiglReturnCode tiglWingGetProfileName | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | wingIndex, | ||
int | sectionIndex, | ||
int | elementIndex, | ||
char ** | profileNamePtr | ||
) |
Returns the name of a wing profile. The string returned must not be deleted by the caller via free(). It will be deleted when the CPACS configuration is closed.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | wingIndex | The index of a wing, starting at 1 |
[in] | sectionIndex | The index of a section, starting at 1 |
[in] | elementIndex | The index of an element on the section |
[out] | profileNamePtr | The name of the wing profile |
Usage example:
TiglReturnCode returnCode; char* namePtr = 0; returnCode = tiglWingGetProfileName(cpacsHandle, wing, section, element, &namePtr); printf("Profile name is %s\n", namePtr);
TiglReturnCode tiglWingGetReferenceArea | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | wingIndex, | ||
TiglSymmetryAxis | symPlane, | ||
double * | referenceAreaPtr | ||
) |
Returns the reference area of the wing.
The reference area of the wing is calculated by taking account the quadrilateral portions of each wing segment by projecting the wing segments into the plane defined by the user. If projection should be avoided, use TIGL_NO_SYMMETRY as symPlane argument.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | wingIndex | Index of the Wing to calculate the area, starting at 1 |
[in] | symPlane | Plane on which the wing is projected for calculating the refarea. Values can be:
|
[out] | referenceAreaPtr | The reference area of the wing |
TiglReturnCode tiglWingGetSectionCount | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | wingIndex, | ||
int * | sectionCount | ||
) |
Returns the number of sections of a wing.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | wingIndex | The index of a wing, starting at 1 |
[out] | sectionCount | The number of sections of the wing |
Usage example:
TiglReturnCode returnCode; int sectionCount = 0; returnCode = tiglWingGetSectionUID(cpacsHandle, wingIndex, §ionCount); printf("The Number of sections of wing %d is %d\n", wingIndex, sectionCount);
TiglReturnCode tiglWingGetSectionUID | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | wingIndex, | ||
int | sectionIndex, | ||
char ** | uidNamePtr | ||
) |
Returns the UID of a section of a wing. The string returned must not be deleted by the caller via free(). It will be deleted when the CPACS configuration is closed.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | wingIndex | The index of a wing, starting at 1 |
[in] | sectionIndex | The index of a section, starting at 1 |
[out] | uidNamePtr | The uid of the wing |
Usage example:
TiglReturnCode returnCode; char* uidPtr = 0; returnCode = tiglWingGetSectionUID(cpacsHandle, wing, sectionUID, &uidPtr); printf("The UID of the section of wing %d is %s\n", wing, uidPtr);
TiglReturnCode tiglWingGetSegmentCount | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | wingIndex, | ||
int * | segmentCountPtr | ||
) |
Returns the number of segments for a wing in a CPACS configuration.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | wingIndex | The index of the wing, starting at 1 |
[out] | segmentCountPtr | Pointer to the number of segments |
TiglReturnCode tiglWingGetSegmentEtaXsi | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | wingIndex, | ||
double | pointX, | ||
double | pointY, | ||
double | pointZ, | ||
int * | segmentIndex, | ||
double * | eta, | ||
double * | xsi, | ||
int * | isOnTop | ||
) |
Inverse function to tiglWingGetLowerPoint and tiglWingGetLowerPoint. Calculates to a point (x,y,z) in global coordinates the wing segment coordinates and the wing segment index.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | wingIndex | The index of the wing, starting at 1 |
[in] | pointX | X-Coordinate of the global point |
[in] | pointY | Y-Coordinate of the global point |
[in] | pointZ | Z-Coordinate of the global point |
[out] | segmentIndex | The index of the segment of the wing, starting at 1 |
[out] | eta | Eta value in segment coordinates |
[out] | xsi | Xsi value in segment coordinates |
[out] | isOnTop | isOnTop is 1, if the point lies on the upper wing face, else 0. |
TiglReturnCode tiglWingGetSegmentIndex | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | segmentUID, | ||
int * | segmentIndexPtr, | ||
int * | wingIndexPtr | ||
) |
Returns the Index of a segment of a wing.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | segmentUID | The uid of the wing |
[out] | segmentIndexPtr | The index of a segment, starting at 1 |
[out] | wingIndexPtr | The index of a wing, starting at 1 |
Usage example:
TiglReturnCode returnCode; int segmentIndex, wingIndex; returnCode = tiglWingGetSegmentIndex(cpacsHandle, segmentUID, &segmentIndex, &wingIndex); printf("The Index of the segment of wing %d is %d\n", wingIndex, segmentIndex);
TiglReturnCode tiglWingGetSegmentLowerSurfaceAreaTrimmed | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | wingIndex, | ||
int | segmentIndex, | ||
double | eta1, | ||
double | xsi1, | ||
double | eta2, | ||
double | xsi2, | ||
double | eta3, | ||
double | xsi3, | ||
double | eta4, | ||
double | xsi4, | ||
double * | surfaceArea | ||
) |
Computes the area of the trimmed lower wing segment surface. This function can be e.g. used to determine the area of the wing flaps.
The use of this function is analog to tiglWingGetSegmentUpperSurfaceAreaTrimmed.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | wingIndex | The index of a wing, starting at 1 |
[in] | segmentIndex | The index of a segment, starting at 1 |
[in] | eta1 | Eta value of P1 in range [0,1] |
[in] | xsi1 | Xsi value of P1 in range [0,1] |
[in] | eta2 | Eta value of P2 in range [0,1] |
[in] | xsi2 | Xsi value of P2 in range [0,1] |
[in] | eta3 | Eta value of P3 in range [0,1] |
[in] | xsi3 | Xsi value of P3 in range [0,1] |
[in] | eta4 | Eta value of P4 in range [0,1] |
[in] | xsi4 | Xsi value of P4 in range [0,1] |
[out] | surfaceArea | Area of the trimmed lower wing surface |
TiglReturnCode tiglWingGetSegmentSurfaceArea | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | wingIndex, | ||
int | segmentIndex, | ||
double * | surfaceAreaPtr | ||
) |
Returns the surface area of a segment of a wing. This includes only the area of the upper and lower wing segment surface and does not include the trailing egde or any closing faces.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | wingIndex | The index of a wing, starting at 1 |
[in] | segmentIndex | The index of a segment, starting at 1 |
[out] | surfaceAreaPtr | The pointer to a variable for the surface area of the wing |
TiglReturnCode tiglWingGetSegmentUID | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | wingIndex, | ||
int | segmentIndex, | ||
char ** | uidNamePtr | ||
) |
Returns the UID of a segment of a wing. The string returned must not be deleted by the caller via free(). It will be deleted when the CPACS configuration is closed.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | wingIndex | The index of a wing, starting at 1 |
[in] | segmentIndex | The index of a segment, starting at 1 |
[out] | uidNamePtr | The uid of the wing |
Usage example:
TiglReturnCode returnCode; char* uidPtr = 0; returnCode = tiglWingGetSegmentUID(cpacsHandle, wing, segmentID, &uidPtr); printf("The UID of the segment of wing %d is %s\n", wing, uidPtr);
TiglReturnCode tiglWingGetSegmentUpperSurfaceAreaTrimmed | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | wingIndex, | ||
int | segmentIndex, | ||
double | eta1, | ||
double | xsi1, | ||
double | eta2, | ||
double | xsi2, | ||
double | eta3, | ||
double | xsi3, | ||
double | eta4, | ||
double | xsi4, | ||
double * | surfaceArea | ||
) |
Computes the area of the trimmed upper wing segment surface. This function can be e.g. used to determine the area of the wing flaps.
The computed area does not include the trailing edge or any closing side faces.
All eta and xsi values must be in the range [0,1]. The trimmed area is defined with the four corner point P1, P2, P3, and P4. The order of the points should be right handed, as shown the the image below.
Each of the points is defined with an eta/xsi coordinate pair in the wing segment system.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | wingIndex | The index of a wing, starting at 1 |
[in] | segmentIndex | The index of a segment, starting at 1 |
[in] | eta1 | Eta value of P1 in range [0,1] |
[in] | xsi1 | Xsi value of P1 in range [0,1] |
[in] | eta2 | Eta value of P2 in range [0,1] |
[in] | xsi2 | Xsi value of P2 in range [0,1] |
[in] | eta3 | Eta value of P3 in range [0,1] |
[in] | xsi3 | Xsi value of P3 in range [0,1] |
[in] | eta4 | Eta value of P4 in range [0,1] |
[in] | xsi4 | Xsi value of P4 in range [0,1] |
[out] | surfaceArea | Area of the trimmed upper wing surface |
TiglReturnCode tiglWingGetSegmentVolume | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | wingIndex, | ||
int | segmentIndex, | ||
double * | volumePtr | ||
) |
Returns the volume of a segment of a wing.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | wingIndex | The index of a wing, starting at 1 |
[in] | segmentIndex | The index of a segment, starting at 1 |
[out] | volumePtr | The pointer to a variable for the volume of the wing |
TiglReturnCode tiglWingGetSpan | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | wingUID, | ||
double * | pSpan | ||
) |
Returns the span of a wing.
The calculation of the wing span is realized as follows:
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | wingUID | UID of the Wing |
[out] | pSpan | Wing span |
TiglReturnCode tiglWingGetSurfaceArea | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | wingIndex, | ||
double * | surfaceAreaPtr | ||
) |
Returns the surface area of the wing. Currently, the area includes also the faces on the wing symmetry plane (in case of a symmetric wing). In coming releases, these faces will not belong anymore to the surface area calculation.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | wingIndex | Index of the Wing to calculate the area, starting at 1 |
[out] | surfaceAreaPtr | The surface area of the wing |
TiglReturnCode tiglWingGetSymmetry | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | wingIndex, | ||
TiglSymmetryAxis * | symmetryAxisPtr | ||
) |
Returns the Symmetry Enum if the wing has symmetry-axis.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | wingIndex | Index of the Wing to export |
[out] | symmetryAxisPtr | Returning TiglSymmetryAxis enum pointer |
TiglReturnCode tiglWingGetUID | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | wingIndex, | ||
char ** | uidNamePtr | ||
) |
Returns the UID of a wing. The string returned must not be deleted by the caller via free(). It will be deleted when the CPACS configuration is closed.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | wingIndex | The index of a wing, starting at 1 |
[out] | uidNamePtr | The uid of the wing |
Usage example:
TiglReturnCode returnCode; char* uidPtr = 0; returnCode = tiglWingGetUID(cpacsHandle, wing, &uidPtr); printf("The UID of the wing is %s\n", uidPtr);
TiglReturnCode tiglWingGetUpperPoint | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | wingIndex, | ||
int | segmentIndex, | ||
double | eta, | ||
double | xsi, | ||
double * | pointXPtr, | ||
double * | pointYPtr, | ||
double * | pointZPtr | ||
) |
Returns a point on the upper wing surface for a a given wing and segment index.
Returns a point on the upper wing surface in dependence of parameters eta and xsi, which range from 0.0 to 1.0. For eta = 0.0, xsi = 0.0 the point is equal to the leading edge on the inner section of the given segment. For eta = 1.0, xsi = 1.0 the point is equal to the trailing edge on the outer section of the given segment. The point is returned in absolute world coordinates.
The behavior of this function can be modified using tiglWingSetGetPointBehavior. The options are asParametersOnSurface or onLinearLoft. For the first, the inputs are interpreted as normalized parameters on the surface and the point corresponding to these parameters is returned (default). For the second, the inputs are interpreted as eta-xsi coordinates on the chordface spanned by the leading edge and trailing edge points of the inner and outer elements.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | wingIndex | The index of the wing, starting at 1 |
[in] | segmentIndex | The index of the segment of the wing, starting at 1 |
[in] | eta | eta in the range 0.0 <= eta <= 1.0; eta = 0 for inner section , eta = 1 for outer section |
[in] | xsi | xsi in the range 0.0 <= xsi <= 1.0; xsi = 0 for Leading Edge, xsi = 1 for Trailing Edge |
[out] | pointXPtr | Pointer to the x-coordinate of the point in absolute world coordinates |
[out] | pointYPtr | Pointer to the y-coordinate of the point in absolute world coordinates |
[out] | pointZPtr | Pointer to the z-coordinate of the point in absolute world coordinates |
TiglReturnCode tiglWingGetUpperPointAtDirection | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | wingIndex, | ||
int | segmentIndex, | ||
double | eta, | ||
double | xsi, | ||
double | dirx, | ||
double | diry, | ||
double | dirz, | ||
double * | pointXPtr, | ||
double * | pointYPtr, | ||
double * | pointZPtr, | ||
double * | errorDistance | ||
) |
Returns a point on the upper wing surface for a a given wing and segment index. This function is different from tiglWingGetUpperPoint: First, a point on the wing chord surface is computed (defined by segment index and eta,xsi). Then, a line is constructed, which is defined by this point and a direction given by the user. The intersection of this line with the upper wing surface is finally returned. The point is returned in absolute world coordinates.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | wingIndex | The index of the wing, starting at 1 |
[in] | segmentIndex | The index of the segment of the wing, starting at 1 |
[in] | eta | eta in the range 0.0 <= eta <= 1.0; eta = 0 for inner section , eta = 1 for outer section |
[in] | xsi | xsi in the range 0.0 <= xsi <= 1.0; xsi = 0 for Leading Edge, xsi = 1 for Trailing Edge |
[in] | dirx | X-component of the direction vector. |
[in] | diry | Y-component of the direction vector. |
[in] | dirz | Z-component of the direction vector. |
[out] | pointXPtr | Pointer to the x-coordinate of the point in absolute world coordinates |
[out] | pointYPtr | Pointer to the y-coordinate of the point in absolute world coordinates |
[out] | pointZPtr | Pointer to the z-coordinate of the point in absolute world coordinates |
[out] | errorDistance | If the upper surface is missed by the line, the absolute distance between line and the nearest point on the surface is returned. The distance is zero in case of successful intersection. It's up to the user to decide, if the distance is too large and the result has to be treated as an error. |
TiglReturnCode tiglWingGetVolume | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
int | wingIndex, | ||
double * | volumePtr | ||
) |
Returns the volume of the wing.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | wingIndex | Index of the Wing to calculate the volume, starting at 1 |
[out] | volumePtr | The volume of the wing |
TiglReturnCode tiglWingGetWettedArea | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | wingUID, | ||
double * | wettedAreaPtr | ||
) |
Returns the wetted area of the wing. If the wing has no parent (fuselage), it returns the surface area of the wing.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | wingUID | UID of the Wing to calculate the wetted area |
[out] | wettedAreaPtr | The wetted area of the wing |
TiglReturnCode tiglWingInterpolateXsi | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | firstUID, | ||
double | firstEta, | ||
double | firstXsi, | ||
const char * | secondUID, | ||
double | secondEta, | ||
double | secondXsi, | ||
const char * | intersectionUID, | ||
double | intersectionEta, | ||
double * | intersectionXsi, | ||
TiglBoolean * | hasWarning | ||
) |
Given a straight line in space defined by a pair of segment / component segment (eta,xsi) coordinates, the function computes the intersection of the line with an iso-eta line of a segment or component segment.
The line is defined by its inner and outer point, both given in segment or component segment coordinates. Typically, these might be spar positions or leading edge coordinates of flaps. The function returns the xsi coordinate (depth coordinate) of the intersection point in the coordinate system defined by the uid. Hence, this coordinate is given in either the segment or component segment coordinate system. See image below for details.
[in] | cpacsHandle | |
[in] | firstUID,firstEta,firstXsi | Starting point of the intersection line (on segment or component segment) |
[in] | secondUID,secondEta,secondXsi | Ending point of the intersection line (on segment or component segment) |
[in] | intersectionUID | UID of the segment or componentSegment that relates to eta |
[in] | intersectionEta | Eta coordinate of the iso-eta segment or component segment intersection line |
[out] | intersectionXsi | Xsi coordinate of the intersection point on the referred segment or component segment |
[out] | hasWarning | The hasWarning flag is true (1), if the resulting xsi value is either outside the valid range [0,1]. It is up to the user to handle these cases properly. This flag is only valid, if the function returns TIGL_SUCCESS. |
TiglReturnCode tiglWingSegmentPointGetComponentSegmentEtaXsi | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
const char * | segmentUID, | ||
const char * | componentSegmentUID, | ||
double | segmentEta, | ||
double | segmentXsi, | ||
double * | eta, | ||
double * | xsi | ||
) |
Returns eta, xsi coordinates of a componentSegment given segmentEta and segmentXsi on a wing segment.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | segmentUID | UID of the wing segment to search for |
[in] | componentSegmentUID | UID of the associated componentSegment |
[in] | segmentEta,segmentXsi | Eta and Xsi coordinates of the point on the wing segment |
[out] | eta | Eta of the point on the corresponding component segment. |
[out] | xsi | Xsi of the point on the corresponding component segment. |
TiglReturnCode tiglWingSetGetPointBehavior | ( | TiglCPACSConfigurationHandle | cpacsHandle, |
TiglGetPointBehavior | behavior | ||
) |
Sets the behavior of the tiglWingGetUpperPoint and tiglWingGetLowerPoint functions.
This function sets the behavior of the tiglWingGetUpperPoint and tiglWingGetLowerPoint functions. The options are asParameterOnSurface or onLinearLoft. For the first, the inputs are interpreted as normalized parameters on the surface and the point corresponding to these parameters is returned. For the second, the inputs are interpreted as eta-xsi coordinates on the chordface spanned by the leading edge and trailing edge points of the inner and outer elements.
[in] | cpacsHandle | Handle for the CPACS configuration |
[in] | behavior | enum describing the desired behavior of the function. Possible values are asParameterOnSurface and onLinearLoft. |
const typedef char** TiglStringList |