 | ReferenceModelObject Class |
The ReferenceModelObject class contains methods related to reference model objects.
A reference model object is a subobject of a reference model.
Inheritance HierarchySystemObject
Tekla.Structures.ModelObject
Tekla.Structures.ModelModelObject
Tekla.Structures.ModelReferenceModelObject
Tekla.Structures.ModelObject
Tekla.Structures.ModelModelObject
Tekla.Structures.ModelReferenceModelObject
Namespace: Tekla.Structures.Model
Assembly: Tekla.Structures.Model (in Tekla.Structures.Model.dll) Version: 2023.0.1
SyntaxThe ReferenceModelObject type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ReferenceModelObject |
Creates a new reference model object instance.
|
| ReferenceModelObject(Int32, Identifier) |
Creates a new reference model object instance using the given parameters.
|
Properties| Name | Description | |
|---|---|---|
 | Identifier |
The identifier of the object.
(Inherited from Object.) |
| IsUpToDate | Gets if the object does not have a modification which is not shared. (Inherited from ModelObject.) |
| ModificationTime | Gets latest time of the object was modified or created. (Inherited from ModelObject.) |
Methods| Name | Description | |
|---|---|---|
| CompareTo |
Compares Identifiers of model objects.
(Inherited from ModelObject.) |
| Delete |
At the moment reference objects cannot be deleted.
(Overrides ModelObjectDelete.) |
| Equals |
Check if Identifiers of model objects are same.
(Inherited from ModelObject.) |
 | GetAllReportProperties |
Retrieves all properties for the model object in one hashtable.
Type for the returned value must be checked using type casting.
(Inherited from ModelObject.) |
| GetAllUserProperties |
Retrieves all properties for the model object in one hashtable.
Type for the returned value must be checked using type casting.
(Inherited from ModelObject.) |
| GetChildren |
Returns an enumerator of all the children model objects.
(Inherited from ModelObject.) |
| GetCoordinateSystem |
Returns the coordinate system for the given model object.
(Inherited from ModelObject.) |
| GetDoubleReportProperties |
Retrieves multiple double report properties for the model object. It is faster
to fetch multiple properties at once.
(Inherited from ModelObject.) |
| GetDoubleUserProperties |
Retrieves all double properties for the model object.
(Inherited from ModelObject.) |
| GetDynamicStringProperty |
Gets a dynamic string property from the model object.
(Inherited from ModelObject.) |
| GetFather |
Returns the reference hierarchy father.
|
| GetFatherComponent |
Returns the father component of the model object.
(Inherited from ModelObject.) |
| GetHierarchicObjects |
Returns an enumerator of all the connected hierarchic objects.
(Inherited from ModelObject.) |
| GetIntegerReportProperties |
Retrieves multiple integer report properties for the model object. It is faster
to fetch multiple properties at once.
(Inherited from ModelObject.) |
| GetIntegerUserProperties |
Retrieves all integer properties for the model object.
(Inherited from ModelObject.) |
| GetPhase |
Retrieves the phase of the model object (the phase number, the phase name,
the phase comment and whether the phase is the current one or not).
(Inherited from ModelObject.) |
| GetReferenceModel |
Gets the reference model that the reference object belongs to.
|
| GetReportProperty(String, Double) |
Retrieves a double property of the report for the model object.
(Inherited from ModelObject.) |
| GetReportProperty(String, Int32) |
Retrieves an integer property of the report for the model object.
(Inherited from ModelObject.) |
| GetReportProperty(String, String) |
Retrieves a string property of the report for the model object.
(Inherited from ModelObject.) |
| GetStringReportProperties |
Retrieves multiple string report properties for the model object. It is faster
to fetch multiple properties at once.
(Inherited from ModelObject.) |
| GetStringUserProperties |
Retrieves all string properties for the model object.
(Inherited from ModelObject.) |
| GetUserProperty(String, Double) |
Retrieves a double property for the model object.
(Inherited from ModelObject.) |
| GetUserProperty(String, Int32) |
Retrieves an integer property for the model object.
(Inherited from ModelObject.) |
| GetUserProperty(String, String) |
Retrieves a string property for the model object.
(Inherited from ModelObject.) |
| Insert |
At the moment reference objects cannot be inserted.
(Overrides ModelObjectInsert.) |
| Modify |
At the moment reference objects cannot be modified.
(Overrides ModelObjectModify.) |
| Select |
Selects the reference model with the given identifier.
(Overrides ModelObjectSelect.) |
| SetDynamicStringProperty |
Sets a dynamic string property for the model object.
(Inherited from ModelObject.) |
| SetLabel |
Sets a label for an object when a new instance is created, this method must be called before Insert.
The label is used in plug-ins for identifying the changed object in modification.
(Inherited from ModelObject.) |
| SetPhase |
Sets the phase of the model object.
(Inherited from ModelObject.) |
| SetUserProperties |
Sets multiple properties for the model object.
(Inherited from ModelObject.) |
| SetUserProperty(String, Double) |
Sets a double property for the model object.
(Inherited from ModelObject.) |
| SetUserProperty(String, Int32) |
Sets an integer property for the model object.
(Inherited from ModelObject.) |
| SetUserProperty(String, String) |
Sets a string property for the model object.
(Inherited from ModelObject.) |
See Also