|
OpenCMISS-Iron Python Bindings API Documentation
|
|
OpenCMISS-Iron Python Bindings API Documentation
|
Public Member Functions | |
| def | __init__ (self) |
| def | CreateCellMLToFieldMap (self, CellMLModelUserNumber, variableID, CellMLParameterSet, field, variableType, componentNumber, fieldParameterSet) |
| def | CreateFieldToCellMLMap (self, field, variableType, componentNumber, fieldParameterSet, CellMLModelUserNumber, variableID, CellMLParameterSet) |
| def | CreateFinish (self) |
| def | CreateStart (self, CellMLUserNumber, region) |
| def | Destroy (self) |
| def | FieldComponentGet (self, CellMLModelUserNumber, CellMLFieldType, variableID) |
| def | FieldMapsCreateFinish (self) |
| def | FieldMapsCreateStart (self) |
| def | Finalise (self) |
| def | Generate (self) |
| def | IntermediateFieldCreateFinish (self) |
| def | IntermediateFieldCreateStart (self, CellMLIntermediateFieldUserNumber, field) |
| def | IntermediateFieldGet (self, field) |
| def | ModelImport (self, URI) |
| def | ModelsFieldCreateFinish (self) |
| def | ModelsFieldCreateStart (self, CellMLModelsFieldUserNumber, field) |
| def | ModelsFieldGet (self, field) |
| def | ParametersFieldCreateFinish (self) |
| def | ParametersFieldCreateStart (self, CellMLParametersFieldUserNumber, field) |
| def | ParametersFieldGet (self, field) |
| def | StateFieldCreateFinish (self) |
| def | StateFieldCreateStart (self, CellMLStateFieldUserNumber, field) |
| def | StateFieldGet (self, field) |
| def | VariableSetAsKnown (self, CellMLModelUserNumber, variableID) |
| def | VariableSetAsWanted (self, CellMLModelUserNumber, variableID) |
Public Attributes | |
| cmiss_type | |
Properties | |
| modelsField = property(ModelsFieldGet, None, None, ) | |
| parametersField = property(ParametersFieldGet, None, None, ) | |
| intermediateField = property(IntermediateFieldGet, None, None, ) | |
| stateField = property(StateFieldGet, None, None, ) | |
| def iron.CellML.__init__ | ( | self | ) |
| def iron.CellML.CreateCellMLToFieldMap | ( | self, | |
| CellMLModelUserNumber, | |||
| variableID, | |||
| CellMLParameterSet, | |||
| field, | |||
| variableType, | |||
| componentNumber, | |||
| fieldParameterSet | |||
| ) |
Defines a CellML model variable to field variable component map by object. :param CellMLModelUserNumber: The user number of the CellML model to map from. :type CellMLModelUserNumber: int :param variableID: The of the CellML variable in the given model to map from. :type variableID: string :param CellMLParameterSet: The CellML variable parameter set to map from. :type CellMLParameterSet: int :param field: The field to map to. :type field: Field :param variableType: The field variable type to map to. :type variableType: int :param componentNumber: The field variable component number to. :type componentNumber: int :param fieldParameterSet: The field variable parameter set to map to. :type fieldParameterSet: int :rtype: None
| def iron.CellML.CreateFieldToCellMLMap | ( | self, | |
| field, | |||
| variableType, | |||
| componentNumber, | |||
| fieldParameterSet, | |||
| CellMLModelUserNumber, | |||
| variableID, | |||
| CellMLParameterSet | |||
| ) |
Defines a field variable component to CellML model variable map by object. :param field: The field to map from. :type field: Field :param variableType: The field variable to map from. :type variableType: int :param componentNumber: The component number to map from the given field variable. :type componentNumber: int :param fieldParameterSet: The field variable parameter set to map from. :type fieldParameterSet: int :param CellMLModelUserNumber: The user number of the CellML model to map to. :type CellMLModelUserNumber: int :param variableID: The of the CellML variable in the given model to map to. :type variableID: string :param CellMLParameterSet: The CellML variable parameter set to map to. :type CellMLParameterSet: int :rtype: None
| def iron.CellML.CreateFinish | ( | self | ) |
| def iron.CellML.CreateStart | ( | self, | |
| CellMLUserNumber, | |||
| region | |||
| ) |
Start the creation of a CellML environment identified by an object. :param CellMLUserNumber: The user number of the CellML enviroment to start creating. :type CellMLUserNumber: int :param region: The region containing the field to start the CellML enviroment creation on. :type region: Region :rtype: None
| def iron.CellML.Destroy | ( | self | ) |
| def iron.CellML.FieldComponentGet | ( | self, | |
| CellMLModelUserNumber, | |||
| CellMLFieldType, | |||
| variableID | |||
| ) |
Returns the field component number that corresponds to a character string variable ID for a CellML environment identified by an object. :param CellMLModelUserNumber: The user number of the CellML model to map from. :type CellMLModelUserNumber: int :param CellMLFieldType: The type of CellML field to get the component for. Must be a value from the CellMLFieldTypes enum. :type CellMLFieldType: int :param variableID: The ID to get the corresponding field component for. :type variableID: string :returns: fieldComponent. The field component corresponding to the ID. :rtype: int
| def iron.CellML.FieldMapsCreateFinish | ( | self | ) |
| def iron.CellML.FieldMapsCreateStart | ( | self | ) |
| def iron.CellML.Finalise | ( | self | ) |
| def iron.CellML.Generate | ( | self | ) |
| def iron.CellML.IntermediateFieldCreateFinish | ( | self | ) |
| def iron.CellML.IntermediateFieldCreateStart | ( | self, | |
| CellMLIntermediateFieldUserNumber, | |||
| field | |||
| ) |
Start the creation of CellML intermediate field for a CellML environment identified by an object. :param CellMLIntermediateFieldUserNumber: The user number of the CellML intermediate field to start creating. :type CellMLIntermediateFieldUserNumber: int :param field: On return, the created CellML intermediate field. :type field: Field :rtype: None
| def iron.CellML.IntermediateFieldGet | ( | self, | |
| field | |||
| ) |
| def iron.CellML.ModelImport | ( | self, | |
| URI | |||
| ) |
| def iron.CellML.ModelsFieldCreateFinish | ( | self | ) |
| def iron.CellML.ModelsFieldCreateStart | ( | self, | |
| CellMLModelsFieldUserNumber, | |||
| field | |||
| ) |
Start the creation of CellML models field for a CellML environment identified by an object. :param CellMLModelsFieldUserNumber: The user number of the CellML models field to start creating. :type CellMLModelsFieldUserNumber: int :param field: On return, the created CellML models field. :type field: Field :rtype: None
| def iron.CellML.ModelsFieldGet | ( | self, | |
| field | |||
| ) |
| def iron.CellML.ParametersFieldCreateFinish | ( | self | ) |
| def iron.CellML.ParametersFieldCreateStart | ( | self, | |
| CellMLParametersFieldUserNumber, | |||
| field | |||
| ) |
Start the creation of CellML parameters field for a CellML environment identified by an object. :param CellMLParametersFieldUserNumber: The user number of the CellML parameters field to start creating. :type CellMLParametersFieldUserNumber: int :param field: On return, the created CellML parameters field. :type field: Field :rtype: None
| def iron.CellML.ParametersFieldGet | ( | self, | |
| field | |||
| ) |
| def iron.CellML.StateFieldCreateFinish | ( | self | ) |
| def iron.CellML.StateFieldCreateStart | ( | self, | |
| CellMLStateFieldUserNumber, | |||
| field | |||
| ) |
Start the creation of CellML state field for a CellML environment identified by an object. :param CellMLStateFieldUserNumber: The user number of the CellML state field to start creating. :type CellMLStateFieldUserNumber: int :param field: On return, the created CellML state field. :type field: Field :rtype: None
| def iron.CellML.StateFieldGet | ( | self, | |
| field | |||
| ) |
| def iron.CellML.VariableSetAsKnown | ( | self, | |
| CellMLModelUserNumber, | |||
| variableID | |||
| ) |
Sets a CellML model variable to be known by object. :param CellMLModelUserNumber: The user number of the CellML model in which to find the given variable. :type CellMLModelUserNumber: int :param variableID: The CellML variable to set as known (in the format 'component_name/variable_name'). :type variableID: string :rtype: None
| def iron.CellML.VariableSetAsWanted | ( | self, | |
| CellMLModelUserNumber, | |||
| variableID | |||
| ) |
Sets a CellML model variable to be wanted by object. :param CellMLModelUserNumber: The user number of the CellML model in which to find the given variable. :type CellMLModelUserNumber: int :param variableID: The CellML variable to set as wanted (in the format 'component_name/variable_name'). :type variableID: string :rtype: None
|
static |
|
static |
|
static |
|
static |
1.8.11 
