CATFmtToolsInterfaces Interface CATFmtPath
Usage: you must use this class as is. You should never derive it.
interface CATFmtPath
Interface to manage a Path in the product structure.
It it used to manage selections and model pointers to objects
located in other representations in the product structure.
Role: This class is used to obtain all informations related to the pointed object
and provide informations on the target of selection.
- See also:
- ,
Method Index
- o
BuildPathElement(CATPathElement*)
- Build a path element from a Path.
- o
Clone(CATBaseUnknown*)
- Create a copy of the Path.
- o
ConcatenateWith(CATFmtPath*)
- Concatenates with another Path.
- o
GetObjectInContext(int)
- Return the object in context corresponding the Path.
- o
GetRepInstance()
- Returns the Rep instance of the Path.
- o
GetTarget()
-
- o
GetTransformation(CATMathTransformation&)
- Return the transformation corresponding to the Path to the target object
- o
HasPathIncludedIn(CATFmtPath*)
- Checks if current Path is included in another one.
- o
IsEmpty(int)
- Test if the Path is valuated.
- o
IsInSameRep(CATFmtPath*)
- Checks if both Paths are in the same representation
- o
IsSame(CATFmtPath*)
- Checks if both Paths are identical
- o
SetAutoLoadingMode(int)
- Manage the automatic loading of the target if necessary, see
- o
TruncateWith(CATFmtPath*)
- Truncate the curent Path with another one.
- o
UpdateTarget(CATBaseUnknown*)
- Update the target of the Path.
Methods
o BuildPathElement
| public virtual BuildPathElement( | | iHeader) |
-
Build a path element from a Path.
- Parameters:
-
- iHeader
- Optional path element to be concatened in front of the return path element.
- Returns:
- An CATPathElement to the target object.
o Clone
| public virtual Clone( | | iTarget | = NULL ) |
-
Create a copy of the Path.
- Parameters:
-
- iTarget
- An optionnal new target of the copied Path.
- Returns:
- The duplicated Path.
o ConcatenateWith
| public virtual ConcatenateWith( | | iHeader) |
-
Concatenates with another Path.
Concatenation takes into account only to the product path of the iHeader argument, i.e. representation and target are not taken into account.
- Parameters:
-
- iHeader
- Path to be concatened in front of the current Path.
- Returns:
- An HRESULT.
- S_OK
- Paths have been succesfuly concatenated.
- E_FAIL
- Paths are not compatible and can not be concatenated.
o GetObjectInContext
| public virtual GetObjectInContext( | | iType | = 0 ) |
-
Return the object in context corresponding the Path.
- See also:
-
- Parameters:
-
- iType
- Type of PLO to create:
- 0
- An object in context corresponding to the target will be created.
- 1
- An object in context corresponding to the representation will be created.
- 2
- An object in context corresponding to the the last product instance will be created.
- Returns:
- A pointer to the object in context which has been created.
o GetRepInstance
| public virtual GetRepInstance( | ) |
-
Returns the Rep instance of the Path.
- Returns:
- The Rep instance of the Path.
Lifecycle rules deviation: No AddRef is done on returned value.
o GetTarget
| public virtual GetTarget( | ) |
-
- Returns:
- The target of the Path.
Lifecycle rules deviation: No AddRef is done on returned value.
o GetTransformation
| public virtual GetTransformation( | | oTransfo) |
-
Return the transformation corresponding to the Path to the target object
- Parameters:
-
- oTransfo
- Positionning matrix of target through the Path.
o HasPathIncludedIn
| public virtual HasPathIncludedIn( | | iPath) |
-
Checks if current Path is included in another one.
Comparison is limited only to the product path, i.e. representation and target are not taken into account.
- Parameters:
-
- iPath
- Path for the check.
- Returns:
- A CATBoolean.
- FALSE
- Current Path is not included in the target one.
- TRUE
- Current Path is included in the target one.
o IsEmpty
| public virtual IsEmpty( | | iTestResult | = 0 ) |
-
Test if the Path is valuated.
- Parameters:
-
- iTestResult
- :
Legal values:
- 0
- Check only if the Path has a target.
- 1
- Check the target content.
- Returns:
- An integer.
- 0
- Path has a target.
- 1
- Path has no target or an empty one.
o IsInSameRep
| public virtual IsInSameRep( | | iSelection) |
-
Checks if both Paths are in the same representation
- Parameters:
-
- iSelection
- Path for the check.
- Returns:
- A CATBoolean.
Legal values:
- FALSE
- The Paths are in different representations.
- TRUE
- The Paths are in the same representation.
o IsSame
| public virtual IsSame( | | iSelection) |
-
Checks if both Paths are identical
- Parameters:
-
- Sielection
- Path to compare whith.
- Returns:
- A CATBoolean.
Legal values:
- FALSE
- The Paths are identical.
- TRUE
- The Paths differ.
o SetAutoLoadingMode
| public virtual SetAutoLoadingMode( | | iMode) |
-
Manage the automatic loading of the target if necessary, see
method.
- Parameters:
-
- iMode
- :
Legal values:
- 0
- No opening nor loading will be performed.
- 1
- GetTarget method will trigger a load operation if necessary but not an open operation.
- 2
- GetTarget method will automatically trigger a both open and load operation if necessary.
o TruncateWith
| public virtual TruncateWith( | | iPath) |
-
Truncate the curent Path with another one. It removes from the current Path all the leading products
corresponding to the iPath argument. Representation and target of the iPath arguements are ignored.
- Parameters:
-
- iPath
- Path to truncate by.
- Returns:
- An HRESULT.
- S_OK
- Path have been succesfuly truncated.
- E_FAIL
- Paths are not compatible and concatenation can not be performed.
o UpdateTarget
| public virtual UpdateTarget( | | iTarget) |
-
Update the target of the Path.
- Parameters:
-
- iTarget
- the new target of Path.
This object is included in the file: CATFmtPath.h
If needed, your Imakefile.mk should include the module: CATFmtToolsInterfaces
Copyright © 1999-2015, Dassault Systèmes. All rights reserved.