MockEntity

A mock domain entity object containing all the complex cases imaginable.

Example

MockDomainEntityExample script for Lua

Inheritance

The MockEntity object is derived from the Object object.

The following internal objects are derived (specialisations) from the MockEntity object:

Usage locations

The MockEntity object can be accessed from the following locations:

Property List

Label
The object label. (Read/Write string)
Type
The object type string. (Read only string)

Property List (internal only)

Boolean
(Read/Write boolean)
ChildCollection
A reference to another domain entity collection (Read/Write MockCollection)
Colour
Shared descriptive text for Colour value. (Read/Write string)
CompositeValue
A composite value on the entity (Read/Write MockCompositeValue)
CompositeValueWithRestrictedAccess
(Read/Write MockCompositeValue)
CreationMethod
The creation method (FirstCreationMethod, SecondCreationMethod) (Read/Write MockCreationMethodEnum)
CustomisableValue
A customisable value on the entity (Read/Write string)
DerivedListOfEntityPointers
(Read only List of MockEntity)
DerivedPointTable
(Read/Write table)
DerivedValueList
(Read/Write table)
DomainEntityList
(Read/Write List of Object)
DummyString
A dummy string used to test the Lua table to ValueContainer conversions (Read/Write string)
DynamicSubObject
A dynamic sub object child of this object (Read only MockSimpleDomainEntity)
EntityReference
A reference to another domain entity (Read/Write MockEntity)
Expression
Expression member (Read/Write MockParametricExpression)
FileNames
(Read only string)
FileReference
(Read/Write FileReference)
IndexList
A member list of integers (Read/Write List of number)
IndexValueList
A value list of integers (Read/Write table)
IndexValueTable
A parametric value table (Read/Write table)
LatchedCompositeValueList
(Read/Write MockCompositeValueList)
LatchedValueCount
(Read/Write number)
Length
A normal member value (Read/Write number)
ListOfReferences
A list of entity references (Read/Write ObjectReferenceList)
MockService
A dynamic sub object child of this object (Read only MockService)
MustIgnoreListOfReferences
A bool value controlling if the list of references should be ignored (Read/Write boolean)
MustIgnoreReference
A bool value controlling if the entity reference must be ignored (Read/Write boolean)
OptionalExpression
(Read/Write MockParametricExpression)
OptionalExpressionEnabled
(Read/Write boolean)
ParametricPointValueList
A value list of MockParametricExpression (Read/Write MockParametricPointList)
ParametricValueList
A parametric value list (Read/Write MockParametricExpressionList)
ParametricValueTable
A parametric value table (Read/Write MockParametricExpressionTable)
Path
(Read only string)
Point
Point member (Read/Write MockParametricPoint)
PointTable
(Read/Write MockParametricPointTable)
RangeValue
(Read/Write number)
ReferenceValueTable
(Read/Write ObjectReferenceTable)
SingletonSubObject
A single sub object child of this object (Read only MockSimpleDomainEntity)
StringExpressionMap
(Read/Write Map)
TotalLength
A derived value that is equal to the length (Read only number)
ValueWithRestrictedAccess
(Read/Write number)
Workplane
Workplane member (Read/Write MockParametricWorkplane)

Collection List (internal only)

SubObjects
A collection of a sub objects that this object owns (MockCollection of MockEntity.)
SubObjects2
(MockCollection of MockEntity.)

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.

Method List (internal only)

CreateNestedHierarchy ( number)
Creates a nested hierarchy (Returns a List of MockEntity object.)
DeleteProcess ()
Process deletes a MockDomainEntity
DuplicateProcess ()
Process duplicates a MockDomainEntity
Execute ()
LoadProcess ( string)
Process loads a file.
ProcessNoArgs ()
Process that checks if two parameter sequences are equal length and all lengths are 10
ProcessWithArgs (Arg1 List of MockEntity, Arg2 List of MockEntity)
Process that checks if two parameter sequences are equal length and all lengths are 10 (Returns a List of MockEntity object.)
SaveProcess ( string)
Process saves a file
SetMap ( Map)
UndoProcess ()
Undo the last process

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

Property Details (internal only)

Boolean
Type
boolean
Access
Read/Write
ChildCollection
A reference to another domain entity collection
Type
MockCollection
Access
Read/Write
Colour
Shared descriptive text for Colour value.
Type
string
Access
Read/Write
CompositeValue
A composite value on the entity
Type
MockCompositeValue
Access
Read/Write
CompositeValueWithRestrictedAccess
Type
MockCompositeValue
Access
Read/Write
CreationMethod
The creation method (FirstCreationMethod, SecondCreationMethod)
Type
MockCreationMethodEnum
Access
Read/Write
CustomisableValue
A customisable value on the entity
Type
string
Access
Read/Write
DerivedListOfEntityPointers
Access
Read only
DerivedPointTable
Type
table
Access
Read/Write
DerivedValueList
Type
table
Access
Read/Write
DomainEntityList
Access
Read/Write
DummyString
A dummy string used to test the Lua table to ValueContainer conversions
Type
string
Access
Read/Write
DynamicSubObject
A dynamic sub object child of this object
Type
MockSimpleDomainEntity
Access
Read only
EntityReference
A reference to another domain entity
Type
MockEntity
Access
Read/Write
Expression
Expression member
Type
MockParametricExpression
Access
Read/Write
FileNames
Type
string
Access
Read only
FileReference
Type
FileReference
Access
Read/Write
IndexList
A member list of integers
Access
Read/Write
IndexValueList
A value list of integers
Type
table
Access
Read/Write
IndexValueTable
A parametric value table
Type
table
Access
Read/Write
LatchedCompositeValueList
Type
MockCompositeValueList
Access
Read/Write
LatchedValueCount
Type
number
Access
Read/Write
Length
A normal member value
Type
number
Access
Read/Write
ListOfReferences
A list of entity references
Type
ObjectReferenceList
Access
Read/Write
MockService
A dynamic sub object child of this object
Type
MockService
Access
Read only
MustIgnoreListOfReferences
A bool value controlling if the list of references should be ignored
Type
boolean
Access
Read/Write
MustIgnoreReference
A bool value controlling if the entity reference must be ignored
Type
boolean
Access
Read/Write
OptionalExpression
Type
MockParametricExpression
Access
Read/Write
OptionalExpressionEnabled
Type
boolean
Access
Read/Write
ParametricPointValueList
A value list of MockParametricExpression
Type
MockParametricPointList
Access
Read/Write
ParametricValueList
A parametric value list
Type
MockParametricExpressionList
Access
Read/Write
ParametricValueTable
A parametric value table
Type
MockParametricExpressionTable
Access
Read/Write
Path
Type
string
Access
Read only
Point
Point member
Type
MockParametricPoint
Access
Read/Write
PointTable
Type
MockParametricPointTable
Access
Read/Write
RangeValue
Type
number
Access
Read/Write
ReferenceValueTable
Type
ObjectReferenceTable
Access
Read/Write
SingletonSubObject
A single sub object child of this object
Type
MockSimpleDomainEntity
Access
Read only
StringExpressionMap
Type
Map
Access
Read/Write
TotalLength
A derived value that is equal to the length
Type
number
Access
Read only
ValueWithRestrictedAccess
Type
number
Access
Read/Write
Workplane
Workplane member
Type
MockParametricWorkplane
Access
Read/Write

Collection Details (internal only)

SubObjects
A collection of a sub objects that this object owns
Type
MockCollection
SubObjects2
Type
MockCollection

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.

Method Details (internal only)

CreateNestedHierarchy ( number)
Creates a nested hierarchy
Input Parameters
(number)
Return
List of MockEntity
DeleteProcess ()
Process deletes a MockDomainEntity
DuplicateProcess ()
Process duplicates a MockDomainEntity
Execute ()
LoadProcess ( string)
Process loads a file.
Input Parameters
(string)
ProcessNoArgs ()
Process that checks if two parameter sequences are equal length and all lengths are 10
ProcessWithArgs (Arg1 List of MockEntity, Arg2 List of MockEntity)
Process that checks if two parameter sequences are equal length and all lengths are 10
Input Parameters
Arg1(List of MockEntity)
Arg1 Lua description.
Arg2(List of MockEntity)
Arg2 Lua description.
Return
List of MockEntity
Lua return description for process.
SaveProcess ( string)
Process saves a file
Input Parameters
(string)
SetMap ( Map)
Input Parameters
(Map)
UndoProcess ()
Undo the last process

Static Function Details

GetDefaultProperties ()
Creates a table containing the default settings to create an object.
Return
table
A table containing the default properties.