All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ManufacturingInterfaces Interface CATIMfgResource

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATIMfgResource
 

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATIMfgResource

Interface dedicated to resource objects management.
Role: This interface offers services to manage parameters.
Common attributes are declared in constants header files.


Method Index


o GetDefaultName(CATUnicodeString&)
Retrieves the default name of the resource object.
o GetLinkedObject(CATISpecObject_var&)
Retrieves the linked object associated on the resource object.
o GetName(CATUnicodeString&)
Retrieves the name of the resource object.
o GetParametrization(CATListOfCATUnicodeString&)
Retrieves the parametrization set of the resource object.
o GetValue(CATUnicodeString&,CATBaseUnknown_var&)
Retrieves value of a CATICkeParm attribute of the resource object.
o GetValue(CATUnicodeString&,CATBoolean&)
Retrieves value of a boolean attribute of the resource object.
o GetValue(CATUnicodeString&,CATUnicodeString&)
Retrieves value of a string attribute of the resource object.
o GetValue(CATUnicodeString&,double&,int)
Retrieves value of a double attribute of the resource object.
o GetValue(CATUnicodeString&,int&)
Retrieves value of an integer attribute of the resource object.
o GetValues(CATListOfCATUnicodeString&,CATListOfInt&,CATListOfInt&,CATListOfInt&,CATListOfDouble&,CATListOfCATUnicodeString&,int)
Retrieves values of parameters of the resource object.
o SetDefaultName()
Sets the default name of the resource object.
o SetDefaultValues()
Sets default values to parameters of the resource object.
o SetLinkedObject(CATISpecObject_var&)
Sets the link to the object on the resource object.
o SetName(CATUnicodeString&)
Sets the name of the resource object.
o SetParametrization(CATListOfCATUnicodeString&)
Sets the parametrization set of the resource object.
o SetValue(CATUnicodeString&,CATBaseUnknown_var&)
Sets value to a CATICkeParm attribute of the resource object.
o SetValue(CATUnicodeString&,CATBoolean)
Sets value to a boolean attribute of the resource object.
o SetValue(CATUnicodeString&,CATUnicodeString&)
Sets value to a string attribute of the resource object.
o SetValue(CATUnicodeString&,double,int)
Sets value to a double attribute of the resource object.
o SetValue(CATUnicodeString&,int)
Sets value to an integer attribute of the resource object.
o SetValues(CATListOfCATUnicodeString&,CATListOfInt&,CATListOfInt&,CATListOfInt&,CATListOfDouble&,CATListOfCATUnicodeString&,int)
Sets values to parameters of the resource object.

Methods


o GetDefaultName
public virtual HRESULT GetDefaultName(CATUnicodeString& oName)=0
Retrieves the default name of the resource object.
Parameters:
oName
The default name of the resource object
o GetLinkedObject
public virtual HRESULT GetLinkedObject(CATISpecObject_var& oObject) =0
Retrieves the linked object associated on the resource object.
Parameters:
oObject
The external object associated on the resource.
Returns:
Return code.
Legal values:
  • S_OK: the object exists
  • E_FAIL: otherwise
o GetName
public virtual HRESULT GetName(CATUnicodeString& oName)=0
Retrieves the name of the resource object.
Parameters:
oName
The name of the resource object
o GetParametrization
public virtual HRESULT GetParametrization(CATListOfCATUnicodeString& oValue) =0
Retrieves the parametrization set of the resource object.
Parameters:
oValue
The list of parametrization on the resource. Each string is one parametrization rule.
Returns:
Return code.
Legal values:
  • S_OK: the parametrization exists
  • E_FAIL: otherwise
o GetValue
public virtual HRESULT GetValue( const CATUnicodeString& iAttribute,
CATBaseUnknown_var& oValue)=0
Retrieves value of a CATICkeParm attribute of the resource object.
Parameters:
iAttribute
The name of the attribute
oValue
The CKE value
See also:
CATICkeParm
o GetValue
public virtual HRESULT GetValue( const CATUnicodeString& iAttribute,
CATBoolean& oValue)=0
Retrieves value of a boolean attribute of the resource object.
Parameters:
iAttribute
The name of the attribute
oValue
The boolean value
o GetValue
public virtual HRESULT GetValue( const CATUnicodeString& iAttribute,
CATUnicodeString& oValue)=0
Retrieves value of a string attribute of the resource object.
Parameters:
iAttribute
The name of the attribute
oValue
The string value
o GetValue
public virtual HRESULT GetValue( const CATUnicodeString& iAttribute,
double& oValue,
int iUnit=0)=0
Retrieves value of a double attribute of the resource object.
Parameters:
iAttribute
The name of the attribute
oValue
The double value
iUnit
Unit to express value
Legal values:
  • 0 (default) : values expressed as they are stored in the model (for example, 'mm' for length)
  • 1 : values expressed in current unit of session
  • 2 : values expressed in MKS system
o GetValue
public virtual HRESULT GetValue( const CATUnicodeString& iAttribute,
int& oValue)=0
Retrieves value of an integer attribute of the resource object.
Parameters:
iAttribute
The name of the attribute
oValue
The integer value
o GetValues
public virtual HRESULT GetValues(CATListOfCATUnicodeString& iListAttributes,
CATListOfInt& oListTypeValues,
CATListOfInt& oListNbValues,
CATListOfInt& oListIntValues,
CATListOfDouble& oListDblValues,
CATListOfCATUnicodeString& oListStrValues,
int iUnit=0)=0
Retrieves values of parameters of the resource object.
Parameters:
iListAttributes
List containing attribute names to read (if List is empty, all attributes are read)
oListTypeValues

Legal values:
  • 0: boolean
  • 1: integer
  • 2: double
  • 3: string
oListNbValues
List containing number of values for each attribute
oListIntValues
List containing integer type values
oListDblValues
List containing double type values
oListStrValues
List containing string type values
iUnit
Unit to express value
Legal values:
  • 0 (default) : values expressed as they are stored in the model (for example, 'mm' for length)
  • 1 : values expressed in current unit of session
  • 2 : values expressed in MKS system
o SetDefaultName
public virtual HRESULT SetDefaultName()=0
Sets the default name of the resource object.
o SetDefaultValues
public virtual HRESULT SetDefaultValues()=0
Sets default values to parameters of the resource object.
o SetLinkedObject
public virtual HRESULT SetLinkedObject( const CATISpecObject_var& iObject) =0
Sets the link to the object on the resource object.
Parameters:
iObject
The external object to associate on the resource.
Returns:
Return code.
Legal values:
  • S_OK: the object could be added
  • E_FAIL: otherwise
o SetName
public virtual HRESULT SetName( const CATUnicodeString& iName)=0
Sets the name of the resource object.
Parameters:
iName
The name of the resource object
o SetParametrization
public virtual HRESULT SetParametrization( const CATListOfCATUnicodeString& iValue) =0
Sets the parametrization set of the resource object.
Parameters:
iValue
The list of parametrization to be added to the resource. One string is one parametrization rule.
Returns:
Return code.
Legal values:
  • S_OK: the parametrization could be added
  • E_FAIL: otherwise
o SetValue
public virtual HRESULT SetValue( const CATUnicodeString& iAttribute,
const CATBaseUnknown_var& iValue)=0
Sets value to a CATICkeParm attribute of the resource object.
Parameters:
iAttribute
: The name of the attribute
iValue
: The CKE value
See also:
CATICkeParm
o SetValue
public virtual HRESULT SetValue( const CATUnicodeString& iAttribute,
const CATBoolean iValue)=0
Sets value to a boolean attribute of the resource object.
Parameters:
iAttribute
The name of the attribute
iValue
The boolean value
o SetValue
public virtual HRESULT SetValue( const CATUnicodeString& iAttribute,
const CATUnicodeString& iValue)=0
Sets value to a string attribute of the resource object.
Parameters:
iAttribute
The name of the attribute
oValue
The string value
o SetValue
public virtual HRESULT SetValue( const CATUnicodeString& iAttribute,
const double iValue,
int iUnit=0)=0
Sets value to a double attribute of the resource object.
Parameters:
iAttribute
The name of the attribute
iValue
The double value
iUnit
Unit to express value
Legal values:
  • 0 (default) : values expressed as they are stored in the model (for example, 'mm' for length)
  • 1 : values expressed in current unit of session
  • 2 : values expressed in MKS system
o SetValue
public virtual HRESULT SetValue( const CATUnicodeString& iAttribute,
const int iValue)=0
Sets value to an integer attribute of the resource object.
Parameters:
iAttribute
The name of the attribute
iValue
The integer value
o SetValues
public virtual HRESULT SetValues( const CATListOfCATUnicodeString& iListAttributes,
const CATListOfInt& iListTypeValues,
const CATListOfInt& iListNbValues,
const CATListOfInt& iListIntValues,
const CATListOfDouble& iListDblValues,
const CATListOfCATUnicodeString& iListStrValues,
int iUnit=0)=0
Sets values to parameters of the resource object.
Parameters:
iListAttributes
List containing attribute names to valuate
iListTypeValues
List containing type of value for each attribute
Legal values:
  • 0: boolean
  • 1: integer
  • 2: double
  • 3: string
iListNbValues
List containing number of values for each attribute
iListIntValues
List containing integer type values
iListDblValues
List containing double type values
iListStrValues
List containing string type values
iUnit
Unit to express value
Legal values:
  • 0 (default) : values expressed as they are stored in the model (for example, 'mm' for length)
  • 1 : values expressed in current unit of session
  • 2 : values expressed in MKS system

This object is included in the file: CATIMfgResource.h
If needed, your Imakefile.mk should include the module: MfgItfEnv

Copyright © 2003, Dassault Systèmes. All rights reserved.