Functions for Sets

The following group of API functions deals with set manipulation.

Click here to return to the main page. More...

Functions
int	GetNumSets ()
void	SetSetName (int index, const string &in name)
string	GetSetName (int index)
string []	GetGeomSetAtIndex (int index)
string []	GetGeomSet (const string &in name)
int	GetSetIndex (const string &in name)
bool	GetSetFlag (const string &in geom_id, int set_index)
void	SetSetFlag (const string &in geom_id, int set_index, bool flag)

Detailed Description

Function Documentation

GetGeomSet()

string [] GetGeomSet

(

const string &in

name

)

Get an array of Geom IDs for the specified set name

Parameters

[in]

name

const string set name

Returns

array<string> array of Geom IDs

GetGeomSetAtIndex()

string [] GetGeomSetAtIndex

(

int

index

)

Get an array of Geom IDs for the specified set index

See also

SET_TYPE

Parameters

[in]

index

Set index

Returns

Array of Geom IDs

GetNumSets()

int GetNumSets

(

)

Get the total number of defined sets. Named sets are used to group compenents and read/write on them. The number of named sets will be 10 for OpenVSP versions up to 3.17.1 and 20 for later versions.

Returns

Number of sets

GetSetFlag()

bool GetSetFlag	(	const string &in	geom_id,
		int	set_index
	)

Check if a Geom is in the set at the specified set index

Parameters

[in]	geom_id	Geom ID
[in]	set_index	Set index

Returns

True if geom is in the set, false otherwise

GetSetIndex()

int GetSetIndex

(

const string &in

name

)

Get the set index for the specified set name

Parameters

[in]

name

Set name

Returns

Set index

GetSetName()

string GetSetName

(

int

index

)

Get the name of a set at specified index

See also

SET_TYPE

Parameters

[in]

index

Set index

Returns

Set name

SetSetFlag()

void SetSetFlag	(	const string &in	geom_id,
		int	set_index,
		bool	flag
	)

Set whether or not a Geom is a member of the set at specified set index

Parameters

[in]	geom_id	Geom ID
[in]	set_index	Set index
[in]	flag	Flag that indicates set membership

SetSetName()

void SetSetName	(	int	index,
		const string &in	name
	)

Set the name of a set at specified index

See also

SET_TYPE

Parameters

[in]	index	Set index
[in]	name	Set name