Functions related to Sub-Surfaces are defined in this group.

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

Functions
string	AddSubSurf (const string &in geom_id, int type, int surfindex=0)

void	DeleteSubSurf (const string &in geom_id, const string &in sub_id)

void	DeleteSubSurf (const string &in sub_id)

string	GetSubSurf (const string &in geom_id, int index)

string []	GetSubSurf (const string &in geom_id, const string &in name)

void	SetSubSurfName (const string &in geom_id, const string &in sub_id, const string &in name)

void	SetSubSurfName (const string &in sub_id, const string &in name)

string	GetSubSurfName (const string &in geom_id, const string &in sub_id)

string	GetSubSurfName (const string &in sub_id)

int	GetSubSurfIndex (const string &in sub_id)

string []	GetSubSurfIDVec (const string &in geom_id)

string []	GetAllSubSurfIDs ()

int	GetNumSubSurf (const string &in geom_id)

int	GetSubSurfType (const string &in sub_id)

string []	GetSubSurfParmIDs (const string &in sub_id)

Detailed Description

Function Documentation

◆ AddSubSurf()

string AddSubSurf	(	const string &in	geom_id,
		int	type,
		int	surfindex = `0`
	)

Add a sub-surface to the specified Geom

See also: SUBSURF_TYPE

Parameters

[in]	geom_id	Geom ID
[in]	type	Sub-surface type enum (i.e. SS_RECTANGLE)
[in]	surfindex	Main surface index (default: 0)

Returns: Sub-surface ID

◆ DeleteSubSurf() [1/2]

void DeleteSubSurf	(	const string &in	geom_id,
		const string &in	sub_id
	)

Delete the specified sub-surface

Parameters

[in]	geom_id	Geom ID
[in]	sub_id	Sub-surface ID

◆ DeleteSubSurf() [2/2]

void DeleteSubSurf ( const string &in sub_id )

Delete the specified sub-surface

Parameters

[in] sub_id Sub-surface ID

◆ GetAllSubSurfIDs()

string [] GetAllSubSurfIDs ( )

Get a vector of all sub-surface IDs for the entire model

Returns: Array of sub-surface IDs

◆ GetNumSubSurf()

int GetNumSubSurf ( const string &in geom_id )

Get the number of sub-surfaces for the specified Geom

Parameters

[in] geom_id Geom ID

Returns: Number of Sub-surfaces

◆ GetSubSurf() [1/2]

string GetSubSurf	(	const string &in	geom_id,
		int	index
	)

Get the ID of the specified sub-surface

Parameters

[in]	geom_id	Geom ID
[in]	index	Sub-surface index

Returns: Sub-surface ID

◆ GetSubSurf() [2/2]

string [] GetSubSurf	(	const string &in	geom_id,
		const string &in	name
	)

Get all sub-surface IDs with specified parent Geom and name

Parameters

[in]	geom_id	Geom ID
[in]	name	Sub-surface name

Returns: Srray of sub-surface IDs

◆ GetSubSurfIDVec()

string [] GetSubSurfIDVec ( const string &in geom_id )

Get a vector of all sub-surface IDs for the specified geometry

Parameters

[in] geom_id Geom ID

Returns: Array of sub-surface IDs

◆ GetSubSurfIndex()

int GetSubSurfIndex ( const string &in sub_id )

Get the index of the specified sub-surface in its parent Geom's sub-surface vector

Parameters

[in] sub_id Sub-surface ID

Returns: Sub-surface index

◆ GetSubSurfName() [1/2]

string GetSubSurfName	(	const string &in	geom_id,
		const string &in	sub_id
	)

Get the name of the specified sub-surface

Parameters

[in]	geom_id	Geom ID
[in]	sub_id	Sub-surface ID

Returns: Sub-surface name

◆ GetSubSurfName() [2/2]

string GetSubSurfName ( const string &in sub_id )

Get the name of the specified sub-surface

Parameters

[in] sub_id Sub-surface ID

Returns: Sub-surface name

◆ GetSubSurfParmIDs()

string [] GetSubSurfParmIDs ( const string &in sub_id )

Get the vector of Parm IDs for specified sub-surface

Parameters

[in] sub_id Sub-surface ID

Returns: Array of Parm IDs

◆ GetSubSurfType()

int GetSubSurfType ( const string &in sub_id )

Get the type for the specified sub-surface (i.e. SS_RECTANGLE)

See also: SUBSURF_TYPE

Parameters

[in] sub_id Sub-surface ID

Returns: Sub-surface type enum (i.e. SS_RECTANGLE)

◆ SetSubSurfName() [1/2]

void SetSubSurfName	(	const string &in	geom_id,
		const string &in	sub_id,
		const string &in	name
	)

Set the name of the specified sub-surface

Parameters

[in]	geom_id	Geom ID
[in]	sub_id	Sub-surface ID
[in]	name	Sub-surface name

◆ SetSubSurfName() [2/2]

void SetSubSurfName	(	const string &in	sub_id,
		const string &in	name
	)

Set the name of the specified sub-surface

Parameters

[in]	sub_id	Sub-surface ID
[in]	name	Sub-surface name