Open CASCADE Technology 6.6.0
|
Comment attribute. may be associated to any label
to store user comment.
#include <TDataStd_Comment.hxx>
Public Member Functions | |
TDataStd_Comment () | |
void | Set (const TCollection_ExtendedString &S) |
const TCollection_ExtendedString & | Get () const |
Returns the comment attribute. | |
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 Standard_OStream & | Dump (Standard_OStream &anOS) const |
Dumps the minimum information about <me> on <aStream>. | |
Standard_Boolean | AfterRetrieval (const Standard_Boolean forceIt=Standard_False) |
Something to do AFTER creation of an attribute by persistent-transient translation. The returned status says if AfterUndo has been performed (true) or if this callback must be called once again further (false). If <forceIt> is set to true, the method MUST perform and return true. Does nothing by default and returns true. | |
Static Public Member Functions | |
static const Standard_GUID & | GetID () |
class methods ============= //! Returns the GUID for comments. | |
static Handle_TDataStd_Comment | Set (const TDF_Label &label) |
Find, or create a Comment attribute. the Comment attribute is returned. | |
static Handle_TDataStd_Comment | Set (const TDF_Label &label, const TCollection_ExtendedString &string) |
Finds, or creates a Comment attribute and sets the string. the Comment attribute is returned. //! Comment methods ============ |
TDataStd_Comment::TDataStd_Comment | ( | ) |
Standard_Boolean TDataStd_Comment::AfterRetrieval | ( | const Standard_Boolean | forceIt = Standard_False | ) | [virtual] |
Reimplemented from TDF_Attribute.
virtual Standard_OStream& TDataStd_Comment::Dump | ( | Standard_OStream & | anOS | ) | const [virtual] |
Reimplemented from TDF_Attribute.
const TCollection_ExtendedString& TDataStd_Comment::Get | ( | ) | const |
static const Standard_GUID& TDataStd_Comment::GetID | ( | ) | [static] |
const Standard_GUID& TDataStd_Comment::ID | ( | ) | const [virtual] |
Implements TDF_Attribute.
Handle_TDF_Attribute TDataStd_Comment::NewEmpty | ( | ) | const [virtual] |
Implements TDF_Attribute.
void TDataStd_Comment::Paste | ( | const Handle< TDF_Attribute > & | intoAttribute, |
const Handle< TDF_RelocationTable > & | aRelocationTable | ||
) | const [virtual] |
Implements TDF_Attribute.
void TDataStd_Comment::Restore | ( | const Handle< TDF_Attribute > & | anAttribute | ) | [virtual] |
Implements TDF_Attribute.
void TDataStd_Comment::Set | ( | const TCollection_ExtendedString & | S | ) |
static Handle_TDataStd_Comment TDataStd_Comment::Set | ( | const TDF_Label & | label | ) | [static] |
static Handle_TDataStd_Comment TDataStd_Comment::Set | ( | const TDF_Label & | label, |
const TCollection_ExtendedString & | string | ||
) | [static] |