pycatia.mec_mod_interfaces.instance_factory

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.instance_factory.InstanceFactory(com_object)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

System.IUnknown
System.IDispatch
System.CATBaseUnknown
System.CATBaseDispatch
System.AnyObject
MecModInterfaces.Factory
InstanceFactory

Represents the CATIAInstanceFactory.
Role: This interface is used to create a new instance of a shape reference
(ShapeInstance ) or a hybrid shape reference ( HybridShapeInstance ) in case of
the instantiation of a User Feature.
It is also used to instantiate a Power Copy reference.

This interface contains two protocols of instantiation:

The first protocol is dedicated to User Feature instantiation
only.
It is defined by a single method: AddInstance . It creates a shape or
hybrid shape instance depending on the result of the User
Feature.
Use this method when you want to perform only one instantiation of the
reference. Read the document containing the User Feature reference and
instantiate it.
As the document containing the reference is released from the session at
the end of the instantiation, it is not recommmended to use this method if you
want to perform several instantiations of the same reference in a
loop.
In that case, prefer the second protocol of instantiation.
The second protocol is dedicated to both User Feature and Power Copy
instantiations.
It is defined by several methods that must be called in
order.
For User Feature instantiation, these methods are an alternative way of
the AddInstance method.
It is recommended to use the second protocol to perform several
instantiations of the same reference in a loop.
For Power Copy instantiation, it is the only way of instantiating a
reference.
The instantiation process is composed of three major
steps:
The first step BeginInstanceFactory consists in initializing the
InstanceFactory with the reference and the document where it is
stored.
This step must be called once at the beginning whatever the number of
instantiations are done.
Optional step InstantiationMode allow the user to specify the mode of
the instantiation, that is to say “After” or “Inside”.
If this method is not called, the instantiation mode will be chosen
according to the BeginInstantiate method.
The second step is the instantiation itself: it is composed of five
methods that must be called in the order.
This set of five methods can be called in a loop in order to make
several instantiations.
The method BeginInstantiate is used to initialize all data of the
reference.
The method PutInputData is used to set a value to any input of the
reference.
The method GetParameter is used to retrieve any parameter of the
reference in order to modify its value.
The method Instantiate is used to duplicate the reference. It
returns the created instance when it does exist.
The method EndInstantiate is used to indicate that the
instantiation is done.
The third step EndInstanceFactory consists in ending the instantiation
and cleaning the InstanceFactory.
When doing several instantiations in a loop, this step must be called
just once at the end of all instantiations.
add_instance(i_reference: AnyObject) → AnyObject

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func AddInstance(AnyObject iReference) As AnyObject

Creates a new instance of a shape or hybrid shape.

Parameters:

iReference
The reference shape or hybrid shape.

Example:
This example creates the instance NewInstance in the
part.

Set NewInstance = instanceFactory.AddInstance(reference)
Parameters:

i_reference (AnyObject) –

Return type:

AnyObject

begin_instance_factory(i_name_of_reference: str, i_name_of_document: str) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub BeginInstanceFactory(CATBSTR iNameOfReference,
CATBSTR iNameOfDocument)

Initializes the instantiation process with the document containing the
reference.
Role: Use this method to start instantiating a reference in the current
document.
In that method, the document containing the reference is locked in
session.
It will be unlocked in the last step EndInstanceFactory .

Parameters:

iNameOfReference
The name of the reference to be instantiated.
iDocumentFileName
The name of the file containing the document where to find the
reference to be instantiated.

Example:
The following example initializes the factory with a document and a
reference:

InstanceFactory.BeginInstanceFactory”NameOfReference”,”c:tmpNameOfDocument.CATPart”
Parameters:

  • i_name_of_reference (str) –

  • i_name_of_document (str) –

Return type:

None

begin_instantiate() → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub BeginInstantiate()

Initializes the data of the reference.
Role: This is the first method of the second step of
instantiation.
It is used to initialize all data of the reference in the
factory.

Example:
The following example shows how to initialize the
factory:

InstanceFactory.BeginInstantiate
Return type:

None

end_instance_factory() → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub EndInstanceFactory()

Ends the instantiation process.
Role: Use this method to end the instantiation process.
In that method the document containing the reference is unlocked and
released from the session.

Example:
The following example shows how to end the
instantiation:

InstanceFactory.EndInstanceFactory
Return type:

None

end_instantiate() → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub EndInstantiate()

Ends the instantiation of the reference.
Role: This is the fifth and last method of the second step of
instantiation.
It is used to end the instantiation: after this step, all the links to the
reference are broken.

Example:
The following example shows how to end the
instantiation:

InstanceFactory.EndInstantiate
Return type:

None

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 AnyObject

Retrieves a parameter of the reference by its name.
Role: This is the third method of the second step of
instantiation.
This step is optional.
It is used to retrieve a parameter of the reference in order to change its
value, using the ValuateFromString method of the Parameter
interface.
It has to be called on each parameter whose value has to be
changed.

Parameters:

iName
The name of the parameter.

Example:
The following example retrieves a parameter on the
reference:

Set parameter = InstanceFactory.GetParameter(“Parameter1”)
Parameters:

i_name (str) –

Return type:

AnyObject

instantiate() → AnyObject

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func Instantiate() As AnyObject

Instantiates the reference in the current document.
Role: This is the fourth method of the second step of
instantiation.
It is used to duplicate or instantiate the data of the
reference.

In case of Power Copy instantiation, the data are duplicated and there
is no created instance.
In case of User Feature instantiation, the data are instantiated and an
instance is created and returned.

Example:
The following example instantiates the reference:

Set Instance = InstanceFactory.Instantiate
Return type:

AnyObject

property instantiation_mode: str

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property InstantiationMode(CATBSTR iInstantiationModeBSTR) (Write
Only)

Sets the mode of instantiation to “Inside” or “After”.
Role: This method should be called BEFORE the method BeginInstantiate to
take into account the desired instantiation mode.
It is used to set the destination path of insertion of the template
reference.

Example:
The following example shows how to determine the instantiation mode
(Mode’s value is “Inside” or “After”):

InstanceFactory.InstantationMode = Mode
Return type:

str

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)

Sets a value to an input of the reference.
Role: This is the second method of the second step of
instantiation.
It is used to set a value to any input of the reference.
It has to be called on each input of the reference.

Parameters:

iName
The name of the input.
iInput
The element to set as the new value of the input.
All types of

Boundary object are possibly supported.

Example:
The following example sets a value to an input of the reference: The input
is a point and its name is Input1.

InstanceFactory.PutInputData “Input1”,point1
Parameters:
Return type:

None