PLMValidationInterfaces CATREVReviewUIServices
Usage: you must use this class as is. You should never derive it.
public class CATREVReviewUIServices
Allows to access UI services on Reviews.
Errors not documented on each method:
- E_OUTOFMEMORY
- One memory allocation fails.
- E_UNEXPECTED
- There is an unexpected failure.
Method Index
- o
Apply(CATIREVSlide*)
- Applies a given Slide to the Review.
- o
GetActivatedReview(CATBaseUnknown*,CATIREVReview*&)
- Retrieves the activated Review of a factory.
- o
GetImage(CATFrmWindow*,int,int,CATPixelImage*&)
- Computes an image.
- o
Grab(CATIREVReview*)
- Transfers information from session to the Review.
- o
SetActivatedReview(CATBaseUnknown*,CATIREVReview*)
- Sets the activated Review of a factory.
- o
Update(CATIREVSlide*)
- Updates a given Slide with the Review.
Methods
o Apply
| public static Apply( | | ipiREVSlide) |
-
Applies a given Slide to the Review.
- Parameters:
-
- ipiSlide
- The Slide to apply.
Legal values:
- Valid
- The Slide is valid.
- Not valid
- The Slide is not valid.
- Returns:
- HRESULT
Legal values:
- S_OK
- The Slide is succesfully applied.
- E_INVALIDARG
- The given Slide is not valid.
Cases Matrix:
| environment | ipiSlide | HRESULT |
| Valid | Valid | S_OK |
| Valid | Not valid | E_INVALIDARG |
o GetActivatedReview
| public static GetActivatedReview( | | ipiFactory, |
| | opiREVReview) |
-
Retrieves the activated Review of a factory. (This service works only within an interactive session)
- Parameters:
-
- ipiFactory
- The factory.
Legal values:
- Valid
- The Factory is valid.
- Not valid
- The Factory is not valid.
- opiReview
- The activated Review
Legal values:
- Valid
- This Review is activated.
- NULL
- There is no activated Review or there is an error.
- Returns:
- HRESULT
Legal values:
- S_OK
- The activated Review is succesfully returned.
- E_INVALIDARG
- The Factory is not valid.
- E_FAIL
- The environment does not allow activation.
Cases Matrix:
| environment | ipiFactory | opiReview | HRESULT |
| Valid | Valid | Valid | S_OK |
| Valid | Not valid | NULL | E_INVALIDARG |
| Not valid | Valid | NULL | E_FAIL |
o GetImage
| public static GetImage( | | ipWindow, |
| | iXSize, |
| | iYSize, |
| | opThumbnail) |
-
Computes an image.
- Parameters:
-
- ipWindow
- The window of the image.
Legal values:
- Valid
- The window is valid.
- Not valid
- The window is not valid.
- iXSize
- The width of the image in pixels.
- iYSize
- The height of the image in pixels.
- opThumbnail
- The image.
Legal values:
- Valid
- The image is valid.
- NULL
- There is no image.
- Returns:
- HRESULT
Legal values:
- S_OK
- The Slide is succesfully copied.
- E_INVALIDARG
- One of the inputs is not valid.
- E_FAIL
- The environment does not allow computation.
Cases Matrix:
| environment | ipWindow | iXSize | iYSize | opThumbnail | HRESULT |
| Valid | Valid | Valid | Valid | Valid | S_OK |
| Valid | Not valid | Valid | Valid | NULL | E_INVALIDARG |
| Valid | Valid | Not valid | Valid | NULL | E_INVALIDARG |
| Valid | Valid | Valid | Not valid | NULL | E_INVALIDARG |
| Not valid | Valid | Valid | Valid | NULL | E_FAIL |
o Grab
| public static Grab( | | ipiREVReview) |
-
Transfers information from session to the Review.
- Parameters:
-
- ipiReview
- The Review to update.
Legal values:
- Valid
- The Review is valid.
- Not valid
- The Review is not valid.
- Returns:
- HRESULT
Legal values:
- S_OK
- The Review is succesfully updated.
- E_INVALIDARG
- The given Review is not valid.
Cases Matrix:
| environment | ipiReview | HRESULT |
| Valid | Valid | S_OK |
| Valid | Not valid | E_INVALIDARG |
o SetActivatedReview
| public static SetActivatedReview( | | ipiFactory, |
| | ipiREVReview) |
-
Sets the activated Review of a factory. (This service works only within an interactive session)
- Parameters:
-
- ipiFactory
- The factory.
Legal values:
- Valid
- The Factory is valid.
- Not valid
- The Factory is not valid.
- ipiReview
- The Review
Legal values:
- Valid
- This Review can be activated.
- NULL
- This Review cannot be activated.
- Returns:
- HRESULT
Legal values:
- S_OK
- The Review is succesfully activated.
- E_INVALIDARG
- The Factory or Review are not valid.
- E_FAIL
- The environment does not allow activation.
Cases Matrix:
| environment | ipiFactory | ipiReview | HRESULT |
| Valid | Valid | Valid | S_OK |
| Valid | Valid | Not valid | E_INVALIDARG |
| Valid | Not valid | Valid | E_INVALIDARG |
| Not valid | Valid | NULL | E_FAIL |
o Update
| public static Update( | | ipiREVSlide) |
-
Updates a given Slide with the Review.
- Parameters:
-
- ipiSlide
- The Slide to update.
Legal values:
- Valid
- The Slide is valid.
- Not valid
- The Slide is not valid.
- Returns:
- HRESULT
Legal values:
- S_OK
- The Slide is succesfully updated.
- E_INVALIDARG
- The given Slide is not valid.
Cases Matrix:
| environment | ipiSlide | HRESULT |
| Valid | Valid | S_OK |
| Valid | Not valid | E_INVALIDARG |
This object is included in the file: CATREVReviewUIServices.h
If needed, your Imakefile.mk should include the module: PLMValidationItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.