MachiningResourceUseItf Interface DELIMfgResource
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface DELIMfgResource
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(CATBaseUnknown_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
GetType(CATUnicodeString&)
- Retrieves the type of the resource object.
- o
GetValue(CATUnicodeString&,int&)
- Retrieves value of an integer attribute of the resource object.
- o
GetValue(CATUnicodeString&,CATBoolean&)
- Retrieves value of a boolean attribute of the resource object.
- o
GetValue(CATUnicodeString&,double&,int)
- Retrieves value of a double attribute of the resource object.
- o
GetValue(CATUnicodeString&,CATUnicodeString&)
- Retrieves value of a string attribute of the resource object.
- o
GetValue(CATUnicodeString&,CATBaseUnknown_var&)
- Retrieves value of a CATICkeParm attribute of the resource object.
- o
GetValues(CATListOfCATUnicodeString&,CATListOfInt&,CATListOfInt&,CATListOfInt&,CATListOfDouble&,CATListOfCATUnicodeString&,int)
- Retrieves values of parameters of the resource object.
- o
GetVersion(int&)
- Retrieves the version 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(CATBaseUnknown_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&,int)
- Sets value to an integer attribute of the resource object.
- o
SetValue(CATUnicodeString&,CATBoolean)
- Sets value to a boolean attribute of the resource object.
- o
SetValue(CATUnicodeString&,double,int)
- Sets value to a double attribute of the resource object.
- o
SetValue(CATUnicodeString&,CATUnicodeString&)
- Sets value to a string attribute of the resource object.
- o
SetValue(CATUnicodeString&,CATBaseUnknown_var&)
- Sets value to a CATICkeParm 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 GetDefaultName( | | oName) |
-
Retrieves the default name of the resource object.
- Parameters:
-
- oName
- The default name of the resource object
o GetLinkedObject
| public virtual GetLinkedObject( | | oObject) |
-
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 GetName( | | oName) |
-
Retrieves the name of the resource object.
- Parameters:
-
- oName
- The name of the resource object
o GetParametrization
| public virtual GetParametrization( | | oValue) |
-
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 GetType
| public virtual GetType( | | oType) |
-
Retrieves the type of the resource object.
- Parameters:
-
- oType
- The internal type of the resource object
o GetValue
| public virtual GetValue( | const | iAttribute, |
| | oValue) |
-
Retrieves value of an integer attribute of the resource object.
- Parameters:
-
- iAttribute
- The name of the attribute
- oValue
- The integer value
o GetValue
| public virtual GetValue( | const | iAttribute, |
| | oValue) |
-
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 GetValue( | const | iAttribute, |
| | oValue, |
| | iUnit | = 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 GetValue( | const | iAttribute, |
| | oValue) |
-
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 GetValue( | const | iAttribute, |
| | oValue) |
-
Retrieves value of a CATICkeParm attribute of the resource object.
- Parameters:
-
- iAttribute
- The name of the attribute
- oValue
- The CKE value
- See also:
-
o GetValues
| public virtual GetValues( | | iListAttributes, |
| | oListTypeValues, |
| | oListNbValues, |
| | oListIntValues, |
| | oListDblValues, |
| | oListStrValues, |
| | iUnit | = 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 GetVersion
| public virtual GetVersion( | | oVersion) |
-
Retrieves the version of the resource object.
- Parameters:
-
- oVersion
- The internal version of the resource object
o SetDefaultName
| public virtual SetDefaultName( | ) |
-
Sets the default name of the resource object.
o SetDefaultValues
| public virtual SetDefaultValues( | ) |
-
Sets default values to parameters of the resource object.
o SetLinkedObject
| public virtual SetLinkedObject( | const | iObject) |
-
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 SetName( | const | iName) |
-
Sets the name of the resource object.
- Parameters:
-
- iName
- The name of the resource object
o SetParametrization
| public virtual SetParametrization( | const | iValue) |
-
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 SetValue( | const | iAttribute, |
| const | iValue) |
-
Sets value to an integer attribute of the resource object.
- Parameters:
-
- iAttribute
- The name of the attribute
- iValue
- The integer value
o SetValue
| public virtual SetValue( | const | iAttribute, |
| const | iValue) |
-
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 SetValue( | const | iAttribute, |
| const | iValue, |
| | iUnit | = 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 SetValue( | const | iAttribute, |
| const | iValue) |
-
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 SetValue( | const | iAttribute, |
| const | iValue) |
-
Sets value to a CATICkeParm attribute of the resource object.
- Parameters:
-
- iAttribute
- : The name of the attribute
- iValue
- : The CKE value
- See also:
-
o SetValues
| public virtual SetValues( | const | iListAttributes, |
| const | iListTypeValues, |
| const | iListNbValues, |
| const | iListIntValues, |
| const | iListDblValues, |
| const | iListStrValues, |
| | iUnit | =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: DELIMfgResource.h
If needed, your Imakefile.mk should include the module: MachiningResourceUseItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.