pycatia.mec_mod_interfaces.shape_instance¶
Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445
Warning
The notes denoted “CAA V5 Visual Basic Help” are to be used as reference only. They are there as a guide as to how the visual basic / catscript functions work and thus help debugging in pycatia.
- class pycatia.mec_mod_interfaces.shape_instance.ShapeInstance(com_object)¶
Note
CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
System.IUnknownSystem.IDispatchSystem.CATBaseUnknownSystem.CATBaseDispatchSystem.AnyObjectMecModInterfaces.ShapeShapeInstanceThe interface to access a CATIAShapeInstance.- get_input(i_name: str) AnyObject ¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
- o Func GetInput(CATBSTR iName) As AnyObjectGets an input of a shape instance by its name.Parameters:iNameThe name of the input of the shape instanceReturns:The input, if foundExample:The following example tests if the input was found:Set input = shapeInstance.GetInput(“Input1”)If TypeName(input)=”Nothing” ThenMsgBox “Input not found”End If
- Parameters:
i_name (str) –
- Return type:
- get_input_data(i_name: str) AnyObject ¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
- o Func GetInputData(CATBSTR iName) As CATBaseDispatchGets an input of a shape instance by its name. Use this method if you wantto retrieve a Reference.Parameters:iNameThe name of the input of the shape instanceReturns:The input, if foundExample:The following example tests if the input was found:Set input = shapeInstance.GetInput(“Input1”)If TypeName(input)=”Nothing” ThenMsgBox “Input not found”End If
- Parameters:
i_name (str) –
- Return type:
- get_input_data_from_position(i_position: int) AnyObject ¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
- o Func GetInputDataFromPosition(long iPosition) AsCATBaseDispatchGets an input of a hybrid shape instance from its position. Use this methodif you want to retrieve a Reference.Parameters:iPositionThe positionReturns:The input, if foundExample:The following example tests if the input was found:Set input = hybridShapeInstance.GetInputFromPosition(2)If TypeName(input)=”Nothing” ThenMsgBox “Input not found”End If
- Parameters:
i_position (int) –
- Return type:
- get_input_from_position(i_position: int) AnyObject ¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
- o Func GetInputFromPosition(long iPosition) As AnyObjectGets an input of a hybrid shape instance from itsposition.Parameters:iPositionThe positionReturns:The input, if foundExample:The following example tests if the input was found:Set input = hybridShapeInstance.GetInputFromPosition(2)If TypeName(input)=”Nothing” ThenMsgBox “Input not found”End If
- Parameters:
i_position (int) –
- Return type:
- get_output(i_name: str) AnyObject ¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
- o Func GetOutput(CATBSTR iName) As AnyObjectGets a Ouput by its name.Parameters:iNameThe name of the output of the shape instanceReturns:The output, if foundExample:The following example tests if the output was found:Set output = shapeInstance.GetOuput(“Output1”)If TypeName(output)=”Nothing” ThenMsgBox “Output not found”End If
- Parameters:
i_name (str) –
- Return type:
- get_output_from_position(i_position: int) AnyObject ¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
- o Func GetOutputFromPosition(long iPosition) As AnyObjectGets a Ouput from its position.Parameters:iPositionThe positionReturns:The output, if foundExample:The following example tests if the output was found:Set output = shapeInstance.GetOuputFromPosition(2)If TypeName(output)=”Nothing” ThenMsgBox “Output not found”End If
- Parameters:
i_position (int) –
- Return type:
- get_parameter(i_name: str) AnyObject ¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
- o Func GetParameter(CATBSTR iName) As AnyObjectGets a parameter of a shape instance by its name.Parameters:iNameThe name of the parameter of the shape instanceReturns:The parameter, if foundExample:The following example tests if the parameter wasfound:Set parameter = shapeInstance.GetParameter(“Parameter1”)If TypeName(parameter)=”Nothing” ThenMsgBox “Parameter not found”End If
- Parameters:
i_name (str) –
- Return type:
- get_parameter_from_position(i_position: int) AnyObject ¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
- o Func GetParameterFromPosition(long iPosition) As AnyObjectGets a parameter of a hybrid shape instance from itsposition.Parameters:iPositionThe positionReturns:The parameter, if foundExample:The following example tests if the parameter wasfound:Set parameter = hybridShapeInstance.GetParameterFromPosition(2)If TypeName(input)=”Nothing” ThenMsgBox “Parameter not found”End If
- Parameters:
i_position (int) –
- Return type:
- property inputs_count: int¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
- o Property InputsCount() As long (Read Only)Returns the number of Inputs.Example:The following example retrieves in inputsCount the number of Inputs ofhybridShapeInstance:inputsCount = hybridShapeInstance.InputsCount
- Return type:
int
- property outputs_count: int¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
- o Property OutputsCount() As long (Read Only)Returns the number of Outputs.Example:The following example retrieves in outputsCount the number of Outputsof hybridShapeInstance:outputsCount = hybridShapeInstance.OutputsCount
- Return type:
int
- property parameters_count: int¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
- o Property ParametersCount() As long (Read Only)Returns the number of Parameters.Example:The following example retrieves in parametersCount the number ofparameters of hybridShapeInstance:parametersCount = hybridShapeInstance.ParametersCount
- Return type:
int
- put_input(i_name: str, i_input: AnyObject) None ¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
- o Sub PutInput(CATBSTR iName,AnyObject iInput)Defines an input of a shape instance.Parameters:iNameThe input nameiInputThe element wich will be input of the shapeinstanceAll types ofBoundary object are possibly supported.Example:The following example defines the input of a shape instance The inputwill be a point and its name will be Input1.shapeInstance.PutInput “Input1”,point
- Parameters:
i_name (str) –
i_input (AnyObject) –
- Return type:
None
- put_input_data(i_name: str, i_input: AnyObject) None ¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
- o Sub PutInputData(CATBSTR iName,CATBaseDispatch iInput)Defines an input of a shape instance. Use this method if you want to set asinput a Reference.Parameters:iNameThe input nameiInputThe element wich will be input of the shapeinstanceAll types ofBoundary object are possibly supported.Example:The following example defines the input of a shape instance The inputwill be a point and its name will be Input1.shapeInstance.PutInput “Input1”,point
- Parameters:
i_name (str) –
i_input (AnyObject) –
- Return type:
None