Material Object WrapperGet Component Constant Method
Get some pure component constant(s)
Definition
Namespace: CapeOpen
Assembly: CapeOpen (in CapeOpen.dll) Version: 1.0.0.0 (1.0.0.0)
Component Constant values returned from the Property Package for all the components in the Material Object It is a Object containing a 1 dimensional array of Objects. If we call P to the number of requested properties and C to the number requested components the array will contain C*P Objects. The C first ones (from position 0 to C-1) will be the values for the first requested property (one Object for each component). After them (from position C to 2*C-1) there will be the values of constants for the second requested property, and so on.
Assembly: CapeOpen (in CapeOpen.dll) Version: 1.0.0.0 (1.0.0.0)
C#
private double[] GetComponentConstant(
string[] props,
string[] compIds
)VB
Private Function GetComponentConstant (
props As String(),
compIds As String()
) As Double()Parameters
- props String
- List of component constants.
- compIds String
- List of component IDs for which constants are to be retrieved. Use a null value for all components in the Material Object.
Return Value
DoubleComponent Constant values returned from the Property Package for all the components in the Material Object It is a Object containing a 1 dimensional array of Objects. If we call P to the number of requested properties and C to the number requested components the array will contain C*P Objects. The C first ones (from position 0 to C-1) will be the values for the first requested property (one Object for each component). After them (from position C to 2*C-1) there will be the values of constants for the second requested property, and so on.
Remarks
Retrieve component constants from the Property Package. See Notes for more
information.
Exceptions
| ECapeUnknown | The error to be raised when other error(s), specified for this operation, are not suitable. |
| ECapeInvalidArgument | To be used when an invalid argument value is passed, for example, an unrecognised Compound identifier or UNDEFINED for the props argument. |
| ECapeNoImpl | ECapeNoImpl |