ptl Namespace Reference

Classes
class	ATDVList
	Abstract superclass for template lists that include a pointer to objects or objects as copies in the list. More...
class	AVDVList
	Base class for void-pointer lists. More...
struct	DVElement
	Element of double linked lists. More...
class	TDVList
	Template list class for pointers to objects. More...
class	VDVList
	A void-pointer list. More...

Typedefs
typedef int	ListMode

Enumerations
enum	ElementCache { M , RM }
enum	ElementPosition {   FIRST_POS , LAST_POS , CURRENT_POS , NEXT_POS ,   PREVIOUS_POS }
enum	ERRORS {   INSTANTIATE_DVELEMENT = -15001 , OBJECT_ALREADY_AVAILABLE = -15002 , ACTION_ON_EMPTY_LIST = -15003 , NO_RM_NULL = -15004 ,   NO_RM_AWAY = -15005 , OBJEKT_UNAVAILABLE = -15006 , INSTANTIATE_SUBNODE = -15007 , NO_PARENT_NODE = -15008 ,   DOUBLE_KNOTEN_ID = -15009 , INSTANTIATE_STRING = -15010 , IS_RESPONSIBLE = -15011 , SAME_SOURCE_TARGET = -15012 ,   RANGE = -15013 , PASSED_NO_OBJECT = -15014 , DOUBLE_NODE = -15015 , FATAL_MEMORY_LEAK = -15016 ,   CIRCULAR = -15017 , WRONG_NODETYPE = -15018 }
	Error range = -15001 to -15100 More...
enum	InsertPosition { InsertHEAD , InsertLAST , InsertCURRENT }
enum	NodeMode { UNSORTED , NAMED_SORTED , ID_SORTED }
enum	SeekMode { START , END , CURRENT }
enum	VH { BEFORE , BEHIND }

Variables
const ListMode	DEFAULT = 0
const ListMode	RESPONSIBLE = 2
const ListMode	UNIQUE = 1

Typedef Documentation

ListMode

typedef int ptl::ListMode

Containers can handle objects differently.

For container, whether they allow data objects more than once or only once, or whether they are the owner (responsible, or destroy also the data objects in the destructor) of these data objects.
When instantiating a list, you can also pass several modes Exclusive/Or connected like 'ptl::UNIQUE | ptl::RESPONSIBLE'. It is checked for bits.

See also

• DEFAULT
• UNIQUE
• RESPONSIBLE;

Enumeration Type Documentation

ElementCache

enum ptl::ElementCache

The pointer to the current element of a container can be stored in a buffer or restored from it.
This can be used, for example, to work through the list, which moves the current pointer, in order to then restore the current pointer.

Enumerator
M	The current element is copied to the buffer.
RM	The current element is restored from the buffer.

ElementPosition

enum ptl::ElementPosition

For DVLists, which element is meant by Get and Remove methods.

Enumerator
FIRST_POS	The first element in the container is meant.
LAST_POS	The last element in the container is meant.
CURRENT_POS	The current element in the container is meant.
NEXT_POS	The next element after the current element in the container is meant.
PREVIOUS_POS	The element before the current element in the container is meant.

ERRORS

enum ptl::ERRORS

Error range = -15001 to -15100

Enumerator
INSTANTIATE_DVELEMENT	-15001: A DVElement cannot be instantiated.
OBJECT_ALREADY_AVAILABLE	-15002: Error if an element to be inserted already exists in the container.
ACTION_ON_EMPTY_LIST	-15003: An action was cancelled because there are no elements in the list.
NO_RM_NULL	-15004: There is no cached pointer to an element in the container.
NO_RM_AWAY	-15005: A buffered pointer is to become the current pointer, exists but not anymore.
OBJEKT_UNAVAILABLE	-15006: An expected object is not in the container.
INSTANTIATE_SUBNODE	-15007: No lower node could be instantiated.
NO_PARENT_NODE	-15008: No upper node present.
DOUBLE_KNOTEN_ID	-15009: The node ID is already assigned in the tree.
INSTANTIATE_STRING	-15010: A string could not be instantiated.
IS_RESPONSIBLE	-15011: An action could not be performed because the list is responsible for its objects.
SAME_SOURCE_TARGET	-15012: An attempt was made to copy a list to itself.
RANGE	-15013: An attempt was made to iterate beyond the end or beginning of the list.
PASSED_NO_OBJECT	-15014: No object was transferred.
DOUBLE_NODE	-15015: An object to be inserted already exists in the node tree.
FATAL_MEMORY_LEAK	-15016: An unrecoverable memory error has occurred.
CIRCULAR	-15017: A node to be inserted already exists in the tree above or below the node to be inserted.
WRONG_NODETYPE	-15018: The node to be inserted is not of the correct type.

InsertPosition

enum ptl::InsertPosition

For DVLists to specify an insertion point in conjunction with VH.

See also

enum VH

Enumerator
InsertHEAD	The insertion point is before or after the first element of the list.
InsertLAST	The insertion point is before or after the last element of the list.
InsertCURRENT	The insertion point is before or after the current element of the list.

NodeMode

enum ptl::NodeMode

For NamedNode, whether subnodes insert sorted or not.

Enumerator
UNSORTED	Node inserts child nodes at the end, no sorting.
NAMED_SORTED	Node inserts subnodes sorted by name.
ID_SORTED	Node inserts subnodes sorted by ID (only possible for IDNode).

SeekMode

enum ptl::SeekMode

For DVLists, how list items should be fetched.
SeekMode is usually passed for iteration.

Enumerator
START	The first element is fetched, if available.
END	The last element is fetched, if available.
CURRENT	The current element is fetched, if available.

VH

enum ptl::VH

For DVLists, whether to insert before or after the InsertPosition.

Enumerator
BEFORE	The element is inserted into the container before the InsertPosition.
BEHIND	The element is inserted into the container after the InsertPosition.

Variable Documentation

DEFAULT

const ListMode ptl::DEFAULT = 0

The list inserts pointers multiple times and is not responsible for releasing the memory of the referenced objects

See also

typedef int ListMode

RESPONSIBLE

const ListMode ptl::RESPONSIBLE = 2

The list is responsible for releasing the memory of the referenced objects (calls the respective dtor of the objects in the list, if itself 'dying').

See also

typedef int ListMode

UNIQUE

const ListMode ptl::UNIQUE = 1

The list inserts pointers only once.

See also

typedef int ListMode