All Frameworks Class Hierarchy This Framework Previous Next Indexes
KnowledgeInterfaces Interface CATICkeParm
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATICkeParm
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATICkeParm
Interface dedicated to parameters management.
Role: manages informations on parameters.
- See also:
- CATIParmAsStored
- See also:
- CATIParmManipulator
Method Index
- o
Content()
- Returns the content (show without unit suffix).
- o
ContentIso()
- Returns the value of the parameter without unit suffix while respecting the ISO standard.
- o
CreateManipulator()
- Creates a persistent manipulator if none is referenced in the parameter (BEWARE).
- o
ImpactedRelations(int)
- Returns the list of relations linked to this parameter corresponding to a criteria.
- o
InternalRole()
- Returns the internal role of parameter in its context.
- o
IsConst()
- Indicates if this parameter const or not.
- o
IsHidden()
- Indicates if this parameter is hidden or shown.
- o
IsNamed()
- Indicates if the parameter name has been overidden by a user.
- o
IsReadOnly()
- Indicates if a parameter can be valuated or not.
- o
IsSet()
- Indicates if this parameter is set or unset.
- o
Manipulator()
- Returns the persistent manipulator referenced in the parameter (BEWARE).
- o
Name()
- Returns the name overidden by user (if any).
- o
Pathname(CATIParmPublisher_var&)
- Returns the pathname of a parameter from a context.
- o
Relation()
- Returns the active relation valuating the parameter.
- o
RelativeName(CATIParmPublisher_var&)
- Returns the relative name of a parameter from a context.
- o
Rename(CATUnicodeString&)
- Overrides name of parameter.
- o
Role(CATIParmPublisher_var&)
- Returns the function of a parameter in its context.
- o
SetConst(CATCke::Boolean)
- Sets Const facet.
- o
SetHidden(CATCke::Boolean)
- Sets HideShow facet.
- o
SetManipulator(CATIParmManipulator_var&)
- References a volatile manipulator in the parameter (BEWARE).
- o
SetRelation(CATIParmValuator_var&,CATCke::Boolean&)
- Sets the active relation valuating parameter.
- o
SetUserAccess(CATICkeParm::UserAccessMode)
- Sets the rights on this parameter.
- o
Show()
- Returns the way of seeing a parameter in the current unit.
- o
ShowIso()
- Returns the value of the parameter in the current unit while respecting the ISO standard.
- o
ShowReal(CATICkeUnit_var&)
- Shows a parameter in a given unit.
- o
ShowRealIso(CATICkeUnit_var&)
- Returns the value of the parameter in a given unit while respecting the ISO standard.
- o
Type()
- Returns the type of the parameter.
- o
Unset()
- Unsets this literal.
- o
UserAccess()
- Returns the rights on this parameter.
- o
Valuate(CATCke::Boolean)
- Valuates from a boolean.
- o
Valuate(CATICkeInst_var&)
- Valuates from another value.
- o
Valuate(CATUnicodeString&)
- Valuates from a String.
- o
Valuate(double)
- Valuates from a double (in MKS).
- o
Valuate(int)
- Valuates from an int.
- o
ValuateObject(CATBaseUnknown_var&)
- Valuates parameter from a feature.
- o
ValuateReal(CATUnicodeString&)
- Sets a dimension value from a string with unit.
- o
Value()
- Returns its value.
Enumerated Type Index
- o
UserAccessMode
- Rights defined on aparameter.
Methods
o Content
-
Returns the content (show without unit suffix).
example "3".
o ContentIso
-
Returns the value of the parameter without unit suffix while respecting the ISO standard.
- Returns:
- The value of the parameter without unit suffix while respecting the ISO standard,
i.e. : if the setting called "Decimal places for read/write numbers" (used for the display of units) = 3
and if the parameter's value in current unit = 0.001,
returns "0"
otherwise, if parameter's value in current unit = 0.001,
returns "0.001".
o CreateManipulator
-
Creates a persistent manipulator if none is referenced in the parameter (BEWARE).
BEWARE: This method returns a persistent manipulator. All the modifications done on the parameter will be saved in the model. To temporarily (from a volatile point of view) change the bounds of a parameter, follow this procedure:
1- CATIParmManipulator_var spVolatileManipulator = CATICkeParmFactory::CreateParmManipulator ()
2- CATICkeParm::SetManipulator( spVolatileManipulator );
3- spVolatileManipulator -> SetRange() or AddMultipleValues()...;
Note that just one persistent manipulator can be created on a parameter and the last volatile manipulator's reference can be kept in the parameter.
- Returns:
- The persistent manipulator referenced in the parameter if any, otherwise, it creates a new one.
o ImpactedRelations
-
Returns the list of relations linked to this parameter corresponding to a criteria.
- Parameters:
-
- iCriteria
-
Legal values:
1 returns the relations where this parameter is in input.
2 returns the relations where this parameter is in output.
0 returns the relations where this parameter is in input or output.
- Returns:
- list of relation : the list is allocated : Please desallocate
o InternalRole
-
Returns the internal role of parameter in its context.
It is the name given to the parameter at its creation
o IsConst
public virtual CATCke::Boolean IsConst( | )const = 0 |
-
Indicates if this parameter const or not.
Default value is always not Const
- Returns:
- Legal values: CATCke::True if it is constant
CATCke::False if it isn't.
o IsHidden
public virtual CATCke::Boolean IsHidden( | )const = 0 |
-
Indicates if this parameter is hidden or shown.
Default value is always Shown
- Returns:
-
Legal values: CATCke::True if it is hidden
CATCke::False if it isn't.
o IsNamed
public virtual CATCke::Boolean IsNamed( | )const = 0 |
-
Indicates if the parameter name has been overidden by a user.
- Returns:
- Legal values: CATCke::True if it is renamed.
CATCke::False if it isn't.
o IsReadOnly
public virtual CATCke::Boolean IsReadOnly( | )const =0 |
-
Indicates if a parameter can be valuated or not.
it is read only
-when the user access say so or when it is valuated by a relation
-or when its visibility is false
- Returns:
- Legal values: CATCke::True if it is read only.
CATCke::False if it isn't.
o IsSet
public virtual CATCke::Boolean IsSet( | )const = 0 |
-
Indicates if this parameter is set or unset.
Default value is always Set
- Returns:
- Legal values: CATCke::True if it is set
CATCke::False if it isn't.
o Manipulator
-
Returns the persistent manipulator referenced in the parameter (BEWARE).
BEWARE: This method returns the persistent manipulator referenced in the parameter. All the modifications done on the parameter will be saved in the model. To temporarily (from a volatile point of view) change the bounds of a parameter, follow this procedure:
1- CATIParmManipulator_var spVolatileManipulator = CATICkeParmFactory::CreateParmManipulator ()
2- CATICkeParm::SetManipulator( NULL_var ); ); If you wish to delete the last volatile manipulator.
3- CATICkeParm::SetManipulator( spVolatileManipulator );
4- spVolatileManipulator -> SetRange() or AddMultipleValues()...;
- Returns:
- The manipulator referenced in the parameter. It could have been created using the method
CATICkeParm.CreateManipulator or set using the method
CATICkeParm.SetManipulator.
o Name
-
Returns the name overidden by user (if any).
example : "x"
o Pathname
public virtual CATUnicodeString Pathname( | const CATIParmPublisher_var& | iRoot | = NULL_var) const = 0 |
-
Returns the pathname of a parameter from a context.
example : "PartBody\Hole.1\Diameter"
- Parameters:
-
- iRoot
- context object
o Relation
-
Returns the active relation valuating the parameter.
o RelativeName
public virtual CATUnicodeString RelativeName( | const CATIParmPublisher_var& | iRoot | = NULL_var) const = 0 |
-
Returns the relative name of a parameter from a context.
example : "x" or "PartBody\Hole.1\Diameter"
If name is overidden, returns this name else returns pathname
Should be used to show a literal to the user
- Parameters:
-
- iRoot
- context
o Rename
-
Overrides name of parameter.
(if value == "" the parameter will have no overriden name anymore)
- Parameters:
-
- iNewName
- name
o Role
public virtual CATUnicodeString Role( | const CATIParmPublisher_var& | iRoot | = NULL_var) const = 0 |
-
Returns the function of a parameter in its context.
The string returns is NLS.
- Parameters:
-
- iRoot
- CATIParmPublisher that contains the literal and which is able to name it
o SetConst
public virtual void SetConst( | const CATCke::Boolean | iConstant) = 0 |
-
Sets Const facet.
Default value is always not Const
- Parameters:
-
- iConstant
- Legal values:
CATCke::True if it is constant
CATCke::False if it isn't.
o SetHidden
public virtual void SetHidden( | const CATCke::Boolean | b) = 0 |
-
Sets HideShow facet.
Default value is always Shown
- Returns:
-
Legal values: CATCke::True if it is hidden
CATCke::False if it isn't.
o SetManipulator
public virtual void SetManipulator( | const CATIParmManipulator_var& | iManipulator) = 0 |
-
References a volatile manipulator in the parameter (BEWARE).
BEWARE: This method references a volatile manipulator in the parameter. All the modifications done on the parameter will not be saved in the model. To persistently (from a persistent point of view) change the bounds of a parameter follow this procedure:
1- CATIParmManipulator_var spPersitentManipulator = param->CreateManipulator();
2- spPersitentManipulator -> SetRange() or AddMultipleValues()...;
Note that just one persistent manipulator can be created on a parameter and the last volatile manipulator's reference can be kept in the parameter.
- Parameters:
-
- iManipulator
- volatile manipulator.
o SetRelation
public virtual void SetRelation( | const CATIParmValuator_var& | iValuating, |
| const CATCke::Boolean& | iStrong | = 0 )= 0 |
-
Sets the active relation valuating parameter.
- Parameters:
-
- iValuating
- relation (can be NULL_var)
- iStrong:
-
Legal values:
CATCke::True sets an input and persistant update link between parameter and valuating.
CATCke::False .
o SetUserAccess
public virtual void SetUserAccess( | const CATICkeParm::UserAccessMode | iRights) = 0 |
-
Sets the rights on this parameter.
- Parameters:
-
- iRights:
- Legal values:
NotSeen this parameter is not seen by the user.
ReadOnly the parameter will be seen but won't be modified, may be used as input of a relation.
ReadWrite Default value:the parameter can be modified, and used as output of a relation
User this is a parameter created by a end-user. It can be destroyed
o Show
-
Returns the way of seeing a parameter in the current unit.
example : "3mm"
o ShowIso
-
Returns the value of the parameter in the current unit while respecting the ISO standard.
- Returns:
- The value of the parameter in the current unit while respecting the ISO standard,
i.e. : if the setting called "Decimal places for read/write numbers" (used for the display of units) = 3
and if the parameter's value in current unit (e.g. mm) = 0.001,
returns "0mm"
otherwise, if parameter's value in current unit (e.g. mm) = 0.001,
returns "0.001mm".
o ShowReal
public virtual CATUnicodeString ShowReal( | const CATICkeUnit_var& | iUnit) const =0 |
-
Shows a parameter in a given unit.
example "3 km".
- Parameters:
-
- iUnit
- unit
o ShowRealIso
public virtual CATUnicodeString ShowRealIso( | const CATICkeUnit_var& | iUnit) const = 0 |
-
Returns the value of the parameter in a given unit while respecting the ISO standard.
- Returns:
- The value of the parameter in the unit given as parameter while respecting the ISO standard,
i.e. : if the setting called "Decimal places for read/write numbers" (used for the display of units) = 3
and if the parameter's value converts in the given unit (e.g. mm) = 0.001,
returns "0mm"
otherwise, if parameter's value converts in the given unit (e.g. mm) = 0.001,
returns "0.001mm".
- Parameters:
-
- iUnit
- Unit in which the value of the parameter is shown.
o Type
-
Returns the type of the parameter.
o Unset
public virtual void Unset( | )= 0 |
-
Unsets this literal.
o UserAccess
public virtual CATICkeParm::UserAccessMode UserAccess( | )const = 0 |
-
Returns the rights on this parameter.
Legal values:
NotSeen this parameter is not seen by the user.
ReadOnly the parameter will be seen but won't be modified, may be used as input of a relation.
ReadWrite Default value:the parameter can be modified, and used as output of a relation
User this is a parameter created by a end-user. It can be destroyed
o Valuate
public virtual void Valuate( | const CATCke::Boolean | iValue) = 0 |
-
Valuates from a boolean.
- Parameters:
-
- iValue
- value to set
o Valuate
public virtual void Valuate( | const CATICkeInst_var& | iValue) = 0 |
-
Valuates from another value.
- Parameters:
-
- iValue
- value to set
o Valuate
-
Valuates from a String.
- Parameters:
-
- iValue
- value to set
o Valuate
public virtual void Valuate( | const double | iValue) = 0 |
-
Valuates from a double (in MKS).
- Parameters:
-
- iValue
- value to set
o Valuate
public virtual void Valuate( | const int | iValue) = 0 |
-
Valuates from an int.
- Parameters:
-
- iValue
- value to set
o ValuateObject
-
Valuates parameter from a feature.
- Parameters:
-
- iFeature
- value to set
o ValuateReal
-
Sets a dimension value from a string with unit.
(ex "3cm")
- Parameters:
-
- iValue
- string
o Value
-
Returns its value.
Enumerated Types
o UserAccessMode
-
enum UserAccessMode {
NotSeen,
ReadOnly,
WriteOnly,
ReadWrite,
User
}
Rights defined on aparameter.
Used to define how this parameter can be used through Knowledgeware.
Legal values:
NotSeen this parameter is not seen by the user.
ReadOnly the parameter will be seen but won't be modified, may be used as input of a relation.
ReadWrite Default value:the parameter can be modified, and used as output of a relation
User this is a parameter created by a end-user. It can be destroyed
This object is included in the file: CATICkeParm.h
If needed, your Imakefile.mk should include the module: KnowledgeItf