Open CASCADE Technology 6.6.0
Public Member Functions | Static Public Member Functions
TDataStd_Name Class Reference

Used to define a name attribute containing a string which specifies the name.

#include <TDataStd_Name.hxx>

Inheritance diagram for TDataStd_Name:
Inheritance graph
[legend]

Public Member Functions

 TDataStd_Name ()
void Set (const TCollection_ExtendedString &S)
 Sets <S> as name. Raises if <S> is not a valid name.

const TCollection_ExtendedStringGet () const
 Returns the name contained in this name attribute.
//! Set myEmpty field

const Standard_GUIDID () 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_OStreamDump (Standard_OStream &anOS) const
 Dumps the minimum information about <me> on
<aStream>.


Static Public Member Functions

static const Standard_GUIDGetID ()
 class methods working on the name itself
========================================
//! Returns the GUID for name attributes.

static Handle_TDataStd_Name Set (const TDF_Label &label, const TCollection_ExtendedString &string)
 Creates (if does not exist) and sets the name in the name attribute.
myEmpty becomes False
//! from any label <L> search in father labels (L is not
concerned) the first name attribute.if found set it in
<father>.
//! class methods working on the name tree
======================================
//! Search in the whole TDF_Data the Name attribute which
fit with <fullPath>. Returns True if found.
//! Search under <currentLabel> a label which fit with
<name>. Returns True if found. Shortcut which avoids
building a ListOfExtendedStrin.
//! Search in the whole TDF_Data the label which fit with name
Returns True if found.
//! tools methods to translate path <-> pathlist
===========================================
//! move to draw For Draw test we may provide this tool method which convert a path in a
sequence of string to call after the FindLabel methods.
Example: if it's given "Assembly:Part_1:Sketch_5" it will return in <pathlist>
the list of 3 strings: "Assembly","Part_1","Sketch_5".
//! move to draw from <pathlist> build the string path
//! Name methods
============


Constructor & Destructor Documentation

TDataStd_Name::TDataStd_Name ( )

Member Function Documentation

virtual Standard_OStream& TDataStd_Name::Dump ( Standard_OStream anOS) const [virtual]

Reimplemented from TDF_Attribute.

const TCollection_ExtendedString& TDataStd_Name::Get ( ) const
static const Standard_GUID& TDataStd_Name::GetID ( ) [static]
const Standard_GUID& TDataStd_Name::ID ( ) const [virtual]

Implements TDF_Attribute.

Handle_TDF_Attribute TDataStd_Name::NewEmpty ( ) const [virtual]

Implements TDF_Attribute.

void TDataStd_Name::Paste ( const Handle< TDF_Attribute > &  intoAttribute,
const Handle< TDF_RelocationTable > &  aRelocationTable 
) const [virtual]

Implements TDF_Attribute.

void TDataStd_Name::Restore ( const Handle< TDF_Attribute > &  anAttribute) [virtual]

Implements TDF_Attribute.

void TDataStd_Name::Set ( const TCollection_ExtendedString S)
static Handle_TDataStd_Name TDataStd_Name::Set ( const TDF_Label label,
const TCollection_ExtendedString string 
) [static]

The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines