`MockGroupCollection`

Inheritance

The MockGroupCollection object is derived from the CollectionOf_MockEntityWithGroups object.

Usage locations

The MockGroupCollection object can be accessed from the following locations:

Collection lists
- MockModelWithGroups object has collection MockEntitiesWithGroupCapability.
- SubModelOf_MockModelWithGroups object has collection MockEntitiesWithGroupCapability.
- SubModelOf_MockModelWithNotes object has collection MockEntitiesWithGroupCapability.
- MockEntityWithGroups object has collection SubObjectsWithGroups.

Property List

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

Property List (internal only)

Path: (Read only string)

Collection List (internal only)

Groups: (GroupCollectionOf_MockEntityWithGroups of GroupOf_MockEntityWithGroups.)

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.)
Item (index number): Returns the MockEntityWithGroups for the given index in the collection. (Returns a MockEntityWithGroups object.)
Item (label string): Returns the MockEntityWithGroups for the given label in the collection. (Returns a MockEntityWithGroups object.)
Items (): Returns a table of MockEntityWithGroups items. (Returns a UnsupportedType(List of MockEntityWithGroups) 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.

Method List (internal only)

Add ( table): (Returns a MockEntityWithGroups object.)
AddDefaultEntity (): (Returns a MockEntityWithGroups object.)
CreateGroup (): (Returns a Object object.)
DeleteEntities ( List of Object)
DuplicateEntities ( List of Object): (Returns a List of Object object.)
MoveIn ( List of Object)
Replace ( MockEntityWithGroups, MockEntityWithGroups)
ShowAll ()
ShowOnly ( List of Object)
ShowOnlyInCollection ( List of Object)

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

Property Details (internal only)

Path

Type: string
Access: Read only

Collection Details (internal only)

Groups

Type: GroupCollectionOf_MockEntityWithGroups

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.

Item (index number)

Returns the MockEntityWithGroups for the given index in the collection.

Input Parameters

index(number): The index of the MockEntityWithGroups.

Return

MockEntityWithGroups: The item in the collection

Item (label string)

Returns the MockEntityWithGroups for the given label in the collection.

Input Parameters

label(string): The label of the MockEntityWithGroups.

Return

MockEntityWithGroups: The item in the collection

Items ()

Returns a table of MockEntityWithGroups items.

Return

UnsupportedType(List of MockEntityWithGroups): 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