ICimEntity::ID

Use this property to get the ID of an entity. Using this ID you can reach the specific entity by calling the function IModel::GetEntityById.

Compatibility

Cimatron 2024 or later

Syntax

int Id {get;};

ID: int

Return Type

Return: int

pVal—Gives Pid value

Input Type

Input: None

Remarks

None 

Example

You must have a Cimatron file open to use this example.

//Example 1
 // PREREQUISITES
 // 1. Open a Cimatron File
 
 // Define an AppAccess object to get the running active application
 interop.CimAppAccess.AppAccess AppAcc = new interop.CimAppAccess.AppAccess();
 // Define an Application object and getting running active application
 interop.CimatronE.IApplication CimApp =(interop.CimatronE.IApplication)AppAcc.GetApplication();
 //Get Active Cimatron Document
 interop.CimBaseAPI.ICimDocument aDOC = (interop.CimBaseAPI.ICimDocument)CimApp.GetActiveDoc();
  //Get Model Container
  interop.CimMdlrAPI.IModelContainer aModelCont = (interop.CimMdlrAPI.IModelContainer)aDOC;
 //Get Model
 interop.CimMdlrAPI.MdlrModel aMdlrModel = (interop.CimMdlrAPI.MdlrModel)aModelCont.Model;
 interop.CimMdlrAPI.IModel aModel = (interop.CimMdlrAPI.IModel)aMdlrModel;
 Console.WriteLine("Enter an Entity PID: ");
 string aPIDstr = Console.ReadLine();
 int aPID = int.Parse(aPIDstr);
 interop.CimBaseAPI.ICimEntity aEnt = (interop.CimBaseAPI.ICimEntity) aModel.GetEntityById(aPID, aModel);
 if (aEnt == null)
 {
     Console.WriteLine("Enitity with given PID does Not Exists");
     return;
 }
 
 int aID2 = aEnt.ID;
 Console.WriteLine("Entity ID read via ICimEntity Instance: " + aID2); 
 
 
==========================
//Example 2
 // PREREQUISITES
 // 1. Open a Cimatron File
 
 // Define an AppAccess object to get the running active application
 interop.CimAppAccess.AppAccess AppAcc = new interop.CimAppAccess.AppAccess();
 // Define an Application object and getting running active application
 interop.CimatronE.IApplication CimApp =(interop.CimatronE.IApplication)AppAcc.GetApplication();
 //Get Active Cimatron Document
 interop.CimBaseAPI.ICimDocument aDOC = (interop.CimBaseAPI.ICimDocument)CimApp.GetActiveDoc();
  //Get Model Container
  interop.CimMdlrAPI.IModelContainer aModelCont = (interop.CimMdlrAPI.IModelContainer)aDOC;
 //Get Model
 interop.CimMdlrAPI.MdlrModel aMdlrModel = (interop.CimMdlrAPI.MdlrModel)aModelCont.Model;
 interop.CimMdlrAPI.IModel aModel = (interop.CimMdlrAPI.IModel)aMdlrModel;
 Console.WriteLine("Enter an Entity PID: ");
 string aPIDstr = Console.ReadLine();
 int aPID = int.Parse(aPIDstr);
 interop.CimBaseAPI.ICimEntity aEnt = (interop.CimBaseAPI.ICimEntity) aModel.GetEntityById(aPID, aModel);
 if (aEnt == null)
 {
     Console.WriteLine("Enitity with given PID does Not Exists");
     return;
 }
 
 int aID2 = aEnt.ID;
 Console.WriteLine("Entity ID read via ICimEntity Instance: " + aID2);

#Example 1
 
 # PREREQUISITES
 # 1. Open a Cimatron File
 import clr
 
 clr.AddReference("interop.CimAppAccess")
 clr.AddReference("interop.CimatronE")
 clr.AddReference("interop.CimServicesAPI")
 clr.AddReference("interop.CimBaseAPI")
 clr.AddReference("interop.CimMdlrAPI")
 
 #importing modules from interop dlls
 import interop.CimAppAccess
 import interop.CimatronE
 import interop.CimServicesAPI
 import interop.CimBaseAPI
 import interop.CimMdlrAPI
 
 AppAcc = interop.CimAppAccess.AppAccess()
 # Define an Application object and getting running active application
 CimApp = interop.CimatronE.IApplication(AppAcc.GetApplication())
 # Get Active Cimatron Document
 aDOC = interop.CimBaseAPI.ICimDocument(CimApp.GetActiveDoc())
 # Get Model Container
 aModelCont = interop.CimMdlrAPI.IModelContainer(aDOC)
 # Get Model
 aMdlrModel = interop.CimMdlrAPI.MdlrModel(aModelCont.Model)
 aModel = interop.CimMdlrAPI.IModel(aMdlrModel)
 print("Enter an Entity PID:")
 aPID = int(input())
 # Getting Entity of given PID
 aEnt = interop.CimBaseAPI.ICimEntity(aModel.GetEntityById(aPID, aModel))
 
 aID2 = aEnt.ID
 print("Entity ID read via ICimEntity Instance: " + str(aID2))
 
 
#==========================
#Example 2
 
 # PREREQUISITES
 # 1. Open a Cimatron File
 import clr
 
 clr.AddReference("interop.CimAppAccess")
 clr.AddReference("interop.CimatronE")
 clr.AddReference("interop.CimServicesAPI")
 clr.AddReference("interop.CimBaseAPI")
 clr.AddReference("interop.CimMdlrAPI")
 
 #importing modules from interop dlls
 import interop.CimAppAccess
 import interop.CimatronE
 import interop.CimServicesAPI
 import interop.CimBaseAPI
 import interop.CimMdlrAPI
 
 AppAcc = interop.CimAppAccess.AppAccess()
 # Define an Application object and getting running active application
 CimApp = interop.CimatronE.IApplication(AppAcc.GetApplication())
 # Get Active Cimatron Document
 aDOC = interop.CimBaseAPI.ICimDocument(CimApp.GetActiveDoc())
 # Get Model Container
 aModelCont = interop.CimMdlrAPI.IModelContainer(aDOC)
 # Get Model
 aMdlrModel = interop.CimMdlrAPI.MdlrModel(aModelCont.Model)
 aModel = interop.CimMdlrAPI.IModel(aMdlrModel)
 print("Enter an Entity PID:")
 aPID = int(input())
 # Getting Entity of given PID
 aEnt = interop.CimBaseAPI.ICimEntity(aModel.GetEntityById(aPID, aModel))
 
 aID2 = aEnt.ID
 print("Entity ID read via ICimEntity Instance: " + str(aID2))