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

Contains a named data.

#include <TDataStd_NamedData.hxx>

Inheritance diagram for TDataStd_NamedData:
Inheritance graph
[legend]

Public Member Functions

 TDataStd_NamedData ()
Standard_Boolean HasIntegers () const
 Returns true if at least one named integer value is
kept in the attribute.

Standard_Boolean HasInteger (const TCollection_ExtendedString &theName) const
 Returns true if the attribute contains specified by Name
integer value.

Standard_Integer GetInteger (const TCollection_ExtendedString &theName)
 Returns the integer value specified by the Name.
It returns 0 if internal map doesn't contain the specified
integer (use HasInteger() to check before).

void SetInteger (const TCollection_ExtendedString &theName, const Standard_Integer theInteger)
 Defines a named integer.
If the integer already exists, it changes its value to <theInteger>.

const
TColStd_DataMapOfStringInteger
GetIntegersContainer ()
 Returns the internal container of named integers.

void ChangeIntegers (const TColStd_DataMapOfStringInteger &theIntegers)
 Replace the container content by new content of the <theIntegers>.

Standard_Boolean HasReals () const
 Returns true if at least one named real value is
kept in the attribute.

Standard_Boolean HasReal (const TCollection_ExtendedString &theName) const
 Returns true if the attribute contains a real specified by Name.

Standard_Real GetReal (const TCollection_ExtendedString &theName)
 Returns the named real.
It returns 0.0 if there is no such a named real
(use HasReal()).

void SetReal (const TCollection_ExtendedString &theName, const Standard_Real theReal)
 Defines a named real.
If the real already exists, it changes its value to <theReal>.

const
TDataStd_DataMapOfStringReal
GetRealsContainer ()
 Returns the internal container of named reals.

void ChangeReals (const TDataStd_DataMapOfStringReal &theReals)
 Replace the container content by new content of the <theReals>.

Standard_Boolean HasStrings () const
 Returns true if there are some named strings in the attribute.

Standard_Boolean HasString (const TCollection_ExtendedString &theName) const
 Returns true if the attribute contains this named string.

const TCollection_ExtendedStringGetString (const TCollection_ExtendedString &theName)
 Returns the named string.
It returns an empty string if there is no such a named string
(use HasString()).

void SetString (const TCollection_ExtendedString &theName, const TCollection_ExtendedString &theString)
 Defines a named string.
If the string already exists, it changes its value to <theString>.

const
TDataStd_DataMapOfStringString
GetStringsContainer ()
 Returns the internal container of named strings.

void ChangeStrings (const TDataStd_DataMapOfStringString &theStrings)
 Replace the container content by new content of the <theStrings>.

Standard_Boolean HasBytes () const
 Returns true if there are some named bytes in the attribute.

Standard_Boolean HasByte (const TCollection_ExtendedString &theName) const
 Returns true if the attribute contains this named byte.

Standard_Byte GetByte (const TCollection_ExtendedString &theName)
 Returns the named byte.
It returns 0 if there is no such a named byte
(use HasByte()).

void SetByte (const TCollection_ExtendedString &theName, const Standard_Byte theByte)
 Defines a named byte.
If the byte already exists, it changes its value to <theByte>.

const
TDataStd_DataMapOfStringByte
GetBytesContainer ()
 Returns the internal container of named bytes.

void ChangeBytes (const TDataStd_DataMapOfStringByte &theBytes)
 Replace the container content by new content of the <theBytes>.

Standard_Boolean HasArraysOfIntegers () const
 Returns true if there are some named arrays of integer values in the attribute.

Standard_Boolean HasArrayOfIntegers (const TCollection_ExtendedString &theName) const
 Returns true if the attribute contains this named array of integer values.

const
Handle_TColStd_HArray1OfInteger & 
GetArrayOfIntegers (const TCollection_ExtendedString &theName)
 Returns the named array of integer values.
It returns a NULL Handle if there is no such a named array of integers
(use HasArrayOfIntegers()).

void SetArrayOfIntegers (const TCollection_ExtendedString &theName, const Handle< TColStd_HArray1OfInteger > &theArrayOfIntegers)
 Defines a named array of integer values.
If the array already exists, it changes its value to <theArrayOfIntegers>.

const
TDataStd_DataMapOfStringHArray1OfInteger
GetArraysOfIntegersContainer ()
 Returns the internal container of named arrays of integer values.

void ChangeArraysOfIntegers (const TDataStd_DataMapOfStringHArray1OfInteger &theArraysOfIntegers)
 Replace the container content by new content of the <theArraysOfIntegers>.

Standard_Boolean HasArraysOfReals () const
 Returns true if there are some named arrays of real values in the attribute.

Standard_Boolean HasArrayOfReals (const TCollection_ExtendedString &theName) const
 Returns true if the attribute contains this named array of real values.

const
Handle_TColStd_HArray1OfReal & 
GetArrayOfReals (const TCollection_ExtendedString &theName)
 Returns the named array of real values.
It returns a NULL Handle if there is no such a named array of reals
(use HasArrayOfReals()).

void SetArrayOfReals (const TCollection_ExtendedString &theName, const Handle< TColStd_HArray1OfReal > &theArrayOfReals)
 Defines a named array of real values.
If the array already exists, it changes its value to <theArrayOfReals>.

const
TDataStd_DataMapOfStringHArray1OfReal
GetArraysOfRealsContainer ()
 Returns the internal container of named arrays of real values.

void ChangeArraysOfReals (const TDataStd_DataMapOfStringHArray1OfReal &theArraysOfReals)
 Replace the container content by new content of the <theArraysOfReals>.

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 ()
 Static methods
==============
//! Returns the ID of the named data attribute.

static Handle_TDataStd_NamedData Set (const TDF_Label &label)
 Finds or creates a named data attribute.


Constructor & Destructor Documentation

TDataStd_NamedData::TDataStd_NamedData ( )

Member Function Documentation

void TDataStd_NamedData::ChangeArraysOfIntegers ( const TDataStd_DataMapOfStringHArray1OfInteger theArraysOfIntegers)
void TDataStd_NamedData::ChangeArraysOfReals ( const TDataStd_DataMapOfStringHArray1OfReal theArraysOfReals)
void TDataStd_NamedData::ChangeBytes ( const TDataStd_DataMapOfStringByte theBytes)
void TDataStd_NamedData::ChangeIntegers ( const TColStd_DataMapOfStringInteger theIntegers)
void TDataStd_NamedData::ChangeReals ( const TDataStd_DataMapOfStringReal theReals)
void TDataStd_NamedData::ChangeStrings ( const TDataStd_DataMapOfStringString theStrings)
virtual Standard_OStream& TDataStd_NamedData::Dump ( Standard_OStream anOS) const [virtual]

Reimplemented from TDF_Attribute.

const Handle_TColStd_HArray1OfInteger& TDataStd_NamedData::GetArrayOfIntegers ( const TCollection_ExtendedString theName)
const Handle_TColStd_HArray1OfReal& TDataStd_NamedData::GetArrayOfReals ( const TCollection_ExtendedString theName)
const TDataStd_DataMapOfStringHArray1OfInteger& TDataStd_NamedData::GetArraysOfIntegersContainer ( )
const TDataStd_DataMapOfStringHArray1OfReal& TDataStd_NamedData::GetArraysOfRealsContainer ( )
Standard_Byte TDataStd_NamedData::GetByte ( const TCollection_ExtendedString theName)
const TDataStd_DataMapOfStringByte& TDataStd_NamedData::GetBytesContainer ( )
static const Standard_GUID& TDataStd_NamedData::GetID ( ) [static]
Standard_Integer TDataStd_NamedData::GetInteger ( const TCollection_ExtendedString theName)
const TColStd_DataMapOfStringInteger& TDataStd_NamedData::GetIntegersContainer ( )
Standard_Real TDataStd_NamedData::GetReal ( const TCollection_ExtendedString theName)
const TDataStd_DataMapOfStringReal& TDataStd_NamedData::GetRealsContainer ( )
const TCollection_ExtendedString& TDataStd_NamedData::GetString ( const TCollection_ExtendedString theName)
const TDataStd_DataMapOfStringString& TDataStd_NamedData::GetStringsContainer ( )
Standard_Boolean TDataStd_NamedData::HasArrayOfIntegers ( const TCollection_ExtendedString theName) const
Standard_Boolean TDataStd_NamedData::HasArrayOfReals ( const TCollection_ExtendedString theName) const
Standard_Boolean TDataStd_NamedData::HasArraysOfIntegers ( ) const
Standard_Boolean TDataStd_NamedData::HasArraysOfReals ( ) const
Standard_Boolean TDataStd_NamedData::HasByte ( const TCollection_ExtendedString theName) const
Standard_Boolean TDataStd_NamedData::HasBytes ( ) const
Standard_Boolean TDataStd_NamedData::HasInteger ( const TCollection_ExtendedString theName) const
Standard_Boolean TDataStd_NamedData::HasIntegers ( ) const
Standard_Boolean TDataStd_NamedData::HasReal ( const TCollection_ExtendedString theName) const
Standard_Boolean TDataStd_NamedData::HasReals ( ) const
Standard_Boolean TDataStd_NamedData::HasString ( const TCollection_ExtendedString theName) const
Standard_Boolean TDataStd_NamedData::HasStrings ( ) const
const Standard_GUID& TDataStd_NamedData::ID ( ) const [virtual]

Implements TDF_Attribute.

Handle_TDF_Attribute TDataStd_NamedData::NewEmpty ( ) const [virtual]

Implements TDF_Attribute.

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

Implements TDF_Attribute.

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

Implements TDF_Attribute.

static Handle_TDataStd_NamedData TDataStd_NamedData::Set ( const TDF_Label label) [static]
void TDataStd_NamedData::SetArrayOfIntegers ( const TCollection_ExtendedString theName,
const Handle< TColStd_HArray1OfInteger > &  theArrayOfIntegers 
)
void TDataStd_NamedData::SetArrayOfReals ( const TCollection_ExtendedString theName,
const Handle< TColStd_HArray1OfReal > &  theArrayOfReals 
)
void TDataStd_NamedData::SetByte ( const TCollection_ExtendedString theName,
const Standard_Byte  theByte 
)
void TDataStd_NamedData::SetInteger ( const TCollection_ExtendedString theName,
const Standard_Integer  theInteger 
)
void TDataStd_NamedData::SetReal ( const TCollection_ExtendedString theName,
const Standard_Real  theReal 
)
void TDataStd_NamedData::SetString ( const TCollection_ExtendedString theName,
const TCollection_ExtendedString theString 
)

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