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

WOK
TKWOK
WOKAPI

WOKAPI_Entity Class Reference

#include <WOKAPI_Entity.hxx>

Inheritance diagram for WOKAPI_Entity:

Inheritance graph
[legend]

Public Member Functions

void * operator new (size_t, void *anAddress)
void * operator new (size_t size)
void operator delete (void *anAddress)
Standard_EXPORT WOKAPI_Entity ()
Standard_EXPORT WOKAPI_Entity (const WOKAPI_Entity &aent)
Standard_EXPORT WOKAPI_Entity (const WOKAPI_Session &asession, const Handle(TCollection_HAsciiString)&aname, const Standard_Boolean verbose=Standard_False, const Standard_Boolean getit=Standard_True)
Standard_EXPORT void Destructor ()
virtual Standard_EXPORT ~WOKAPI_Entity ()
virtual Standard_EXPORT Standard_Boolean IsValid () const
virtual Standard_EXPORT Standard_Boolean IsAccessible () const
virtual Standard_EXPORT Standard_Boolean IsWriteAble () const
Standard_EXPORT Standard_Boolean IsSession () const
Standard_EXPORT Standard_Boolean IsFactory () const
Standard_EXPORT Standard_Boolean IsWarehouse () const
Standard_EXPORT Standard_Boolean IsParcel () const
Standard_EXPORT Standard_Boolean IsWorkshop () const
Standard_EXPORT Standard_Boolean IsWorkbench () const
Standard_EXPORT Standard_Boolean IsUnit () const
virtual Standard_EXPORT Standard_Boolean NestedEntities (WOKAPI_SequenceOfEntity &aseq) const
Standard_EXPORT WOKAPI_Entity NestingEntity () const
Standard_EXPORT Handle_TCollection_HAsciiString Name () const
Standard_EXPORT Handle_TCollection_HAsciiString Code () const
Standard_EXPORT Handle_TCollection_HAsciiString UserPath () const
virtual Standard_EXPORT void Open (const WOKAPI_Session &aSession, const Handle(TCollection_HAsciiString)&aPath)
virtual Standard_EXPORT void Close ()
virtual Standard_EXPORT Standard_Boolean Destroy ()
Standard_EXPORT Standard_Boolean IsParameterSet (const Handle(TCollection_HAsciiString)&aname) const
Standard_EXPORT Handle_TCollection_HAsciiString EntityParameterName (const Handle(TCollection_HAsciiString)&aparam) const
Standard_EXPORT Handle_TCollection_HAsciiString ParameterValue (const Handle(TCollection_HAsciiString)&aname) const
Standard_EXPORT Handle_TCollection_HAsciiString ParameterEval (const Handle(TCollection_HAsciiString)&aname) const
Standard_EXPORT Handle_TColStd_HSequenceOfHAsciiString ParameterArguments (const Handle(TCollection_HAsciiString)&aname) const
Standard_EXPORT Handle_WOKUtils_HSequenceOfParamItem ParameterClassValues (const Handle(TCollection_HAsciiString)&aclass) const
Standard_EXPORT Handle_TColStd_HSequenceOfHAsciiString ParameterClasses () const
Standard_EXPORT Handle_TColStd_HSequenceOfHAsciiString ParameterSearchList () const
Standard_EXPORT Handle_TColStd_HSequenceOfHAsciiString ParameterClassFiles (const Handle(TCollection_HAsciiString)&aclass) const
Standard_EXPORT Handle_TCollection_HAsciiString FindParameterFile (const Handle(TCollection_HAsciiString)&afile) const
Standard_EXPORT void ParameterSet (const Handle(TCollection_HAsciiString)&aname, const Handle(TCollection_HAsciiString)&avalue) const
Standard_EXPORT void ParameterUnSet (const Handle(TCollection_HAsciiString)&aname) const
Standard_EXPORT void ParameterReset () const
Standard_EXPORT Standard_Boolean IsFileType (const Handle(TCollection_HAsciiString)&aname) const
Standard_EXPORT Standard_Boolean IsFileTypeFileDependent (const Handle(TCollection_HAsciiString)&aname) const
Standard_EXPORT Handle_TCollection_HAsciiString GetFileTypeDefinition (const Handle(TCollection_HAsciiString)&aname) const
Standard_EXPORT Handle_TCollection_HAsciiString GetFileTypeDirectory (const Handle(TCollection_HAsciiString)&aname) const
Standard_EXPORT void GetFileTypeArguments (const Handle(TCollection_HAsciiString)&aname, TColStd_SequenceOfHAsciiString &argseq) const
Standard_EXPORT void FileTypes (TColStd_SequenceOfHAsciiString &typeseq) const
Standard_EXPORT void GetFiles (TColStd_SequenceOfHAsciiString &fileseq) const
Standard_EXPORT void GetDirs (TColStd_SequenceOfHAsciiString &dirseq) const
Standard_EXPORT Standard_Boolean CheckDirs (const Standard_Boolean createifmissing=Standard_True, const Standard_Boolean besilent=Standard_False) const
Standard_EXPORT Handle_TCollection_HAsciiString GetFilePath (const Handle(TCollection_HAsciiString)&atype, const Handle(TCollection_HAsciiString)&aname) const
Standard_EXPORT Handle_TCollection_HAsciiString GetFilePath (const Handle(TCollection_HAsciiString)&atype) const
Standard_EXPORT void GetInterpFiles (Handle(WOKTools_HSequenceOfReturnValue)&files) const
Standard_EXPORT Standard_Integer GetEnvActions (const WOKAPI_Session &asession, WOKTools_Return &actions) const
virtual Standard_EXPORT Standard_Boolean HomePage (const Standard_OStream &astream) const
virtual Standard_EXPORT Standard_Boolean ItemHRef (const Standard_OStream &astream) const

Protected Member Functions

virtual Standard_EXPORT Standard_Boolean PageHeader (const Standard_OStream &astream) const
virtual Standard_EXPORT Standard_Boolean PageFooter (const Standard_OStream &astream) const

Protected Attributes

Handle_WOKernel_Entity myEntity

Private Member Functions

Standard_EXPORT void Set (const Handle(WOKernel_Entity)&anentity)
Standard_EXPORT Handle_WOKernel_Session Session () const
const Handle_WOKernel_Entity & Entity () const
Standard_EXPORT void UpdateBeforeDestroy (const Handle(WOKernel_Entity)&anesting)
Standard_EXPORT void UpdateBeforeBuild (const Handle(WOKernel_Entity)&anesting)
Standard_EXPORT Handle_TCollection_HAsciiString BuildName (const Handle(TCollection_HAsciiString)&path) const
Standard_EXPORT Handle_TCollection_HAsciiString BuildNesting (const Handle(TCollection_HAsciiString)&path) const
Standard_EXPORT Handle_WOKUtils_HSequenceOfParamItem GetBuildParameters (const WOKAPI_Session &asession, const Handle(TCollection_HAsciiString)&aname, const WOKAPI_Entity &anesting, const Handle(WOKTools_HSequenceOfDefine)&defines, const Standard_Boolean usedefaults) const
Standard_EXPORT Standard_Boolean BuildEntity (const WOKAPI_Session &asession, const Handle(TCollection_HAsciiString)&name, const WOKAPI_Entity &anesting, const Handle(WOKTools_HSequenceOfDefine)&defines, const Standard_Boolean usedefaults, const Standard_Boolean checkhome=Standard_False)

Constructor & Destructor Documentation

Standard_EXPORT WOKAPI_Entity::WOKAPI_Entity (   ) 
 

Standard_EXPORT WOKAPI_Entity::WOKAPI_Entity (  const WOKAPI_Entity &  aent  ) 
 

Standard_EXPORT WOKAPI_Entity::WOKAPI_Entity (  const WOKAPI_Session &  asession,
const Handle(TCollection_HAsciiString)&  aname,
const Standard_Boolean  verbose = Standard_False,
const Standard_Boolean  getit = Standard_True
) 
 

virtual Standard_EXPORT WOKAPI_Entity::~WOKAPI_Entity (   )  [inline, virtual]
 

Member Function Documentation

Standard_EXPORT Standard_Boolean WOKAPI_Entity::BuildEntity (  const WOKAPI_Session &  asession,
const Handle(TCollection_HAsciiString)&  name,
const WOKAPI_Entity &  anesting,
const Handle(WOKTools_HSequenceOfDefine)&  defines,
const Standard_Boolean  usedefaults,
const Standard_Boolean  checkhome = Standard_False
)  [private]
 

Standard_EXPORT Handle_TCollection_HAsciiString WOKAPI_Entity::BuildName (  const Handle(TCollection_HAsciiString)&  path  )  const [private]
 

Standard_EXPORT Handle_TCollection_HAsciiString WOKAPI_Entity::BuildNesting (  const Handle(TCollection_HAsciiString)&  path  )  const [private]
 

Standard_EXPORT Standard_Boolean WOKAPI_Entity::CheckDirs (  const Standard_Boolean  createifmissing = Standard_True,
const Standard_Boolean  besilent = Standard_False
)  const
 

virtual Standard_EXPORT void WOKAPI_Entity::Close (   )  [virtual]
 

Reimplemented in WOKAPI_Session.

Standard_EXPORT Handle_TCollection_HAsciiString WOKAPI_Entity::Code (   )  const
 

virtual Standard_EXPORT Standard_Boolean WOKAPI_Entity::Destroy (   )  [virtual]
 

Reimplemented in WOKAPI_Factory, WOKAPI_Session, WOKAPI_Unit, WOKAPI_Warehouse, WOKAPI_Workbench, and WOKAPI_Workshop.

Standard_EXPORT void WOKAPI_Entity::Destructor (   ) 
 

const Handle_WOKernel_Entity& WOKAPI_Entity::Entity (   )  const [private]
 

Standard_EXPORT Handle_TCollection_HAsciiString WOKAPI_Entity::EntityParameterName (  const Handle(TCollection_HAsciiString)&  aparam  )  const
 

Standard_EXPORT void WOKAPI_Entity::FileTypes (  TColStd_SequenceOfHAsciiString &  typeseq  )  const
 

Standard_EXPORT Handle_TCollection_HAsciiString WOKAPI_Entity::FindParameterFile (  const Handle(TCollection_HAsciiString)&  afile  )  const
 

Standard_EXPORT Handle_WOKUtils_HSequenceOfParamItem WOKAPI_Entity::GetBuildParameters (  const WOKAPI_Session &  asession,
const Handle(TCollection_HAsciiString)&  aname,
const WOKAPI_Entity &  anesting,
const Handle(WOKTools_HSequenceOfDefine)&  defines,
const Standard_Boolean  usedefaults
)  const [private]
 

Standard_EXPORT void WOKAPI_Entity::GetDirs (  TColStd_SequenceOfHAsciiString &  dirseq  )  const
 

Standard_EXPORT Standard_Integer WOKAPI_Entity::GetEnvActions (  const WOKAPI_Session &  asession,
WOKTools_Return &  actions
)  const
 

Standard_EXPORT Handle_TCollection_HAsciiString WOKAPI_Entity::GetFilePath (  const Handle(TCollection_HAsciiString)&  atype  )  const
 

Standard_EXPORT Handle_TCollection_HAsciiString WOKAPI_Entity::GetFilePath (  const Handle(TCollection_HAsciiString)&  atype,
const Handle(TCollection_HAsciiString)&  aname
)  const
 

Standard_EXPORT void WOKAPI_Entity::GetFiles (  TColStd_SequenceOfHAsciiString &  fileseq  )  const
 

Standard_EXPORT void WOKAPI_Entity::GetFileTypeArguments (  const Handle(TCollection_HAsciiString)&  aname,
TColStd_SequenceOfHAsciiString &  argseq
)  const
 

Standard_EXPORT Handle_TCollection_HAsciiString WOKAPI_Entity::GetFileTypeDefinition (  const Handle(TCollection_HAsciiString)&  aname  )  const
 

Standard_EXPORT Handle_TCollection_HAsciiString WOKAPI_Entity::GetFileTypeDirectory (  const Handle(TCollection_HAsciiString)&  aname  )  const
 

Standard_EXPORT void WOKAPI_Entity::GetInterpFiles (  Handle(WOKTools_HSequenceOfReturnValue)&  files  )  const
 

virtual Standard_EXPORT Standard_Boolean WOKAPI_Entity::HomePage (  const Standard_OStream &  astream  )  const [virtual]
 

virtual Standard_EXPORT Standard_Boolean WOKAPI_Entity::IsAccessible (   )  const [virtual]
 

Standard_EXPORT Standard_Boolean WOKAPI_Entity::IsFactory (   )  const
 

Standard_EXPORT Standard_Boolean WOKAPI_Entity::IsFileType (  const Handle(TCollection_HAsciiString)&  aname  )  const
 

Standard_EXPORT Standard_Boolean WOKAPI_Entity::IsFileTypeFileDependent (  const Handle(TCollection_HAsciiString)&  aname  )  const
 

Standard_EXPORT Standard_Boolean WOKAPI_Entity::IsParameterSet (  const Handle(TCollection_HAsciiString)&  aname  )  const
 

Standard_EXPORT Standard_Boolean WOKAPI_Entity::IsParcel (   )  const
 

Standard_EXPORT Standard_Boolean WOKAPI_Entity::IsSession (   )  const
 

Standard_EXPORT Standard_Boolean WOKAPI_Entity::IsUnit (   )  const
 

virtual Standard_EXPORT Standard_Boolean WOKAPI_Entity::IsValid (   )  const [virtual]
 

Reimplemented in WOKAPI_Factory, WOKAPI_Parcel, WOKAPI_Session, WOKAPI_Unit, WOKAPI_Warehouse, WOKAPI_Workbench, and WOKAPI_Workshop.

Standard_EXPORT Standard_Boolean WOKAPI_Entity::IsWarehouse (   )  const
 

Standard_EXPORT Standard_Boolean WOKAPI_Entity::IsWorkbench (   )  const
 

Standard_EXPORT Standard_Boolean WOKAPI_Entity::IsWorkshop (   )  const
 

virtual Standard_EXPORT Standard_Boolean WOKAPI_Entity::IsWriteAble (   )  const [virtual]
 

virtual Standard_EXPORT Standard_Boolean WOKAPI_Entity::ItemHRef (  const Standard_OStream &  astream  )  const [virtual]
 

Standard_EXPORT Handle_TCollection_HAsciiString WOKAPI_Entity::Name (   )  const
 

virtual Standard_EXPORT Standard_Boolean WOKAPI_Entity::NestedEntities (  WOKAPI_SequenceOfEntity &  aseq  )  const [virtual]
 

Reimplemented in WOKAPI_Factory, WOKAPI_Parcel, WOKAPI_Warehouse, WOKAPI_Workbench, and WOKAPI_Workshop.

Standard_EXPORT WOKAPI_Entity WOKAPI_Entity::NestingEntity (   )  const
 

virtual Standard_EXPORT void WOKAPI_Entity::Open (  const WOKAPI_Session &  aSession,
const Handle(TCollection_HAsciiString)&  aPath
)  [virtual]
 

Reimplemented in WOKAPI_Session.

void WOKAPI_Entity::operator delete (  void *  anAddress  )  [inline]
 

Reimplemented in WOKAPI_Factory, WOKAPI_Parcel, WOKAPI_Session, WOKAPI_Unit, WOKAPI_Warehouse, WOKAPI_Workbench, and WOKAPI_Workshop.

void* WOKAPI_Entity::operator new (  size_t  size  )  [inline]
 

Reimplemented in WOKAPI_Factory, WOKAPI_Parcel, WOKAPI_Session, WOKAPI_Unit, WOKAPI_Warehouse, WOKAPI_Workbench, and WOKAPI_Workshop.

void* WOKAPI_Entity::operator new (  size_t  ,
void *  anAddress
)  [inline]
 

Reimplemented in WOKAPI_Factory, WOKAPI_Parcel, WOKAPI_Session, WOKAPI_Unit, WOKAPI_Warehouse, WOKAPI_Workbench, and WOKAPI_Workshop.

virtual Standard_EXPORT Standard_Boolean WOKAPI_Entity::PageFooter (  const Standard_OStream &  astream  )  const [protected, virtual]
 

virtual Standard_EXPORT Standard_Boolean WOKAPI_Entity::PageHeader (  const Standard_OStream &  astream  )  const [protected, virtual]
 

Standard_EXPORT Handle_TColStd_HSequenceOfHAsciiString WOKAPI_Entity::ParameterArguments (  const Handle(TCollection_HAsciiString)&  aname  )  const
 

Standard_EXPORT Handle_TColStd_HSequenceOfHAsciiString WOKAPI_Entity::ParameterClasses (   )  const
 

Standard_EXPORT Handle_TColStd_HSequenceOfHAsciiString WOKAPI_Entity::ParameterClassFiles (  const Handle(TCollection_HAsciiString)&  aclass  )  const
 

Standard_EXPORT Handle_WOKUtils_HSequenceOfParamItem WOKAPI_Entity::ParameterClassValues (  const Handle(TCollection_HAsciiString)&  aclass  )  const
 

Standard_EXPORT Handle_TCollection_HAsciiString WOKAPI_Entity::ParameterEval (  const Handle(TCollection_HAsciiString)&  aname  )  const
 

Standard_EXPORT void WOKAPI_Entity::ParameterReset (   )  const
 

Standard_EXPORT Handle_TColStd_HSequenceOfHAsciiString WOKAPI_Entity::ParameterSearchList (   )  const
 

Standard_EXPORT void WOKAPI_Entity::ParameterSet (  const Handle(TCollection_HAsciiString)&  aname,
const Handle(TCollection_HAsciiString)&  avalue
)  const
 

Standard_EXPORT void WOKAPI_Entity::ParameterUnSet (  const Handle(TCollection_HAsciiString)&  aname  )  const
 

Standard_EXPORT Handle_TCollection_HAsciiString WOKAPI_Entity::ParameterValue (  const Handle(TCollection_HAsciiString)&  aname  )  const
 

Standard_EXPORT Handle_WOKernel_Session WOKAPI_Entity::Session (   )  const [private]
 

Standard_EXPORT void WOKAPI_Entity::Set (  const Handle(WOKernel_Entity)&  anentity  )  [private]
 

Standard_EXPORT void WOKAPI_Entity::UpdateBeforeBuild (  const Handle(WOKernel_Entity)&  anesting  )  [private]
 

Standard_EXPORT void WOKAPI_Entity::UpdateBeforeDestroy (  const Handle(WOKernel_Entity)&  anesting  )  [private]
 

Standard_EXPORT Handle_TCollection_HAsciiString WOKAPI_Entity::UserPath (   )  const
 

Field Documentation

Handle_WOKernel_Entity WOKAPI_Entity::myEntity [protected]
 

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