EDL session class.
More...
#include <isession.h>
|
| virtual bool | setFactory (IEDLClassFactory *pFactory)=0 |
| | initializes Session by setting EDL class Factory More...
|
| |
| virtual IEDLClassFactory * | getFactory ()=0 |
| | EDL Class Factory getter method. More...
|
| |
| virtual IMessageHandlerPtr | getMessageHandler ()=0 |
| | Obtain the session's message handler. More...
|
| |
| virtual ILiteMessageHandlerPtr | getLiteMessageHandler ()=0 |
| | Obtain the session's litemessage handler. More...
|
| |
| virtual bool | setTemporaryDirectory (const EDLSysString &sTempDirectory)=0 |
| | Set the temporary directory to be used by EDL and filters for this session. More...
|
| |
| virtual bool | getTemporaryDirectory (EDLSysString &sTempDirectory)=0 |
| | Get the temporary directory to be used by EDL and filters for this session. More...
|
| |
| virtual IEDLTempStorePtr | getTempStore ()=0 |
| | Get the temporary store for this session. The temporary directory must be set before calling this member. Throws an IEDLError on failure. More...
|
| |
| virtual bool | setStartupDirectory (const EDLSysString &sStartupDirectory)=0 |
| | Set the startup directory. This is meaningfull for executable environments. Note the client must set this during initalisation for it to be valid. More...
|
| |
| virtual bool | getStartupDirectory (EDLSysString &sStartupDirectory)=0 |
| | Get the startup directory. More...
|
| |
| virtual const CClassID & | getClassID () const =0 |
| | Returns class ID of IEDLObject. More...
|
| |
| virtual bool | init (CClassParams *pData) |
| | The init() method is called to perform any post-construction initialization of an IEDLObject that has been created by the EDL class factory, before it is actually returned by the factory. More...
|
| |
| virtual bool | clone (IEDLObjectPtr &ptrObject, IEDLClassFactory *pFactory) |
| | Create a copy of EDLObject. More...
|
| |
|
virtual void | addRef () const =0 |
| | Increases the reference count of the actual object pointed to. This would take place during an assignment or copying.
|
| |
| virtual bool | decRef () const =0 |
| | Decreases the reference count of the actual object pointed to. When the reference count falls to Zero, it deletes the actual object pointed to. More...
|
| |
| virtual int32 | getRefCount () const =0 |
| | Retrieve the current reference count of the actual object pointed to. More...
|
| |
◆ getFactory()
EDL Class Factory getter method.
- Returns
- IEDLClassFactory* Returns pointer to EDL class factory
◆ getLiteMessageHandler()
| virtual ILiteMessageHandlerPtr ISession::getLiteMessageHandler |
( |
| ) |
|
|
pure virtual |
Obtain the session's litemessage handler.
Each session also contains a litemessage handler, used to deal with litemessages. The Litemessage framework will eventually be taken over by the proper messaging framework.
- Returns
- ILiteMessageHandlerPtr Returns Smart pointer to a litemessage handler object.
◆ getMessageHandler()
| virtual IMessageHandlerPtr ISession::getMessageHandler |
( |
| ) |
|
|
pure virtual |
Obtain the session's message handler.
Each session has a message handler, used to deal with messages sent between various components being used in the context of a particular session. This returns a pointer to a session's message handler.
- Returns
- IMessageHandlerPtr Smart pointer to a message handler object.
◆ getStartupDirectory()
| virtual bool ISession::getStartupDirectory |
( |
EDLSysString & |
sStartupDirectory | ) |
|
|
pure virtual |
Get the startup directory.
- Parameters
-
| sStartupDirectory | The path of the directory that the execuatble started. |
- Returns
- bool Returns true on success.
◆ getTemporaryDirectory()
| virtual bool ISession::getTemporaryDirectory |
( |
EDLSysString & |
sTempDirectory | ) |
|
|
pure virtual |
Get the temporary directory to be used by EDL and filters for this session.
- Parameters
-
| sTempDirectory | A reference to receive path to the temp directory. |
- Returns
- bool Returns true on success.
◆ getTempStore()
| virtual IEDLTempStorePtr ISession::getTempStore |
( |
| ) |
|
|
pure virtual |
Get the temporary store for this session. The temporary directory must be set before calling this member. Throws an IEDLError on failure.
- Returns
- IEDLTempStorePtr The temp store.
◆ setFactory()
initializes Session by setting EDL class Factory
- Parameters
-
| pFactory | Ptr to EDL Class Factory |
- Returns
- bool Returns true on success
◆ setStartupDirectory()
| virtual bool ISession::setStartupDirectory |
( |
const EDLSysString & |
sStartupDirectory | ) |
|
|
pure virtual |
Set the startup directory. This is meaningfull for executable environments. Note the client must set this during initalisation for it to be valid.
- Parameters
-
| sStartupDirectory | The path of the directory that the executable started. |
- Returns
- bool Returns true on success.
◆ setTemporaryDirectory()
| virtual bool ISession::setTemporaryDirectory |
( |
const EDLSysString & |
sTempDirectory | ) |
|
|
pure virtual |
Set the temporary directory to be used by EDL and filters for this session.
- Parameters
-
| sTempDirectory | The path to the temp directory. This directory must exist and the path must not be zero length. Note that for safety, this should be an absolute path. |
- Returns
- bool Returns true on success.
The documentation for this class was generated from the following file:
Public Member Functions inherited from IEDLObject