sdSession Class Reference


Public Methods

sdNameSpace * getNameSpace (const std::string &name) const
void destroyContents (sdNameSpace *nameSpace)
NameSpaceConstIter begin () const
NameSpaceConstIter end () const

Static Public Methods

sdSession * get ()

Public Types

typedef std::vector< const sdNameSpace * > NameSpaceVector
typedef NameSpaceVector::const_iterator NameSpaceConstIter

Friends

class sdNameSpace

Detailed Description

The sdSession class manages the sdNameSpace objects in a session. There is one and only one sdSession instance in any given process.

The sdSession::getNameSpace function verifies that all dependent namespaces of the specified namespace have already been added to the session. The getNameSpace function also recursively initializes the dependent namespaces if necessary. This means that namespaces can be added to the session independent of the order of dependencies. In addition, namespaces are initialized in the correct order in the getNameSpace function.

The removeNameSpace function removes the namespace if there are no dependent namespaces in the session.

Member Typedef Documentation

typedef NameSpaceVector::const_iterator sdSession::NameSpaceConstIter
 

typedef std::vector<const sdNameSpace*> sdSession::NameSpaceVector
 

Member Function Documentation

NameSpaceConstIter sdSession::begin (    )  const
 

This function returns a constant iterator that points to the first namespace in this session.

void sdSession::destroyContents (  sdNameSpace *    nameSpace ) 
 

This function destroys the objects in the specified nameSpace and clears all object maps in the namespace. The namespace is not removed from the session.

Parameters:
nameSpace A pointer to an sdNameSpace.
Exceptions:
sdcCannotDestroyAReferencedNameSpace 

NameSpaceConstIter sdSession::end (    )  const
 

This function returns a constant iterator that points to the last namespace in this session.

sdSession * sdSession::get (    )  [static]
 

This returns the singleton object of the oaSession class.

sdNameSpace * sdSession::getNameSpace (  const std::string &    name )  const
 

This function returns the sdNameSpace with the specified name. If a namespace does not exist with the specified name, NULL is returned. If the namespace is found, this function verifies that all dependent namespaces also are registered with the session and are initialized.

Parameters:
name The name of the sdNameSpace.
Exceptions:
sdcDependentNameSpaceNotRegistered 

Friends And Related Function Documentation

friend class sdNameSpace [friend]
 

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

Return to top of page




Copyright © 2002 - 2010 Cadence Design Systems, Inc.
All Rights Reserved.