TopologyEntityCollectionOf_Edge
An abstract (base) collection of edge entities with topology information.
Example
-- This is an abstract object, see derived objects for examples
Inheritance
The TopologyEntityCollectionOf_Edge object is derived from the Object object.
The following objects are derived (specialisations) from the TopologyEntityCollectionOf_Edge object:
Property List
Method List
- Contains (label string)
- Checks if the collection contains an item with the given label. (Returns a boolean 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 Edge for the given index in the collection. (Returns a Edge object.)
- Item (label string)
- Returns the Edge for the given label in the collection. (Returns a Edge object.)
- Items ()
- Returns a table of Edge items. (Returns a UnsupportedType(List of Edge) 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.
- UniqueName (label string)
- Generates a unique name base of the provided base name. If the base name already exists in the collection, a digit will be appended until a valid name is generated. (Returns a string object.)
Static Function List
- GetDefaultProperties ()
- Creates a table containing the default settings to create an object. (Returns a table object.)
Property Details
Method Details
- Contains (label string)
- Checks if the collection contains an item with the given label.
- 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 Edge for the given index in the collection.
- Item (label string)
- Returns the Edge for the given label in the collection.
- Items ()
- Returns a table of Edge items.
- Return
- UnsupportedType(List of Edge)
- 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.
- UniqueName (label string)
- Generates a unique name base of the provided base name. If the base name already exists in the collection, a digit will be appended until a valid name is generated.
Static Function Details
- GetDefaultProperties ()
- Creates a table containing the default settings to create an object.
- Return
- table
- A table containing the default properties.