CharacterisedSurface

A characterised surface medium.

Example

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

-- Create an characterised surface

characterisedSurface = project.Definitions.Media.CharacterisedSurface:AddCharacterisedSurface("dummyFile")

Inheritance

The CharacterisedSurface object is derived from the Medium object.

Usage locations

The CharacterisedSurface object can be accessed from the following locations:

Property List

Colour
The medium colour. (Read/Write string)
Filename
The file describing the medium properties in XML format. (Read/Write FileReference)
Label
The object label. (Read/Write string)
Type
The object type string. (Read only string)

Method List

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.)
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

Colour
The medium colour.
Type
string
Access
Read/Write
Filename
The file describing the medium properties in XML format.
Type
FileReference
Access
Read/Write
Label
The object label.
Type
string
Access
Read/Write
Type
The object type string.
Type
string
Access
Read only

Method Details

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.
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.