# WOK
TKWOK
WOKernel

# WOKernel_Session Class Reference

A WOK user session
Manages WOK process lifetime
.

`#include <WOKernel_Session.hxx>`

Inheritance diagram for WOKernel_Session:

[legend]

## Public Member Functions

Standard_EXPORT | WOKernel_Session (const Handle(TCollection_HAsciiString)&aname)
| instantiates Session does not Open It !!!
virtual Standard_EXPORT Handle_TCollection_HAsciiString | EntityCode () const
Standard_EXPORT Handle_WOKernel_FileTypeBase | GetFileTypeBase (const Handle(WOKernel_Entity)&anent) const
virtual Standard_EXPORT Handle_WOKUtils_HSequenceOfParamItem | BuildParameters (const Handle(WOKUtils_HSequenceOfParamItem)&someparams, const Standard_Boolean usedefaults)
| constructs Sequence of Parameters Needed by Entity to be built. Checks their consistancy
virtual Standard_EXPORT void | Build (const Handle(WOKUtils_HSequenceOfParamItem)&someparams)
| Nothing to do here .
virtual Standard_EXPORT void | Destroy ()
| Nothing either .
virtual Standard_EXPORT void | Open ()
| open an existing entity
Standard_EXPORT void | Open (const Handle(TCollection_HAsciiString)&aroot, const Handle(TCollection_HAsciiString)&libpath)
| Loads factory list .
virtual Standard_EXPORT void | Close ()
| closes session automatically closes opened entities in session
Standard_EXPORT Standard_Boolean | AddEntity (const Handle(WOKernel_Entity)&anentity)
| Adds an Entity to the map .
Standard_EXPORT Standard_Boolean | RemoveEntity (const Handle(WOKernel_Entity)&anentity)
| Removes an Entity to the map .
Standard_EXPORT Standard_Boolean | IsKnownEntity (const Handle(TCollection_HAsciiString)&auniquename) const
| Gets Entity Handle with its name .
Standard_EXPORT Standard_Boolean | IsKnownEntity (const Handle(WOKernel_Entity)&anentity) const
| Gets Entity Handle with its name .
Standard_EXPORT void | ClearEntities ()
| Clears Entity Map .
Standard_EXPORT Standard_Boolean | IsFactory (const Handle(TCollection_HAsciiString)&aname) const
Standard_EXPORT Standard_Boolean | IsWarehouse (const Handle(TCollection_HAsciiString)&aname) const
Standard_EXPORT Standard_Boolean | IsWorkshop (const Handle(TCollection_HAsciiString)&aname) const
Standard_EXPORT Standard_Boolean | IsWorkbench (const Handle(TCollection_HAsciiString)&aname) const
Standard_EXPORT Standard_Boolean | IsUnitNesting (const Handle(TCollection_HAsciiString)&aname) const
Standard_EXPORT Standard_Boolean | IsParcel (const Handle(TCollection_HAsciiString)&aname) const
Standard_EXPORT Standard_Boolean | IsDevUnit (const Handle(TCollection_HAsciiString)&aname) const
Standard_EXPORT const Handle_WOKernel_Entity & | GetEntity (const Handle(TCollection_HAsciiString)&aname) const
Standard_EXPORT const Handle_WOKernel_Factory & | GetFactory (const Handle(TCollection_HAsciiString)&aname) const
Standard_EXPORT const Handle_WOKernel_Warehouse & | GetWarehouse (const Handle(TCollection_HAsciiString)&aname) const
Standard_EXPORT const Handle_WOKernel_Workshop & | GetWorkshop (const Handle(TCollection_HAsciiString)&aname) const
Standard_EXPORT const Handle_WOKernel_UnitNesting & | GetUnitNesting (const Handle(TCollection_HAsciiString)&aname) const
Standard_EXPORT const Handle_WOKernel_Workbench & | GetWorkbench (const Handle(TCollection_HAsciiString)&aname) const
Standard_EXPORT const Handle_WOKernel_Parcel & | GetParcel (const Handle(TCollection_HAsciiString)&aname) const
Standard_EXPORT const Handle_WOKernel_DevUnit & | GetDevUnit (const Handle(TCollection_HAsciiString)&aname) const
Standard_EXPORT Handle_TColStd_HSequenceOfHAsciiString | GetMatchingEntities (const Handle(TCollection_HAsciiString)&aname, const Standard_Boolean fullpath=Standard_True) const
| renvoie les entites matchant un nom ou une partie de FullNames
Standard_EXPORT Handle_TColStd_HSequenceOfHAsciiString | Factories () const
| gives the factory sequence of Session
Standard_EXPORT void | DumpFactoryList () const
| Updates files ATLIST with myfactories .
Standard_EXPORT void | AddFactory (const Handle(WOKernel_Factory)&afact)
| Ajouter un atelier a la liste et met a jour le fichier ATLIST .
Standard_EXPORT void | RemoveFactory (const Handle(WOKernel_Factory)&afact)
| Removes the Factory from ATLIST .
Standard_EXPORT void | SetStation (const WOKernel_StationID ast)
WOKernel_StationID | Station () const
Standard_EXPORT void | SetDBMSystem (const WOKernel_DBMSID adb)
WOKernel_DBMSID | DBMSystem () const
Standard_EXPORT Standard_Boolean | DebugMode () const
Standard_EXPORT void | SetDebugMode ()
Standard_EXPORT void | UnsetDebugMode ()
Standard_EXPORT const | Handle (Standard_Type)&DynamicType() const

## Private Attributes

WOKernel_StationID | mystation
WOKernel_DBMSID | mydbms
Standard_Boolean | mydebug
WOKernel_DataMapOfHAsciiStringOfFactory | myfactories
WOKernel_DataMapOfHAsciiStringOfWarehouse | mywarehouses
WOKernel_DataMapOfHAsciiStringOfWorkshop | myworkshops
WOKernel_DataMapOfHAsciiStringOfParcel | myparcels
WOKernel_DataMapOfHAsciiStringOfWorkbench | myworkbenches
WOKernel_DataMapOfHAsciiStringOfDevUnit | myunits
Handle_WOKernel_GlobalFileTypeBase | myfiletypebases

## Constructor & Destructor Documentation

Standard_EXPORT WOKernel_Session::WOKernel_Session | ( | const Handle(TCollection_HAsciiString)& | aname | ) |

## Member Function Documentation

Standard_EXPORT Standard_Boolean WOKernel_Session::AddEntity | ( | const Handle(WOKernel_Entity)& | anentity | ) |

Standard_EXPORT void WOKernel_Session::AddFactory | ( | const Handle(WOKernel_Factory)& | afact | ) |

virtual Standard_EXPORT void WOKernel_Session::Build | ( | const Handle(WOKUtils_HSequenceOfParamItem)& | someparams | ) | `[virtual]`

| Reimplemented from WOKernel_Entity.

virtual Standard_EXPORT Handle_WOKUtils_HSequenceOfParamItem WOKernel_Session::BuildParameters | ( | const Handle(WOKUtils_HSequenceOfParamItem)& | someparams,
|  | const Standard_Boolean | usedefaults
| ) | `[virtual]`

| Reimplemented from WOKernel_Entity.

Standard_EXPORT void WOKernel_Session::ClearEntities | ( |  | ) |

virtual Standard_EXPORT void WOKernel_Session::Close | ( |  | ) | `[virtual]`

| Implements WOKernel_Entity.

WOKernel_DBMSID WOKernel_Session::DBMSystem | ( |  | ) | const`[inline]`

Standard_EXPORT Standard_Boolean WOKernel_Session::DebugMode | ( |  | ) | const

virtual Standard_EXPORT void WOKernel_Session::Destroy | ( |  | ) | `[virtual]`

| Reimplemented from WOKernel_Entity.

Standard_EXPORT void WOKernel_Session::DumpFactoryList | ( |  | ) | const

virtual Standard_EXPORT Handle_TCollection_HAsciiString WOKernel_Session::EntityCode | ( |  | ) | const`[virtual]`

| Implements WOKernel_Entity.

Standard_EXPORT Handle_TColStd_HSequenceOfHAsciiString WOKernel_Session::Factories | ( |  | ) | const

Standard_EXPORT const Handle_WOKernel_DevUnit& WOKernel_Session::GetDevUnit | ( | const Handle(TCollection_HAsciiString)& | aname | ) | const

Standard_EXPORT const Handle_WOKernel_Entity& WOKernel_Session::GetEntity | ( | const Handle(TCollection_HAsciiString)& | aname | ) | const

Standard_EXPORT const Handle_WOKernel_Factory& WOKernel_Session::GetFactory | ( | const Handle(TCollection_HAsciiString)& | aname | ) | const

Standard_EXPORT Handle_WOKernel_FileTypeBase WOKernel_Session::GetFileTypeBase | ( | const Handle(WOKernel_Entity)& | anent | ) | const

Standard_EXPORT Handle_TColStd_HSequenceOfHAsciiString WOKernel_Session::GetMatchingEntities | ( | const Handle(TCollection_HAsciiString)& | aname,
|  | const Standard_Boolean | fullpath = `Standard_True`
| ) | const

Standard_EXPORT const Handle_WOKernel_Parcel& WOKernel_Session::GetParcel | ( | const Handle(TCollection_HAsciiString)& | aname | ) | const

Standard_EXPORT const Handle_WOKernel_UnitNesting& WOKernel_Session::GetUnitNesting | ( | const Handle(TCollection_HAsciiString)& | aname | ) | const

Standard_EXPORT const Handle_WOKernel_Warehouse& WOKernel_Session::GetWarehouse | ( | const Handle(TCollection_HAsciiString)& | aname | ) | const

Standard_EXPORT const Handle_WOKernel_Workbench& WOKernel_Session::GetWorkbench | ( | const Handle(TCollection_HAsciiString)& | aname | ) | const

Standard_EXPORT const Handle_WOKernel_Workshop& WOKernel_Session::GetWorkshop | ( | const Handle(TCollection_HAsciiString)& | aname | ) | const

Standard_EXPORT const WOKernel_Session::Handle | ( | Standard_Type |  | ) | const

| Reimplemented from WOKernel_Entity.

Standard_EXPORT Standard_Boolean WOKernel_Session::IsDevUnit | ( | const Handle(TCollection_HAsciiString)& | aname | ) | const

Standard_EXPORT Standard_Boolean WOKernel_Session::IsFactory | ( | const Handle(TCollection_HAsciiString)& | aname | ) | const

Standard_EXPORT Standard_Boolean WOKernel_Session::IsKnownEntity | ( | const Handle(WOKernel_Entity)& | anentity | ) | const

Standard_EXPORT Standard_Boolean WOKernel_Session::IsKnownEntity | ( | const Handle(TCollection_HAsciiString)& | auniquename | ) | const

Standard_EXPORT Standard_Boolean WOKernel_Session::IsParcel | ( | const Handle(TCollection_HAsciiString)& | aname | ) | const

Standard_EXPORT Standard_Boolean WOKernel_Session::IsUnitNesting | ( | const Handle(TCollection_HAsciiString)& | aname | ) | const

Standard_EXPORT Standard_Boolean WOKernel_Session::IsWarehouse | ( | const Handle(TCollection_HAsciiString)& | aname | ) | const

Standard_EXPORT Standard_Boolean WOKernel_Session::IsWorkbench | ( | const Handle(TCollection_HAsciiString)& | aname | ) | const

Standard_EXPORT Standard_Boolean WOKernel_Session::IsWorkshop | ( | const Handle(TCollection_HAsciiString)& | aname | ) | const

Standard_EXPORT void WOKernel_Session::Open | ( | const Handle(TCollection_HAsciiString)& | aroot,
|  | const Handle(TCollection_HAsciiString)& | libpath
| ) |

virtual Standard_EXPORT void WOKernel_Session::Open | ( |  | ) | `[virtual]`

| Implements WOKernel_Entity.

Standard_EXPORT Standard_Boolean WOKernel_Session::RemoveEntity | ( | const Handle(WOKernel_Entity)& | anentity | ) |

Standard_EXPORT void WOKernel_Session::RemoveFactory | ( | const Handle(WOKernel_Factory)& | afact | ) |

Standard_EXPORT void WOKernel_Session::SetDBMSystem | ( | const WOKernel_DBMSID | adb | ) |

Standard_EXPORT void WOKernel_Session::SetDebugMode | ( |  | ) |

Standard_EXPORT void WOKernel_Session::SetStation | ( | const WOKernel_StationID | ast | ) |

WOKernel_StationID WOKernel_Session::Station | ( |  | ) | const`[inline]`

Standard_EXPORT void WOKernel_Session::UnsetDebugMode | ( |  | ) |

## Field Documentation

WOKernel_DBMSID WOKernel_Session::mydbms `[private]`

Standard_Boolean WOKernel_Session::mydebug `[private]`

WOKernel_DataMapOfHAsciiStringOfFactory WOKernel_Session::myfactories `[private]`

Handle_WOKernel_GlobalFileTypeBase WOKernel_Session::myfiletypebases `[private]`

WOKernel_DataMapOfHAsciiStringOfParcel WOKernel_Session::myparcels `[private]`

WOKernel_StationID WOKernel_Session::mystation `[private]`

WOKernel_DataMapOfHAsciiStringOfDevUnit WOKernel_Session::myunits `[private]`

WOKernel_DataMapOfHAsciiStringOfWarehouse WOKernel_Session::mywarehouses `[private]`

WOKernel_DataMapOfHAsciiStringOfWorkbench WOKernel_Session::myworkbenches `[private]`

WOKernel_DataMapOfHAsciiStringOfWorkshop WOKernel_Session::myworkshops `[private]`

The documentation for this class was generated from the following files:

- WOKernel_Session.hxx
- WOKernel_Session.lxx