Version: 8.3.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Public Member Functions | Static Public Member Functions | Public Attributes | Private Member Functions | List of all members
GEOM_Function Class Reference

#include <GEOM_Function.hxx>

Inheritance diagram for GEOM_Function:
Inheritance graph

Public Member Functions

Standard_EXPORT GEOM_Function (const TDF_Label &theEntry, const Standard_GUID &theGUID, int theType)
 
Standard_EXPORT ~GEOM_Function ()
 
Standard_EXPORT TDF_Label GetOwnerEntry ()
 
Standard_EXPORT TopoDS_Shape GetValue ()
 
Standard_EXPORT void SetValue (TopoDS_Shape &theShape)
 
Standard_EXPORT TDF_Label & GetEntry ()
 
Standard_EXPORT int GetType ()
 
Standard_EXPORT Standard_GUID GetDriverGUID ()
 
Standard_EXPORT
TCollection_AsciiString 		GetDescription ()
 
Standard_EXPORT void SetDescription (const TCollection_AsciiString &theDescription)
 
Standard_EXPORT void SetReal (int thePosition, double theValue)
 
Standard_EXPORT double GetReal (int thePosition)
 
Standard_EXPORT void SetRealArray (int thePosition, const Handle(TColStd_HArray1OfReal)&theArray)
 
Standard_EXPORT Handle (TColStd_HArray1OfReal) GetRealArray(int thePosition)
 
Standard_EXPORT void SetInteger (int thePosition, int theValue)
 
Standard_EXPORT int GetInteger (int thePosition)
 
Standard_EXPORT void SetIntegerArray (int thePosition, const Handle(TColStd_HArray1OfInteger)&theArray)
 
Standard_EXPORT Handle (TColStd_HArray1OfInteger) GetIntegerArray(int thePosition)
 
Standard_EXPORT void SetByteArray (int thePosition, const Handle(TColStd_HArray1OfByte)&theArray)
 
Standard_EXPORT Handle (TColStd_HArray1OfByte) GetByteArray(int thePosition)
 
Standard_EXPORT void SetBooleanArray (int thePosition, const Handle(TColStd_HArray1OfByte)&theArray)
 
Standard_EXPORT Handle (TColStd_HArray1OfByte) GetBooleanArray(int thePosition)
 
Standard_EXPORT void SetReference (int thePosition, Handle(GEOM_Function) theReference)
 
Standard_EXPORT void SetString (int thePosition, const TCollection_AsciiString &theValue)
 
Standard_EXPORT
TCollection_AsciiString 		GetString (int thePosition)
 
Standard_EXPORT Handle (GEOM_Function) GetReference(int thePosition)
 
Standard_EXPORT void SetStringArray (int thePosition, const Handle(TColStd_HArray1OfExtendedString)&theArray)
 
Standard_EXPORT Handle (TColStd_HArray1OfExtendedString) GetStringArray(int thePosition)
 
Standard_EXPORT bool HasData (int thePosition, const Standard_GUID &dataID)
 
Standard_EXPORT void SetReferenceList (int thePosition, const Handle(TColStd_HSequenceOfTransient)&theRefList)
 
Standard_EXPORT Handle (TColStd_HSequenceOfTransient) GetReferenceList(int thePosition)
 
Standard_EXPORT void SetCallBackData (void *data)
 
Standard_EXPORT void * GetCallBackData ()
 
Standard_EXPORT bool IsDone ()
 
Standard_EXPORT bool IsLastFuntion ()
 Retuns true if this function is the last one in the study. More...
 
Standard_EXPORT void GetDependency (TDF_LabelSequence &theSeq)
 
Standard_EXPORT void AddSubShapeReference (Handle(GEOM_Function) theSubShape)
 
Standard_EXPORT void RemoveSubShapeReference (Handle(GEOM_Function) theSubShape)
 
Standard_EXPORT bool HasSubShapeReferences ()
 
Standard_EXPORT const
TDataStd_ListOfExtendedString & 		GetSubShapeReferences ()
 
Standard_EXPORT TDF_Label GetHistoryEntry (const Standard_Boolean create=Standard_True)
 
Standard_EXPORT TDF_Label GetArgumentHistoryEntry (const TDF_Label &theArgumentRefEntry, const Standard_Boolean create=Standard_True)
 
Standard_EXPORT TDF_Label GetNamingEntry (const Standard_Boolean create=Standard_True)
 

Static Public Member Functions

static Standard_EXPORT const
Standard_GUID & 		GetFunctionTreeID ()
 
static Standard_EXPORT const
Standard_GUID & 		GetDependencyID ()
 
static Standard_EXPORT Handle (GEOM_Function) GetFunction(const TDF_Label &theEntry)
 
static Standard_EXPORT const
Standard_GUID & 		GetReferencesTreeID ()
 

Public Attributes

OCCT_DEFINE_STANDARD_RTTIEXT(GEOM_Function,
Standard_Transient) private
bool 		_isDone
 
bool _isCallBackData
 

Private Member Functions

 GEOM_Function (const TDF_Label &theEntry)
 

Constructor & Destructor Documentation

GEOM_Function::GEOM_Function ( const TDF_Label &  theEntry)
inlineprivate
GEOM_Function::GEOM_Function ( const TDF_Label &  theEntry,
const Standard_GUID &  theGUID,
int  theType 
)

Constructor:

References GetFunctionTreeID(), and Handle().

GEOM_Function::~GEOM_Function ( )

References _isCallBackData, and CALLBACK_LABEL.

Member Function Documentation

void GEOM_Function::AddSubShapeReference ( Handle(GEOM_Function)  theSubShape)

AddSubShapeReference

References _isDone, GetOwnerEntry(), Handle(), and SUBSHAPES_LABEL.

TDF_Label GEOM_Function::GetArgumentHistoryEntry ( const TDF_Label &  theArgumentRefEntry,
const Standard_Boolean  create = Standard_True 
)

GetArgumentHistoryEntry

References GetHistoryEntry().

void * GEOM_Function::GetCallBackData ( )

Returns a pointer to a data holder intended to pass data Driver -> Operation. This method should be called by Driver to get the data holder to fill it in. Returns NULL if the Operation have not set the data holder.

References CALLBACK_LABEL, Handle(), and NULL.

void GEOM_Function::GetDependency ( TDF_LabelSequence &  theSeq)

SetShape

GetShape

GetDependency

References ARGUMENTS, and GetDependencyID().

const Standard_GUID & GEOM_Function::GetDependencyID ( )
static
TCollection_AsciiString GEOM_Function::GetDescription ( )

GetDescription

References DESCRIPTION_LABEL, and Handle().

Standard_GUID GEOM_Function::GetDriverGUID ( )

GetDriverGUID

References Handle().

Standard_EXPORT TDF_Label& GEOM_Function::GetEntry ( )
inline
const Standard_GUID & GEOM_Function::GetFunctionTreeID ( )
static
TDF_Label GEOM_Function::GetHistoryEntry ( const Standard_Boolean  create = Standard_True)

GetHistoryEntry

References HISTORY_LABEL.

int GEOM_Function::GetInteger ( int  thePosition)

GetInteger

References _isDone, ARGUMENT, and Handle().

TDF_Label GEOM_Function::GetNamingEntry ( const Standard_Boolean  create = Standard_True)

GetNamingEntry

References NAMING_LABEL.

TDF_Label GEOM_Function::GetOwnerEntry ( )

GetOwner

References GEOM_BaseObject::GetObjectID().

double GEOM_Function::GetReal ( int  thePosition)

GetReal

References _isDone, ARGUMENT, and Handle().

const Standard_GUID & GEOM_Function::GetReferencesTreeID ( )
static
TCollection_AsciiString GEOM_Function::GetString ( int  thePosition)

GetString

References _isDone, ARGUMENT, and Handle().

const TDataStd_ListOfExtendedString & GEOM_Function::GetSubShapeReferences ( )

GetSubShapeReferences

References _isDone, Handle(), and SUBSHAPES_LABEL.

int GEOM_Function::GetType ( )

GetType

References _isDone, and Handle().

TopoDS_Shape GEOM_Function::GetValue ( )

GetValue

References _isDone, GEOM_Solver::ComputeFunction(), GEOM_Engine::GetEngine(), GetOwnerEntry(), Handle(), ORIENTATION_LABEL, and RESULT_LABEL.

static Standard_EXPORT GEOM_Function::Handle ( GEOM_Function  ) const
static
Standard_EXPORT GEOM_Function::Handle ( TColStd_HArray1OfReal  )
Standard_EXPORT GEOM_Function::Handle ( TColStd_HArray1OfInteger  )
Standard_EXPORT GEOM_Function::Handle ( TColStd_HArray1OfByte  )
Standard_EXPORT GEOM_Function::Handle ( TColStd_HArray1OfByte  )
Standard_EXPORT GEOM_Function::Handle ( GEOM_Function  )
Standard_EXPORT GEOM_Function::Handle ( TColStd_HArray1OfExtendedString  )
Standard_EXPORT GEOM_Function::Handle ( TColStd_HSequenceOfTransient  )
bool GEOM_Function::HasData ( int  thePosition,
const Standard_GUID &  dataID 
)

References ARGUMENT.

bool GEOM_Function::HasSubShapeReferences ( )

HasSubShapeReferences

References _isDone, and SUBSHAPES_LABEL.

Standard_EXPORT bool GEOM_Function::IsDone ( )
inline

References _isDone.

bool GEOM_Function::IsLastFuntion ( )

References GetFunctionTreeID(), and Handle().

void GEOM_Function::RemoveSubShapeReference ( Handle(GEOM_Function)  theSubShape)

RemoveSubShapeReference

References _isDone, GetOwnerEntry(), Handle(), and SUBSHAPES_LABEL.

void GEOM_Function::SetBooleanArray ( int  thePosition,
const Handle(TColStd_HArray1OfByte)&  theArray 
)

SetBooleanArray

References _isDone, ARGUMENT, and Handle().

void GEOM_Function::SetByteArray ( int  thePosition,
const Handle(TColStd_HArray1OfByte)&  theArray 
)

SetByteArray

References _isDone, ARGUMENT, and Handle().

void GEOM_Function::SetCallBackData ( void *  data)

Save a pointer to a data holder intended to pass temporary data Driver -> Operation. This method should be called by Operation to set the data holder. An instance of GEOM_Function that sets the data holder will remove the corresponding OCAF attribute at it's destruction

References _isCallBackData, and CALLBACK_LABEL.

void GEOM_Function::SetDescription ( const TCollection_AsciiString &  theDescription)

SetDescription

References DESCRIPTION_LABEL, and Handle().

void GEOM_Function::SetInteger ( int  thePosition,
int  theValue 
)

SetInteger

References _isDone, and ARGUMENT.

void GEOM_Function::SetIntegerArray ( int  thePosition,
const Handle(TColStd_HArray1OfInteger)&  theArray 
)

SetIntegerArray

References _isDone, ARGUMENT, and Handle().

void GEOM_Function::SetReal ( int  thePosition,
double  theValue 
)

SetReal

References _isDone, and ARGUMENT.

void GEOM_Function::SetRealArray ( int  thePosition,
const Handle(TColStd_HArray1OfReal)&  theArray 
)

SetRealArray

References _isDone, ARGUMENT, and Handle().

void GEOM_Function::SetReference ( int  thePosition,
Handle(GEOM_Function)  theReference 
)

SetReference

References _isDone, ARGUMENT, GetDependencyID(), and GetEntry().

void GEOM_Function::SetReferenceList ( int  thePosition,
const Handle(TColStd_HSequenceOfTransient)&  theRefList 
)

SetReferenceList

References _isDone, ARGUMENT, GetDependencyID(), GetReferencesTreeID(), Handle(), and SUB_ARGUMENT.

void GEOM_Function::SetString ( int  thePosition,
const TCollection_AsciiString &  theValue 
)

SetString

References ARGUMENT.

void GEOM_Function::SetStringArray ( int  thePosition,
const Handle(TColStd_HArray1OfExtendedString)&  theArray 
)

SetStringArray

References ARGUMENT, and Handle().

void GEOM_Function::SetValue ( TopoDS_Shape &  theShape)

SetValue

References _isDone, GetOwnerEntry(), Handle(), ORIENTATION_LABEL, and RESULT_LABEL.

Member Data Documentation

bool GEOM_Function::_isCallBackData
OCCT_DEFINE_STANDARD_RTTIEXT (GEOM_Function,Standard_Transient) private bool GEOM_Function::_isDone
The documentation for this class was generated from the following files: