Connectors Parameters
Functions Introduced:
Each connector contains a set of entry ports to which cables can be connected. Each entry port is modeled by a coordinate system datum that belongs to the part that models the connector. The function
ProConnectorEntryPortsGet() returns a
ProArray of datum coordinate systems representing the entry ports in the specified connector. The connector is identified by its component path (its
memb_id_tab).
The function
ProConnectorParamsCollect() provides an array of the user parameters for the connector. However, this array contains only single-valued parameters that refer to the connector itself, not the parameters that describe the entry ports.
To access parameters on the connector entry ports, you must call the function
ProOutputFileMdlnameWrite() with the option
PRO_CONNECTOR_PARAMS_FILE. This writes a text file to disk, which is the same format as the file you edit when using the
ProCable command
Connector,
Modify Parameters,
Mod Param.
The following example shows a sample connector parameters file. Refer to the Creo Parametric Cabling Help on the parameters.
The function
ProConnectorRefModelNameGet() retrieves the reference model name of the specified cable connector. The function returns the output argument
p_ref_model_name as a
wchar_t* string.
Use the function
ProCableCurvesGet() to retrieve the trajectory entities for the specified feature. The input arguments are:
• cbl_feat—Specify the cable for which the ProCurves is returned using the object ProCable.
• inc_bundle—Returns the ProCurve function for the bundles through which the cable is passed using the ProBoolean object.
The output argument p_curves is a ProArray of the curves.
The function
ProCablingConnectorEntryPortsGet() gets the entry ports for the specified connector. The input arguments are:
• solid—Specifies the handle to the harness assembly or part using the ProSolid object. This argument can be NULL.
• p_connector—Specifies the handle of the connector using the ProConnector object.
The output argument p_csys_array is a ProArray of csys. The function allocates memory for this argument, and the user must free the allocated memory using ProArrayFree().
Use the function
ProCablingAsmcompIsConnector() to check if the component is a cabling connector. The input arguments are:
• solid—Specifies the handle to the harness assembly or part using the ProSolid object. This argument can be NULL.
• p_comp—Specifies the component using the ProAsmcomppath object.
The output argument p_is_connector is set to TRUE when the component is a cabling connector.
The function
ProCablingConnectorParamGet() gets a parameter of the cabling connector. The input arguments are:
• solid—Specifies the handle to the harness assembly or part using the ProSolid object. This argument can be NULL.
• p_connector—Specifies the handle of the connector using the ProConnector object.
• w_param_name—Specifies the name of the parameter using a ProName object.
The output argument to the function p_param is the parameter handle using the ProCableparam object.
The function
ProCablingConnectorParamsCollect() retrieves parameters of specified connector. The input arguments are:
• solid—Specifies the handle to the harness assembly or part using the ProSolid object. This argument can be NULL.
• p_connector—Specifies the handle of the connector using the ProConnector object.
The output argument p_params is a pointer to ProArray of parameters. The function allocates memory for these arguments and you can free it by calling the ProArrayFree function.
The function
ProCablingConnectorParamDelete() deletes parameter of specified connector. The input arguments are:
• solid—Specifies the handle to the harness assembly or part using the ProSolid object. This argument can be NULL.
• p_connector—Specifies the handle of the connector using the ProConnector object.
• w_param_name—Specifies the name of the parameter using a ProName object.
The function
ProCablingConnectorParamsSet() sets parameters of specified connector. The input arguments are:
• solid—Specifies the handle to the harness assembly or part using the ProSolid object. This argument can be NULL.
• p_connector—Specifies the handle of the connector using the ProConnector object.
• params—Specifies the new parameters using ProCableparam object.
The function
ProCablingConnectorDesignate() designates the specified component as an assembly connector with all the logical parameters. The input arguments are:
• solid—Specifies the handle to the harness assembly or part using the ProSolid object. This argument can be NULL.
• p_connector—Specifies the handle of the connector to designate using the ProConnector object.
• name—Specifies the name of the reference designator. It can be NULL when the designation is not from logical reference.
• from_logical—Set to PRO_B_TRUE for designation from a logical reference, or PRO_B_FALSE for default designation.
The function
ProCablingCsysFromCableDataObjectGet() gets the original connector csys based on the Cable Data Object csys. The input argument
cdo_ref_csys is the handle to the csys on the Cable Data Object using the
ProModelitem object. The output arguments are:
• p_conn_item_path—Path to the connector that contains the coordinate system using the ProAsmcomppath object.
• p_conn_csys—The original connector coordinate system using the ProModelitem object.
The function
ProCablingCompTypeGet() gets the cabling type of a feature component. The input argument
pro_feat is the handle to the feature using the
ProFeature object. The output argument
p_type is type of the feature using
ProCableCompType object.
Use the function
ProCableDataObjectCreate() to create a new Cable Data Object in the specified harness. The input argument
harness is the handle to the feature represented by the
ProHarness object.