OCC Main Page | ApplicationFramework | Toolkits | Packages | Class Hierarchy | Data Structures | File List | Data Fields | Globals

ApplicationFramework
TKLCAF
TDataStd


TDataStd_NamedData Class Reference

Contains a named data.
.

#include <TDataStd_NamedData.hxx>

Inheritance diagram for TDataStd_NamedData:

Inheritance graph
[legend]

Public Member Functions

Standard_EXPORT TDataStd_NamedData ()
Standard_Boolean HasIntegers () const
 Returns true if at least one named integer value is
kept in the attribute.
.
Standard_EXPORT Standard_Boolean HasInteger (const TCollection_ExtendedString &theName) const
 Returns true if the attribute contains specified by Name
integer value.
.
Standard_EXPORT 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).
.
Standard_EXPORT 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>.
.
Standard_EXPORT const TDataStd_DataMapOfStringIntegerGetIntegersContainer ()
 Returns the internal container of named integers.
.
Standard_EXPORT void ChangeIntegers (const TDataStd_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_EXPORT Standard_Boolean HasReal (const TCollection_ExtendedString &theName) const
 Returns true if the attribute contains a real specified by Name.
.
Standard_EXPORT 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()).
.
Standard_EXPORT 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>.
.
Standard_EXPORT const TDataStd_DataMapOfStringRealGetRealsContainer ()
 Returns the internal container of named reals.
.
Standard_EXPORT 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_EXPORT Standard_Boolean HasString (const TCollection_ExtendedString &theName) const
 Returns true if the attribute contains this named string.
.
Standard_EXPORT const TCollection_ExtendedString & GetString (const TCollection_ExtendedString &theName)
 Returns the named string.
It returns an empty string if there is no such a named string
(use HasString()).
.
Standard_EXPORT 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>.
.
Standard_EXPORT const TDataStd_DataMapOfStringStringGetStringsContainer ()
 Returns the internal container of named strings.
.
Standard_EXPORT 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_EXPORT Standard_Boolean HasByte (const TCollection_ExtendedString &theName) const
 Returns true if the attribute contains this named byte.
.
Standard_EXPORT Standard_Byte GetByte (const TCollection_ExtendedString &theName)
 Returns the named byte.
It returns 0 if there is no such a named byte
(use HasByte()).
.
Standard_EXPORT 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>.
.
Standard_EXPORT const TDataStd_DataMapOfStringByteGetBytesContainer ()
 Returns the internal container of named bytes.
.
Standard_EXPORT 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_EXPORT Standard_Boolean HasArrayOfIntegers (const TCollection_ExtendedString &theName) const
 Returns true if the attribute contains this named array of integer values.
.
Standard_EXPORT 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()).
.
Standard_EXPORT 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>.
.
Standard_EXPORT const TDataStd_DataMapOfStringHArray1OfIntegerGetArraysOfIntegersContainer ()
 Returns the internal container of named arrays of integer values.
.
Standard_EXPORT 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_EXPORT Standard_Boolean HasArrayOfReals (const TCollection_ExtendedString &theName) const
 Returns true if the attribute contains this named array of real values.
.
Standard_EXPORT 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()).
.
Standard_EXPORT 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>.
.
Standard_EXPORT const TDataStd_DataMapOfStringHArray1OfRealGetArraysOfRealsContainer ()
 Returns the internal container of named arrays of real values.
.
Standard_EXPORT void ChangeArraysOfReals (const TDataStd_DataMapOfStringHArray1OfReal &theArraysOfReals)
 Replace the container content by new content of the <thearraysofreals>.
.
Standard_EXPORT const Standard_GUID & ID () const
 Returns the ID of the attribute.

.
Standard_EXPORT void Restore (const Handle(TDF_Attribute)&With)
 Restores the backuped contents from <anattribute>
into this one. It is used when aborting a
transaction.
.
Standard_EXPORT Handle_TDF_Attribute NewEmpty () const
 Returns an new empty attribute from the good end
type. It is used by the copy algorithm.
.
Standard_EXPORT 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_EXPORT Standard_OStream & Dump (Standard_OStream &anOS) const
 Dumps the minimum information about <me> on
<astream>.

.
Standard_EXPORT const Handle (Standard_Type)&DynamicType() const

Static Public Member Functions

static Standard_EXPORT const
Standard_GUID & 
GetID ()
 Static methods
==============
//! Returns the ID of the named data attribute.
.
static Standard_EXPORT Handle_TDataStd_NamedData Set (const TDF_Label &label)
 Finds or creates a named data attribute.
.

Private Attributes

Handle_TDataStd_HDataMapOfStringInteger myIntegers
Handle_TDataStd_HDataMapOfStringReal myReals
Handle_TDataStd_HDataMapOfStringString myStrings
Handle_TDataStd_HDataMapOfStringByte myBytes
Handle_TDataStd_HDataMapOfStringHArray1OfInteger myArraysOfIntegers
Handle_TDataStd_HDataMapOfStringHArray1OfReal myArraysOfReals

Constructor & Destructor Documentation

Standard_EXPORT TDataStd_NamedData::TDataStd_NamedData  ) 
 


Member Function Documentation

Standard_EXPORT void TDataStd_NamedData::ChangeArraysOfIntegers const TDataStd_DataMapOfStringHArray1OfInteger theArraysOfIntegers  ) 
 

Standard_EXPORT void TDataStd_NamedData::ChangeArraysOfReals const TDataStd_DataMapOfStringHArray1OfReal theArraysOfReals  ) 
 

Standard_EXPORT void TDataStd_NamedData::ChangeBytes const TDataStd_DataMapOfStringByte theBytes  ) 
 

Standard_EXPORT void TDataStd_NamedData::ChangeIntegers const TDataStd_DataMapOfStringInteger theIntegers  ) 
 

Standard_EXPORT void TDataStd_NamedData::ChangeReals const TDataStd_DataMapOfStringReal theReals  ) 
 

Standard_EXPORT void TDataStd_NamedData::ChangeStrings const TDataStd_DataMapOfStringString theStrings  ) 
 

virtual Standard_EXPORT Standard_OStream& TDataStd_NamedData::Dump Standard_OStream &  anOS  )  const [virtual]
 

Reimplemented from TDF_Attribute.

Standard_EXPORT const Handle_TColStd_HArray1OfInteger& TDataStd_NamedData::GetArrayOfIntegers const TCollection_ExtendedString &  theName  ) 
 

Standard_EXPORT const Handle_TColStd_HArray1OfReal& TDataStd_NamedData::GetArrayOfReals const TCollection_ExtendedString &  theName  ) 
 

Standard_EXPORT const TDataStd_DataMapOfStringHArray1OfInteger& TDataStd_NamedData::GetArraysOfIntegersContainer  ) 
 

Standard_EXPORT const TDataStd_DataMapOfStringHArray1OfReal& TDataStd_NamedData::GetArraysOfRealsContainer  ) 
 

Standard_EXPORT Standard_Byte TDataStd_NamedData::GetByte const TCollection_ExtendedString &  theName  ) 
 

Standard_EXPORT const TDataStd_DataMapOfStringByte& TDataStd_NamedData::GetBytesContainer  ) 
 

static Standard_EXPORT const Standard_GUID& TDataStd_NamedData::GetID  )  [static]
 

Standard_EXPORT Standard_Integer TDataStd_NamedData::GetInteger const TCollection_ExtendedString &  theName  ) 
 

Standard_EXPORT const TDataStd_DataMapOfStringInteger& TDataStd_NamedData::GetIntegersContainer  ) 
 

Standard_EXPORT Standard_Real TDataStd_NamedData::GetReal const TCollection_ExtendedString &  theName  ) 
 

Standard_EXPORT const TDataStd_DataMapOfStringReal& TDataStd_NamedData::GetRealsContainer  ) 
 

Standard_EXPORT const TCollection_ExtendedString& TDataStd_NamedData::GetString const TCollection_ExtendedString &  theName  ) 
 

Standard_EXPORT const TDataStd_DataMapOfStringString& TDataStd_NamedData::GetStringsContainer  ) 
 

Standard_EXPORT const TDataStd_NamedData::Handle Standard_Type   )  const
 

Reimplemented from TDF_Attribute.

Standard_EXPORT Standard_Boolean TDataStd_NamedData::HasArrayOfIntegers const TCollection_ExtendedString &  theName  )  const
 

Standard_EXPORT Standard_Boolean TDataStd_NamedData::HasArrayOfReals const TCollection_ExtendedString &  theName  )  const
 

Standard_Boolean TDataStd_NamedData::HasArraysOfIntegers  )  const [inline]
 

Standard_Boolean TDataStd_NamedData::HasArraysOfReals  )  const [inline]
 

Standard_EXPORT Standard_Boolean TDataStd_NamedData::HasByte const TCollection_ExtendedString &  theName  )  const
 

Standard_Boolean TDataStd_NamedData::HasBytes  )  const [inline]
 

Standard_EXPORT Standard_Boolean TDataStd_NamedData::HasInteger const TCollection_ExtendedString &  theName  )  const
 

Standard_Boolean TDataStd_NamedData::HasIntegers  )  const [inline]
 

Standard_EXPORT Standard_Boolean TDataStd_NamedData::HasReal const TCollection_ExtendedString &  theName  )  const
 

Standard_Boolean TDataStd_NamedData::HasReals  )  const [inline]
 

Standard_EXPORT Standard_Boolean TDataStd_NamedData::HasString const TCollection_ExtendedString &  theName  )  const
 

Standard_Boolean TDataStd_NamedData::HasStrings  )  const [inline]
 

Standard_EXPORT const Standard_GUID& TDataStd_NamedData::ID  )  const [virtual]
 

Implements TDF_Attribute.

Standard_EXPORT Handle_TDF_Attribute TDataStd_NamedData::NewEmpty  )  const [virtual]
 

Implements TDF_Attribute.

Standard_EXPORT void TDataStd_NamedData::Paste const Handle(TDF_Attribute)&  Into,
const Handle(TDF_RelocationTable)&  RT
const [virtual]
 

Implements TDF_Attribute.

Standard_EXPORT void TDataStd_NamedData::Restore const Handle(TDF_Attribute)&  With  )  [virtual]
 

Implements TDF_Attribute.

static Standard_EXPORT Handle_TDataStd_NamedData TDataStd_NamedData::Set const TDF_Label label  )  [static]
 

Standard_EXPORT void TDataStd_NamedData::SetArrayOfIntegers const TCollection_ExtendedString &  theName,
const Handle(TColStd_HArray1OfInteger)&  theArrayOfIntegers
 

Standard_EXPORT void TDataStd_NamedData::SetArrayOfReals const TCollection_ExtendedString &  theName,
const Handle(TColStd_HArray1OfReal)&  theArrayOfReals
 

Standard_EXPORT void TDataStd_NamedData::SetByte const TCollection_ExtendedString &  theName,
const Standard_Byte  theByte
 

Standard_EXPORT void TDataStd_NamedData::SetInteger const TCollection_ExtendedString &  theName,
const Standard_Integer  theInteger
 

Standard_EXPORT void TDataStd_NamedData::SetReal const TCollection_ExtendedString &  theName,
const Standard_Real  theReal
 

Standard_EXPORT void TDataStd_NamedData::SetString const TCollection_ExtendedString &  theName,
const TCollection_ExtendedString &  theString
 


Field Documentation

Handle_TDataStd_HDataMapOfStringHArray1OfInteger TDataStd_NamedData::myArraysOfIntegers [private]
 

Handle_TDataStd_HDataMapOfStringHArray1OfReal TDataStd_NamedData::myArraysOfReals [private]
 

Handle_TDataStd_HDataMapOfStringByte TDataStd_NamedData::myBytes [private]
 

Handle_TDataStd_HDataMapOfStringInteger TDataStd_NamedData::myIntegers [private]
 

Handle_TDataStd_HDataMapOfStringReal TDataStd_NamedData::myReals [private]
 

Handle_TDataStd_HDataMapOfStringString TDataStd_NamedData::myStrings [private]
 


The documentation for this class was generated from the following files:
Generated on Mon Aug 25 14:15:25 2008 for OpenCASCADE by  doxygen 1.4.1