ObjectModelerBase CATOmbLifeCycleRootsBag
Usage: you must use this class as is. You should never derive it.
public class CATOmbLifeCycleRootsBag
Class allowing to hold PLM components in session.
Constructor and Destructor Index
- o
CATOmbLifeCycleRootsBag()
- Constructs an empty bag.
- o
CATOmbLifeCycleRootsBag(CATOmbLifeCycleRootsBag&)
- Constructs a new handle referencing the same bag.
- o
CATOmbLifeCycleRootsBag(CATIOmbLifeCycleOwnerNLSInfo&)
- Constructs an empty bag, with specific debug messages info.
- o
~CATOmbLifeCycleRootsBag()
- Destructor.
Method Index
- o
ChangeOwnerInfo(CATIOmbLifeCycleOwnerNLSInfo&)
- Changes pointer to NLS info.
- o
GetRoots(CATListPtrCATBaseUnknown&)
- Retrieves the roots components.
- o
InsertRoot(IUnknown*)
- Inserts a PLM component as root object kept by this bag.
- o
RemoveAll()
- Empties this bag.
- o
RemoveRoot(IUnknown*)
- Removes a PLM component from this bag.
- o
operator!()
- Checks if handle is referencing a bag.
- o
operator=(CATOmbLifeCycleRootsBag&)
- Assign a new reference to an existing handle.
Constructor and Destructor
o CATOmbLifeCycleRootsBag
| public CATOmbLifeCycleRootsBag( | ) |
-
Constructs an empty bag.
o CATOmbLifeCycleRootsBag
| public CATOmbLifeCycleRootsBag( | const | iCopy) |
-
Constructs a new handle referencing the same bag.
The CATOmbLifeCycleRootsBag C++ object is a handle on a shared internal bag.
The internal bag is deleted when the last handle is deleted.
- Parameters:
-
- iCopy
- An handle on the bag to be shared.
o CATOmbLifeCycleRootsBag
| public CATOmbLifeCycleRootsBag( | | iNLSInfo) |
-
Constructs an empty bag, with specific debug messages info.
- Parameters:
-
- iNLSInfo
- A valid reference to an implementation of CATIOmbLifeCycleOwnerNLSInfo.
o ~CATOmbLifeCycleRootsBag
| public ~CATOmbLifeCycleRootsBag( | ) |
-
Destructor.
Methods
o ChangeOwnerInfo
| public ChangeOwnerInfo( | | iNLSInfo) |
-
Changes pointer to NLS info.
- Parameters:
-
- iNLSInfo
- A valid reference to an implementation of CATIOmbLifeCycleOwnerNLSInfo.
- Returns:
-
Legal values:
- S_OK
- Info successfully changed.
o GetRoots
| public GetRoots( | | oListOfRoots) |
-
Retrieves the roots components.
- Parameters:
-
- oListOfRoots
- The list of root components inside the bag.
It must be empty before call.
Each object of the list must be released.
- Returns:
-
Legal values:
- S_OK
- Components found.
- E_FAIL
- No components found.
- E_INVALIDARG
- Called with non-empty output argument.
o InsertRoot
| public InsertRoot( | | iComp) |
-
Inserts a PLM component as root object kept by this bag.
Only reference and RepReference can be inserted.
- Parameters:
-
- iComp
- The root component to insert in the bag.
- Returns:
-
Legal values:
- S_OK
- The component was successfully inserted.
- S_FALSE
- The component was previously inserted, thus the bag contains it.
- E_FAIL
- The component has not been inserted.
o RemoveAll
-
Empties this bag.
Every component which was kept in memory only because of this bag will
be unloaded from the session. See also RemoveRoot method.
- Returns:
-
Legal values:
- S_OK
- All components were successfully removed.
- E_FAIL
- An internal error occured.
o RemoveRoot
| public RemoveRoot( | | iComp) |
-
Removes a PLM component from this bag.
Every component which was kept in memory only because of this particular root will
be unloaded from the session.
- Parameters:
-
- iComp
- The root component to remove from the bag.
- Returns:
-
Legal values:
- S_OK
- The component was successfully removed.
- E_FAIL
- The component has not been removed. An internal error occurred.
o operator!
-
Checks if handle is referencing a bag.
- Returns:
-
Legal values:
- TRUE
- handle is not referencing a bag.
- FALSE
- handle is referencing a bag.
o operator=
| public operator=( | const | iCopy) |
-
Assign a new reference to an existing handle.
The CATOmbLifeCycleRootsBag C++ object is a handle on a shared internal bag.
If the handle was assigned to an existing bag, it will be released.
- Parameters:
-
- iCopy
- An handle on the bag to be shared.
- Returns:
- The current handle.
This object is included in the file: CATOmbLifeCycleRootsBag.h
If needed, your Imakefile.mk should include the module: CATObjectModelerBase
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.