This group of functions is available for manipulating VSPAERO control surface groups through the API. Note, VSPAERO also includes rectangle type sub-surfaces as possible control surfaces.
Click here to return to the main page.
More...
◆ AddAllToVSPAEROControlSurfaceGroup()
void AddAllToVSPAEROControlSurfaceGroup |
( |
int |
CSGroupIndex | ) |
|
Add all available control surfaces to the control surface group at the specified index
- Parameters
-
[in] | CSGroupIndex | Index of the control surface group |
◆ AddSelectedToCSGroup()
void AddSelectedToCSGroup |
( |
int@ [] |
selected, |
|
|
int |
CSGroupIndex |
|
) |
| |
Add each control surfaces in the array of control surface indexes to the control surface group at the specified index.
- Warning
- The indexes in input "selected" must be matched with available control surfaces identified by GetAvailableCSNameVec. The "selected" input uses one- based indexing to associate available control surfaces.
- See also
- GetAvailableCSNameVec
- Parameters
-
[in] | selected | Array of control surface indexes to add to the group. Note, the integer values are one based. |
[in] | CSGroupIndex | Index of the control surface group |
◆ AutoGroupVSPAEROControlSurfaces()
void AutoGroupVSPAEROControlSurfaces |
( |
| ) |
|
Creates the initial default grouping for the control surfaces. The initial grouping collects all surface copies of the sub-surface into a single group. For example if a wing is defined with an aileron and that wing is symmetrical about the xz plane there will be a surface copy of the master wing surface as well as a copy of the sub-surface. The two sub-surfaces may get deflected differently during analysis routines and can be identified uniquely by their full name.
- See also
- CreateVSPAEROControlSurfaceGroup
◆ CreateVSPAEROControlSurfaceGroup()
int CreateVSPAEROControlSurfaceGroup |
( |
| ) |
|
Add a new VSPAERO control surface group using the default naming convention. The control surface group will not contain any control surfaces until they are added.
- See also
- AddSelectedToCSGroup
- Returns
- Index of the new VSPAERO control surface group
◆ GetActiveCSNameVec()
string [] GetActiveCSNameVec |
( |
int |
CSGroupIndex | ) |
|
Get the names of each active (used) control surface in the control surface group at the specified index
- Parameters
-
[in] | CSGroupIndex | Index of the control surface group |
- Returns
- Array of active control surface names
◆ GetAvailableCSNameVec()
string [] GetAvailableCSNameVec |
( |
int |
CSGroupIndex | ) |
|
Get the names of each available (not used) control surface in the control surface group at the specified index
- Parameters
-
[in] | CSGroupIndex | Index of the control surface group |
- Returns
- Array of active control surface names
◆ GetCompleteCSNameVec()
string [] GetCompleteCSNameVec |
( |
| ) |
|
Get the names of all control surfaces. Some may be active (used) while others may be available.
- Returns
- Array of all control surface names
◆ GetNumControlSurfaceGroups()
int GetNumControlSurfaceGroups |
( |
| ) |
|
Get the total number of control surface groups
- Returns
- Number of control surface groups
◆ GetVSPAEROControlGroupName()
string GetVSPAEROControlGroupName |
( |
int |
CSGroupIndex | ) |
|
Get the name of the control surface group at the specified index
- Parameters
-
[in] | CSGroupIndex | Index of the control surface group |
◆ RemoveAllFromVSPAEROControlSurfaceGroup()
void RemoveAllFromVSPAEROControlSurfaceGroup |
( |
int |
CSGroupIndex | ) |
|
Remove all used control surfaces from the control surface group at the specified index
- Parameters
-
[in] | CSGroupIndex | Index of the control surface group |
◆ RemoveSelectedFromCSGroup()
void RemoveSelectedFromCSGroup |
( |
int@ [] |
selected, |
|
|
int |
CSGroupIndex |
|
) |
| |
Remove each control surfaces in the array of control surface indexes from the control surface group at the specified index.
- Warning
- The indexes in input "selected" must be matched with active control surfaces identified by GetActiveCSNameVec. The "selected" input uses one- based indexing to associate available control surfaces.
- See also
- GetActiveCSNameVec
- Parameters
-
[in] | selected | Array of control surface indexes to remove from the group. Note, the integer values are one based. |
[in] | CSGroupIndex | Index of the control surface group |
◆ SetVSPAEROControlGroupName()
void SetVSPAEROControlGroupName |
( |
const string &in |
name, |
|
|
int |
CSGroupIndex |
|
) |
| |
Set the name for the control surface group at the specified index
- Parameters
-
[in] | name | Name to set for the control surface group |
[in] | CSGroupIndex | Index of the control surface group |