# WOK
TKWOK
WOKAPI

# WOKAPI_Session Class Reference

Manages Session API for WOK
.

`#include <WOKAPI_Session.hxx>`

Inheritance diagram for WOKAPI_Session:

[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_Session ()
Standard_EXPORT Standard_Integer | Open (const Handle(TCollection_HAsciiString)&alocation=NULL, const Handle(TCollection_HAsciiString)&astation=NULL)
virtual Standard_EXPORT void | Open (const WOKAPI_Session &aSession, const Handle(TCollection_HAsciiString)&aPath)
virtual Standard_EXPORT void | Close ()
Standard_EXPORT void | GeneralFailure (const Handle(Standard_Failure)&afailure)
virtual Standard_EXPORT Standard_Boolean | IsValid () const
Standard_EXPORT Handle_WOKUtils_Path | Path () const
Standard_EXPORT void | SetPath (const Handle(WOKUtils_Path)&apath)
Standard_EXPORT Handle_TCollection_HAsciiString | CWEntityName () const
Standard_EXPORT WOKAPI_Entity | GetCWEntity () const
Standard_EXPORT void | SetCWEntity (const WOKAPI_Entity &anent)
Standard_EXPORT void | Factories (WOKAPI_SequenceOfFactory &factseq) const
Standard_EXPORT Handle_TCollection_HAsciiString | Station () const
Standard_EXPORT Standard_Boolean | SetStation (const Handle(TCollection_HAsciiString)&astation)
Standard_EXPORT Handle_TCollection_HAsciiString | DBMSystem () const
Standard_EXPORT Standard_Boolean | SetDBMSystem (const Handle(TCollection_HAsciiString)&adbms)
Standard_EXPORT Standard_Boolean | DebugMode () const
Standard_EXPORT void | SetDebugMode (const Standard_Boolean amode)
Standard_EXPORT Standard_Boolean | IsValidPath (const Handle(TCollection_HAsciiString)&apath) const
virtual Standard_EXPORT Standard_Boolean | Destroy ()

## Private Member Functions

Standard_EXPORT WOKUtils_Param | Param () const
Standard_EXPORT void | SaveToFile () const
| Sauve les parametres de session dans le fichier .
Standard_EXPORT Handle_WOKernel_Entity | OpenPath (const Handle(TCollection_HAsciiString)&apath, const Standard_Boolean besilent=Standard_False) const
Standard_EXPORT Handle_WOKernel_Entity | GetEntity (const Handle(TCollection_HAsciiString)&ahumanpath, const Standard_Boolean fatal=Standard_True) const
Standard_EXPORT Handle_WOKernel_Factory | GetFactory (const Handle(TCollection_HAsciiString)&ahumanpath, const Standard_Boolean fatal=Standard_True, const Standard_Boolean getit=Standard_True) const
Standard_EXPORT Handle_WOKernel_Warehouse | GetWarehouse (const Handle(TCollection_HAsciiString)&ahumanpath, const Standard_Boolean fatal=Standard_True, const Standard_Boolean getit=Standard_True) const
Standard_EXPORT Handle_WOKernel_Parcel | GetParcel (const Handle(TCollection_HAsciiString)&ahumanpath, const Standard_Boolean fatal=Standard_True, const Standard_Boolean getit=Standard_True) const
Standard_EXPORT Handle_WOKernel_Workshop | GetWorkshop (const Handle(TCollection_HAsciiString)&ahumanpath, const Standard_Boolean fatal=Standard_True, const Standard_Boolean getit=Standard_True) const
Standard_EXPORT Handle_WOKernel_Workbench | GetWorkbench (const Handle(TCollection_HAsciiString)&ahumanpath, const Standard_Boolean fatal=Standard_True, const Standard_Boolean getit=Standard_True) const
Standard_EXPORT Handle_WOKernel_DevUnit | GetDevUnit (const Handle(TCollection_HAsciiString)&ahumanpath, const Standard_Boolean fatal=Standard_True, const Standard_Boolean getit=Standard_True) const

## Private Attributes

Handle_WOKUtils_Path | mypath
WOKUtils_Param | myparams
Handle_TCollection_HAsciiString | mycwe

## Friends

Standard_EXPORT | WOKAPI_Entity::WOKAPI_Entity (const WOKAPI_Session &asession, const Handle(TCollection_HAsciiString)&aname, const Standard_Boolean verbose, const Standard_Boolean getit)
Standard_EXPORT | WOKAPI_Factory::WOKAPI_Factory (const WOKAPI_Session &asession, const Handle(TCollection_HAsciiString)&aname, const Standard_Boolean verbose, const Standard_Boolean getit)
Standard_EXPORT | WOKAPI_Workshop::WOKAPI_Workshop (const WOKAPI_Session &asession, const Handle(TCollection_HAsciiString)&aname, const Standard_Boolean verbose, const Standard_Boolean getit)
Standard_EXPORT | WOKAPI_Warehouse::WOKAPI_Warehouse (const WOKAPI_Session &asession, const Handle(TCollection_HAsciiString)&aname, const Standard_Boolean verbose, const Standard_Boolean getit)
Standard_EXPORT | WOKAPI_Parcel::WOKAPI_Parcel (const WOKAPI_Session &asession, const Handle(TCollection_HAsciiString)&aname, const Standard_Boolean verbose, const Standard_Boolean getit)
Standard_EXPORT | WOKAPI_Workbench::WOKAPI_Workbench (const WOKAPI_Session &asession, const Handle(TCollection_HAsciiString)&aname, const Standard_Boolean verbose, const Standard_Boolean getit)
Standard_EXPORT | WOKAPI_Unit::WOKAPI_Unit (const WOKAPI_Session &asession, const Handle(TCollection_HAsciiString)&aname, const Standard_Boolean verbose, const Standard_Boolean getit)

## Constructor & Destructor Documentation

Standard_EXPORT WOKAPI_Session::WOKAPI_Session | ( |  | ) |

## Member Function Documentation

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

| Reimplemented from WOKAPI_Entity.

Standard_EXPORT Handle_TCollection_HAsciiString WOKAPI_Session::CWEntityName | ( |  | ) | const

Standard_EXPORT Handle_TCollection_HAsciiString WOKAPI_Session::DBMSystem | ( |  | ) | const

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

virtual Standard_EXPORT Standard_Boolean WOKAPI_Session::Destroy | ( |  | ) | `[virtual]`

| Reimplemented from WOKAPI_Entity.

Standard_EXPORT void WOKAPI_Session::Factories | ( | WOKAPI_SequenceOfFactory & | factseq | ) | const

Standard_EXPORT void WOKAPI_Session::GeneralFailure | ( | const Handle(Standard_Failure)& | afailure | ) |

Standard_EXPORT WOKAPI_Entity WOKAPI_Session::GetCWEntity | ( |  | ) | const

Standard_EXPORT Handle_WOKernel_DevUnit WOKAPI_Session::GetDevUnit | ( | const Handle(TCollection_HAsciiString)& | ahumanpath,
|  | const Standard_Boolean | fatal = `Standard_True`,
|  | const Standard_Boolean | getit = `Standard_True`
| ) | const`[private]`

Standard_EXPORT Handle_WOKernel_Entity WOKAPI_Session::GetEntity | ( | const Handle(TCollection_HAsciiString)& | ahumanpath,
|  | const Standard_Boolean | fatal = `Standard_True`
| ) | const`[private]`

Standard_EXPORT Handle_WOKernel_Factory WOKAPI_Session::GetFactory | ( | const Handle(TCollection_HAsciiString)& | ahumanpath,
|  | const Standard_Boolean | fatal = `Standard_True`,
|  | const Standard_Boolean | getit = `Standard_True`
| ) | const`[private]`

Standard_EXPORT Handle_WOKernel_Parcel WOKAPI_Session::GetParcel | ( | const Handle(TCollection_HAsciiString)& | ahumanpath,
|  | const Standard_Boolean | fatal = `Standard_True`,
|  | const Standard_Boolean | getit = `Standard_True`
| ) | const`[private]`

Standard_EXPORT Handle_WOKernel_Warehouse WOKAPI_Session::GetWarehouse | ( | const Handle(TCollection_HAsciiString)& | ahumanpath,
|  | const Standard_Boolean | fatal = `Standard_True`,
|  | const Standard_Boolean | getit = `Standard_True`
| ) | const`[private]`

Standard_EXPORT Handle_WOKernel_Workbench WOKAPI_Session::GetWorkbench | ( | const Handle(TCollection_HAsciiString)& | ahumanpath,
|  | const Standard_Boolean | fatal = `Standard_True`,
|  | const Standard_Boolean | getit = `Standard_True`
| ) | const`[private]`

Standard_EXPORT Handle_WOKernel_Workshop WOKAPI_Session::GetWorkshop | ( | const Handle(TCollection_HAsciiString)& | ahumanpath,
|  | const Standard_Boolean | fatal = `Standard_True`,
|  | const Standard_Boolean | getit = `Standard_True`
| ) | const`[private]`

virtual Standard_EXPORT Standard_Boolean WOKAPI_Session::IsValid | ( |  | ) | const`[virtual]`

| Reimplemented from WOKAPI_Entity.

Standard_EXPORT Standard_Boolean WOKAPI_Session::IsValidPath | ( | const Handle(TCollection_HAsciiString)& | apath | ) | const

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

| Reimplemented from WOKAPI_Entity.

Standard_EXPORT Standard_Integer WOKAPI_Session::Open | ( | const Handle(TCollection_HAsciiString)& | alocation = `NULL`,
|  | const Handle(TCollection_HAsciiString)& | astation = `NULL`
| ) |

Standard_EXPORT Handle_WOKernel_Entity WOKAPI_Session::OpenPath | ( | const Handle(TCollection_HAsciiString)& | apath,
|  | const Standard_Boolean | besilent = `Standard_False`
| ) | const`[private]`

void WOKAPI_Session::operator delete | ( | void * | anAddress | ) | `[inline]`

| Reimplemented from WOKAPI_Entity.

void* WOKAPI_Session::operator new | ( | size_t | size | ) | `[inline]`

| Reimplemented from WOKAPI_Entity.

void* WOKAPI_Session::operator new | ( | size_t | ,
|  | void * | anAddress
| ) | `[inline]`

| Reimplemented from WOKAPI_Entity.

Standard_EXPORT WOKUtils_Param WOKAPI_Session::Param | ( |  | ) | const`[private]`

Standard_EXPORT Handle_WOKUtils_Path WOKAPI_Session::Path | ( |  | ) | const

Standard_EXPORT void WOKAPI_Session::SaveToFile | ( |  | ) | const`[private]`

Standard_EXPORT void WOKAPI_Session::SetCWEntity | ( | const WOKAPI_Entity & | anent | ) |

Standard_EXPORT Standard_Boolean WOKAPI_Session::SetDBMSystem | ( | const Handle(TCollection_HAsciiString)& | adbms | ) |

Standard_EXPORT void WOKAPI_Session::SetDebugMode | ( | const Standard_Boolean | amode | ) |

Standard_EXPORT void WOKAPI_Session::SetPath | ( | const Handle(WOKUtils_Path)& | apath | ) |

Standard_EXPORT Standard_Boolean WOKAPI_Session::SetStation | ( | const Handle(TCollection_HAsciiString)& | astation | ) |

Standard_EXPORT Handle_TCollection_HAsciiString WOKAPI_Session::Station | ( |  | ) | const

## Friends And Related Function Documentation

Standard_EXPORT WOKAPI_Entity::WOKAPI_Entity | ( | const WOKAPI_Session & | asession,
|  | const Handle(TCollection_HAsciiString)& | aname,
|  | const Standard_Boolean | verbose,
|  | const Standard_Boolean | getit
| ) | `[friend]`

Standard_EXPORT WOKAPI_Factory::WOKAPI_Factory | ( | const WOKAPI_Session & | asession,
|  | const Handle(TCollection_HAsciiString)& | aname,
|  | const Standard_Boolean | verbose,
|  | const Standard_Boolean | getit
| ) | `[friend]`

Standard_EXPORT WOKAPI_Parcel::WOKAPI_Parcel | ( | const WOKAPI_Session & | asession,
|  | const Handle(TCollection_HAsciiString)& | aname,
|  | const Standard_Boolean | verbose,
|  | const Standard_Boolean | getit
| ) | `[friend]`

Standard_EXPORT WOKAPI_Unit::WOKAPI_Unit | ( | const WOKAPI_Session & | asession,
|  | const Handle(TCollection_HAsciiString)& | aname,
|  | const Standard_Boolean | verbose,
|  | const Standard_Boolean | getit
| ) | `[friend]`

Standard_EXPORT WOKAPI_Warehouse::WOKAPI_Warehouse | ( | const WOKAPI_Session & | asession,
|  | const Handle(TCollection_HAsciiString)& | aname,
|  | const Standard_Boolean | verbose,
|  | const Standard_Boolean | getit
| ) | `[friend]`

Standard_EXPORT WOKAPI_Workbench::WOKAPI_Workbench | ( | const WOKAPI_Session & | asession,
|  | const Handle(TCollection_HAsciiString)& | aname,
|  | const Standard_Boolean | verbose,
|  | const Standard_Boolean | getit
| ) | `[friend]`

Standard_EXPORT WOKAPI_Workshop::WOKAPI_Workshop | ( | const WOKAPI_Session & | asession,
|  | const Handle(TCollection_HAsciiString)& | aname,
|  | const Standard_Boolean | verbose,
|  | const Standard_Boolean | getit
| ) | `[friend]`

## Field Documentation

Handle_TCollection_HAsciiString WOKAPI_Session::mycwe `[private]`

WOKUtils_Param WOKAPI_Session::myparams `[private]`

Handle_WOKUtils_Path WOKAPI_Session::mypath `[private]`

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

- WOKAPI_Session.hxx