torc::physical::PrimitiveSet Class Reference

PrimitiveSet. More...

#include <PrimitiveSet.hpp>

Inheritance diagram for torc::physical::PrimitiveSet:

[legend]

Collaboration diagram for torc::physical::PrimitiveSet:

[legend]

List of all members.

Public Types
typedef PrimitiveSharedPtrVector::const_iterator	PrimitiveSharedPtrConstIterator
	Constant iterator for Primitive shared pointers.
typedef PrimitiveSharedPtrVector::iterator	PrimitiveSharedPtrIterator
	Non-constant iterator for Primitive shared pointers.
Public Member Functions
PrimitiveSharedPtrIterator	findPrimitive (const string &inName)
	Find a PrimitiveSet primitive by name.
bool	addPrimitive (PrimitiveSharedPtr &inPrimitivePtr)
	Add a primitive to the PrimitiveSet.
bool	removePrimitive (PrimitiveSharedPtr &inPrimitivePtr)
	Remove a primitive from the PrimitiveSet.
size_t	getPrimitiveCount (void) const
PrimitiveSharedPtrConstIterator	primitivesBegin (void) const
	Returns the begin constant iterator for primitives.
PrimitiveSharedPtrConstIterator	primitivesEnd (void) const
	Returns the end constant iterator for primitives.
PrimitiveSharedPtrIterator	primitivesBegin (void)
	Returns the begin non-constant iterator for primitives.
PrimitiveSharedPtrIterator	primitivesEnd (void)
	Returns the end non-constant iterator for primitives.
Protected Types
typedef std::string	string
	Imported type name.
Protected Member Functions
	PrimitiveSet (const string &inName)
Protected Attributes
PrimitiveSharedPtrVector	mPrimitives
	Vector of primitive shared pointers.
Friends
class	RcFactory
	The Factory class has direct access to our internals.

---

Detailed Description

PrimitiveSet.

Definition at line 30 of file PrimitiveSet.hpp.

---

Member Typedef Documentation

typedef std::string torc::physical::PrimitiveSet::string [protected]

Imported type name.

Reimplemented from torc::physical::Named.

Definition at line 40 of file PrimitiveSet.hpp.

typedef PrimitiveSharedPtrVector::const_iterator torc::physical::PrimitiveSet::PrimitiveSharedPtrConstIterator

Constant iterator for Primitive shared pointers.

Definition at line 51 of file PrimitiveSet.hpp.

typedef PrimitiveSharedPtrVector::iterator torc::physical::PrimitiveSet::PrimitiveSharedPtrIterator

Non-constant iterator for Primitive shared pointers.

Definition at line 53 of file PrimitiveSet.hpp.

---

Member Function Documentation

PrimitiveSharedPtrIterator torc::physical::PrimitiveSet::findPrimitive

(

const string &

inName

)

[inline]

Find a PrimitiveSet primitive by name.

Parameters:

inName

The primitive name to look for.

Returns:

an iterator for the specified primitive, or primitivesEnd() if the name was not found.

Definition at line 59 of file PrimitiveSet.hpp.

bool torc::physical::PrimitiveSet::addPrimitive

(

PrimitiveSharedPtr &

inPrimitivePtr

)

[inline]

Add a primitive to the PrimitiveSet.

Parameters:

inPrimitivePtr

The primitive to add.

Returns:

true if the primitive was added, or false if a primitive with the same name already exists in the PrimitiveSet.

Todo:

Acquire mutex.

Todo:

Release mutex.

Definition at line 67 of file PrimitiveSet.hpp.

bool torc::physical::PrimitiveSet::removePrimitive

(

PrimitiveSharedPtr &

inPrimitivePtr

)

[inline]

Remove a primitive from the PrimitiveSet.

Parameters:

inPrimitivePtr

The primitive to remove.

Returns:

true if the primitive was remove, or false if the primitive did not exist.

Todo:

Acquire mutex.

Todo:

Release mutex.

Definition at line 78 of file PrimitiveSet.hpp.

PrimitiveSharedPtrConstIterator torc::physical::PrimitiveSet::primitivesBegin

(

void

)

const [inline]

Returns the begin constant iterator for primitives.

Definition at line 94 of file PrimitiveSet.hpp.

PrimitiveSharedPtrConstIterator torc::physical::PrimitiveSet::primitivesEnd

(

void

)

const [inline]

Returns the end constant iterator for primitives.

Definition at line 96 of file PrimitiveSet.hpp.

PrimitiveSharedPtrIterator torc::physical::PrimitiveSet::primitivesBegin

(

void

)

[inline]

Returns the begin non-constant iterator for primitives.

Definition at line 98 of file PrimitiveSet.hpp.

PrimitiveSharedPtrIterator torc::physical::PrimitiveSet::primitivesEnd

(

void

)

[inline]

Returns the end non-constant iterator for primitives.

Definition at line 100 of file PrimitiveSet.hpp.

---

Friends And Related Function Documentation

friend class RcFactory [friend]

The Factory class has direct access to our internals.

Definition at line 34 of file PrimitiveSet.hpp.

---

Member Data Documentation

PrimitiveSharedPtrVector torc::physical::PrimitiveSet::mPrimitives [protected]

Vector of primitive shared pointers.

Definition at line 43 of file PrimitiveSet.hpp.

---

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

• torc/packer/PrimitiveSet.hpp