DB.Api.ComponentBlockSurface Class Reference

Class to handle component block surfaces. More...

Public Member Functions
string	GetAttribute (string attributeName)
	Returns the string value of the attribute with the supplied name.
int	GetAttributeAsInt (string attributeName)
	Returns the integer value of the attribute with the supplied name (same as GetIntegerAttribute). If the value of the attribute is not an integer value, the return value is undefined. To use this method, foreknowledge is required that the value of the attribute is in fact an integer value.
double	GetAttributeAsDouble (string attributeName)
	Returns the double value of the attribute with the supplied name. If the value of the attribute is not a double value, the return value is undefined. To use this method, foreknowledge is required that the value of the attribute is in fact an double value.
int	GetIntegerAttribute (string attributeName)
	Returns the integer value of the attribute with the supplied name (same as GetAttributeAsInt). If the value of the attribute is not an integer value, the return value is undefined. To use this method, foreknowledge is required that the value of the attribute is in fact an integer value.
DataObject	GetAttributeDataObject (string attributeName)
	Returns a DataObject object associated with the attribute of the supplied name.
void	SetAttribute (string attributeName, string value)
	Sets an attribute with the supplied name to the supplied value.
bool	IsAttributeTrue (string attributeName)
	Returns boolean value (TRUE/FALSE) of the attribute with the supplied name.
bool	SelectOpening (int index)
	Selects opening in component block surface.
void	Dispose ()

Properties
Collections.Openings	Openings [get]
	Instantiates collection of component surface openings. Currently, component surfaces can only incorporate CFD boundary openings.
Collections.HardAttributes	HardAttributes [get]
	Instantiate a collection of 'hard' attributes from the Sketch SketchDComponentBlockSurface object. Hard attributes are attributes set at a specific model decomposition level (component block surface level in this case) and don't inherit from level above.
double	Area [get]
	Returns the area of the component block surface.
double	Azimuth [get]
	Returns the azimuth of the component block surface in degrees.
double	Tilt [get]
	Returns the tilt of the component block surface in degrees.
Polygon	SurfacePolygon [get]
	Returns a polygon representing the component block surface as a Polygon object.

Detailed Description

Class to handle component block surfaces.

Member Function Documentation

GetAttribute()

string DB.Api.ComponentBlockSurface.GetAttribute

(

string

attributeName

)

Returns the string value of the attribute with the supplied name.

Parameters

attributeName

Name of attribute from which value is to be retrieved

Returns

TRUE if attribute is retrieved successfully otherwise FALSE

GetAttributeAsDouble()

double DB.Api.ComponentBlockSurface.GetAttributeAsDouble

(

string

attributeName

)

Returns the double value of the attribute with the supplied name. If the value of the attribute is not a double value, the return value is undefined. To use this method, foreknowledge is required that the value of the attribute is in fact an double value.

Parameters

attributeName

Name of attribute from which double value is to be retrieved

Returns

Double value of attribute

GetAttributeAsInt()

int DB.Api.ComponentBlockSurface.GetAttributeAsInt

(

string

attributeName

)

Returns the integer value of the attribute with the supplied name (same as GetIntegerAttribute). If the value of the attribute is not an integer value, the return value is undefined. To use this method, foreknowledge is required that the value of the attribute is in fact an integer value.

Parameters

attributeName

Name of attribute from which integer value is to be retrieved

Returns

Integer value of attribute

GetAttributeDataObject()

DataObject DB.Api.ComponentBlockSurface.GetAttributeDataObject

(

string

attributeName

)

Returns a DataObject object associated with the attribute of the supplied name.

Parameters

attributeName

Name of attribute from which DataObject object is to be retrieved

Returns

DataObject object

GetIntegerAttribute()

int DB.Api.ComponentBlockSurface.GetIntegerAttribute

(

string

attributeName

)

Returns the integer value of the attribute with the supplied name (same as GetAttributeAsInt). If the value of the attribute is not an integer value, the return value is undefined. To use this method, foreknowledge is required that the value of the attribute is in fact an integer value.

Parameters

attributeName

Name of attribute from which integer value is to be retrieved

Returns

Integer value of attribute

IsAttributeTrue()

bool DB.Api.ComponentBlockSurface.IsAttributeTrue

(

string

attributeName

)

Returns boolean value (TRUE/FALSE) of the attribute with the supplied name.

Parameters

attributeName

Attribute name

Returns

TRUE if boolean value of attribute is true otherwise FALSE

SelectOpening()

bool DB.Api.ComponentBlockSurface.SelectOpening

(

int

index

)

Selects opening in component block surface.

Parameters

index

Index of opening to be selected

Returns

TRUE if valid index is supplied otherwise FALSE

SetAttribute()

void DB.Api.ComponentBlockSurface.SetAttribute	(	string	attributeName,
		string	value
	)

Sets an attribute with the supplied name to the supplied value.

Parameters

attributeName	Name of attribute to be set
value	Value to which attribute is to be set

Returns

TRUE if attribute is set successfully otherwise FALSE

---

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

• C:/DesignBuilder/Components Source/DB.Api/DB.Api/ComponentBlockSurface.cs