`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:

Collection lists
- Media object has collection CharacterisedSurface.

Property List

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.
DeleteEntities ( List of Object): Delete the given list of entities from the collection.
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.)
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

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.

DeleteEntities ( List of Object)

Delete the given list of entities from the collection.

Input Parameters

(List of Object)

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.

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.