CharacterisedSurface

A characterised surface medium.

Example

app = cf.GetApplication()
project = app:NewProject()

    -- Create an characterised surface
    
characterisedSurface = project.Media:AddCharacterisedSurface("dummyFile")

Inheritance

The CharacterisedSurface object is derived from the Medium object.

Property List

Colour
The medium colour. (Read/Write Colour)
Filename
The file describing the medium properties in XML format. (Read/Write string)
Label
The object label. (Read/Write string)
Suspect
Indicates whether the medium is suspect. (Read only boolean)
Type
The object type string. (Read only string)

Method List

AddToLibrary ()
Add the medium to the media library.
Delete ()
Delete the medium.
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.)
SetNotSuspect ()
Reset the suspect setting on the medium.
SetProperties (properties table)
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
Colour
Access
Read/Write
Filename
The file describing the medium properties in XML format.
Type
string
Access
Read/Write
Label
The object label.
Type
string
Access
Read/Write
Suspect
Indicates whether the medium is suspect.
Type
boolean
Access
Read only
Type
The object type string.
Type
string
Access
Read only

Method Details

AddToLibrary ()
Add the medium to the media library.
Delete ()
Delete the medium.
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 properties table.
SetNotSuspect ()
Reset the suspect setting on the medium.
SetProperties (properties table)
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(table)
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
The default properties table.