|
Open CASCADE Technology 6.5.2
|
|
Open CASCADE Technology 6.5.2
|
Variable attribute.
==================
* A variable is associated to a TDataStd_Real (which
contains its current value) and a TDataStd_Name
attribute (which contains its name). It contains a
constant flag, and a Unit
* An expression may be assigned to a variable. In
thatcase the expression is handled by the associated
Expression Attribute and the Variable returns True to
the method <IsAssigned>.
#include <TDataStd_Variable.hxx>
Public Member Functions | |
| TDataStd_Variable () | |
| void | Name (const TCollection_ExtendedString &string) |
| set or change the name of the variable, in myUnknown and my associated Name attribute. | |
| const TCollection_ExtendedString & | Name () const |
| returns string stored in the associated Name attribute. | |
| void | Set (const Standard_Real value, const TDataStd_RealEnum dimension=TDataStd_SCALAR) const |
| retrieve or create the associated real attribute and set the value . if creation, dimension is written. | |
| Standard_Boolean | IsValued () const |
| returns True if a Real attribute is associated. | |
| Standard_Real | Get () const |
| returns value stored in associated Real attribute. | |
| Handle_TDataStd_Real | Real () const |
| returns associated Real attribute. | |
| Standard_Boolean | IsAssigned () const |
| returns True if an Expression attribute is associated. //! create(if doesn't exist), set and returns the assigned expression attribute. | |
| Handle_TDataStd_Expression | Assign () const |
| create(if doesn't exist) and returns the assigned expression attribute. fill it after. | |
| void | Desassign () const |
| if <me> is assigned delete the associated expression attribute. | |
| Handle_TDataStd_Expression | Expression () const |
| if <me> is assigned, returns associated Expression attribute. | |
| Standard_Boolean | IsCaptured () const |
| shortcut for <Real()->IsCaptured()> | |
| Standard_Boolean | IsConstant () const |
| A constant value is not modified by regeneration. | |
| void | Unit (const TCollection_AsciiString &unit) |
| const TCollection_AsciiString & | Unit () const |
| to read/write fields =================== | |
| void | Constant (const Standard_Boolean status) |
| if <status> is True, this variable will not be modified by the solver. | |
| const Standard_GUID & | ID () const |
| Returns the ID of the attribute. | |
| void | Restore (const Handle< TDF_Attribute > &With) |
| Restores the backuped contents from <anAttribute> into this one. It is used when aborting a transaction. | |
| Handle_TDF_Attribute | NewEmpty () const |
| Returns an new empty attribute from the good end type. It is used by the copy algorithm. | |
| void | Paste (const Handle< TDF_Attribute > &Into, const Handle< TDF_RelocationTable > &RT) const |
| This method is different from the "Copy" one, because it is used when copying an attribute from a source structure into a target structure. This method may paste the contents of <me> into <intoAttribute>. The given pasted attribute can be full or empty of its contents. But don't make a NEW! Just set the contents! It is possible to use <aRelocationTable> to get/set the relocation value of a source attribute. | |
| virtual void | References (const Handle< TDF_DataSet > &DS) const |
| to export reference to the associated Name attribute. | |
| virtual Standard_OStream & | Dump (Standard_OStream &anOS) const |
| Dumps the minimum information about <me> on <aStream>. | |
Static Public Member Functions | |
| static const Standard_GUID & | GetID () |
| class methods ============= | |
| static Handle_TDataStd_Variable | Set (const TDF_Label &label) |
| Find, or create, a Variable attribute. //! Real methods ============ | |
| TDataStd_Variable::TDataStd_Variable | ( | ) |
| Handle_TDataStd_Expression TDataStd_Variable::Assign | ( | ) | const |
| void TDataStd_Variable::Constant | ( | const Standard_Boolean | status | ) |
| void TDataStd_Variable::Desassign | ( | ) | const |
| virtual Standard_OStream& TDataStd_Variable::Dump | ( | Standard_OStream & | anOS | ) | const [virtual] |
Reimplemented from TDF_Attribute.
| Handle_TDataStd_Expression TDataStd_Variable::Expression | ( | ) | const |
| Standard_Real TDataStd_Variable::Get | ( | ) | const |
| static const Standard_GUID& TDataStd_Variable::GetID | ( | ) | [static] |
| const Standard_GUID& TDataStd_Variable::ID | ( | ) | const [virtual] |
Implements TDF_Attribute.
| Standard_Boolean TDataStd_Variable::IsAssigned | ( | ) | const |
| Standard_Boolean TDataStd_Variable::IsCaptured | ( | ) | const |
| Standard_Boolean TDataStd_Variable::IsConstant | ( | ) | const |
| Standard_Boolean TDataStd_Variable::IsValued | ( | ) | const |
| const TCollection_ExtendedString& TDataStd_Variable::Name | ( | ) | const |
| void TDataStd_Variable::Name | ( | const TCollection_ExtendedString & | string | ) |
| Handle_TDF_Attribute TDataStd_Variable::NewEmpty | ( | ) | const [virtual] |
Implements TDF_Attribute.
| void TDataStd_Variable::Paste | ( | const Handle< TDF_Attribute > & | intoAttribute, |
| const Handle< TDF_RelocationTable > & | aRelocationTable | ||
| ) | const [virtual] |
Implements TDF_Attribute.
| Handle_TDataStd_Real TDataStd_Variable::Real | ( | ) | const |
| virtual void TDataStd_Variable::References | ( | const Handle< TDF_DataSet > & | DS | ) | const [virtual] |
Reimplemented from TDF_Attribute.
| void TDataStd_Variable::Restore | ( | const Handle< TDF_Attribute > & | anAttribute | ) | [virtual] |
Implements TDF_Attribute.
| void TDataStd_Variable::Set | ( | const Standard_Real | value, |
| const TDataStd_RealEnum | dimension = TDataStd_SCALAR |
||
| ) | const |
| static Handle_TDataStd_Variable TDataStd_Variable::Set | ( | const TDF_Label & | label | ) | [static] |
| void TDataStd_Variable::Unit | ( | const TCollection_AsciiString & | unit | ) |
| const TCollection_AsciiString& TDataStd_Variable::Unit | ( | ) | const |
1.7.4
