CharacterisedSurfaceCollection

A collection of characterised surface media.

Example

application = cf.Application.GetInstance()
project = application:NewProject()

    -- Create some characterised surfaces

characterisedSurface1 = project.Definitions.Media.CharacterisedSurface:AddCharacterisedSurface("dummyFile")
characterisedSurface2 = project.Definitions.Media.CharacterisedSurface:AddCharacterisedSurface("path\to\file")

Inheritance

The CharacterisedSurfaceCollection object is derived from the Object object.

Usage locations

The CharacterisedSurfaceCollection object can be accessed from the following locations:

Property List

Count
The number of CharacterisedSurface items in the collection. (Read only number)
Label
The object label. (Read/Write string)
Type
The object type string. (Read only string)

Method List

AddCharacterisedSurface (properties table)
Create a characterised surface medium from a table defining the properties. (Returns a CharacterisedSurface object.)
AddCharacterisedSurface (filename string)
Create a characterised surface medium. (Returns a CharacterisedSurface object.)
Delete ()
Deletes the entity.
Duplicate ()
Duplicates the entity. (Returns a Object object.)
GetProperties ()
Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step. (Returns a table object.)
Item (index number)
Returns the CharacterisedSurface for the given index in the collection. (Returns a CharacterisedSurface object.)
Item (label string)
Returns the CharacterisedSurface for the given label in the collection. (Returns a CharacterisedSurface object.)
Items ()
Returns a table of CharacterisedSurface items. (Returns a UnsupportedType(List of CharacterisedSurface) object.)
SetProperties (properties Object)
Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.

Static Function List

GetDefaultProperties ()
Creates a table containing the default settings to create an object. (Returns a table object.)

Property Details

Count
The number of CharacterisedSurface items in the collection.
Type
number
Access
Read only
Label
The object label.
Type
string
Access
Read/Write
Type
The object type string.
Type
string
Access
Read only

Method Details

AddCharacterisedSurface (properties table)
Create a characterised surface medium from a table defining the properties.
Input Parameters
properties(table)
A table of properties defining the new characterised surface medium.
Return
CharacterisedSurface
The characterised surface medium.
AddCharacterisedSurface (filename string)
Create a characterised surface medium.
Input Parameters
filename(string)
The file describing the medium properties.
Return
CharacterisedSurface
The characterised surface medium.
Delete ()
Deletes the entity.
Duplicate ()
Duplicates the entity.
Return
Object
The new (duplicated) entity.
GetProperties ()
Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step.
Return
table
A table defining the properties.
Item (index number)
Returns the CharacterisedSurface for the given index in the collection.
Input Parameters
index(number)
The index of the CharacterisedSurface.
Return
CharacterisedSurface
The item in the collection
Item (label string)
Returns the CharacterisedSurface for the given label in the collection.
Input Parameters
label(string)
The label of the CharacterisedSurface.
Return
CharacterisedSurface
The item in the collection
Items ()
Returns a table of CharacterisedSurface items.
Return
UnsupportedType(List of CharacterisedSurface)
The list of items in the collection
SetProperties (properties Object)
Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.
Input Parameters
properties(Object)
A table of properties defining the new state of the object.

Static Function Details

GetDefaultProperties ()
Creates a table containing the default settings to create an object.
Return
table
A table containing the default properties.