vctl::MCEdgeS Class Reference

A container of edges in 3D space. More...

#include <mcedges.h>

Inheritance diagram for vctl::MCEdgeS:

List of all members.

Public Member Functions
virtual void	ClearAll ()
	Clears all edges currently stored in the container.
void	DeRegistrationAll ()
	Deregisters all edges in the container from vertices.
template<class S >
void	deserialize (mds::mod::CChannelSerializer< S > &Reader)
	Deserializes the container of edges.
void	Erase (MCEdge *del_ent)
	Removes an edge from the container.
MCVerticeS *	GetVerticeS ()
	Returns pointer to the internal container of vertices.
	MCEdgeS ()
	Default constructor.
	MDS_ENTITY_COMPRESSION (mds::mod::CC_RAW)
	Standard method getEntityCompression().
	MDS_ENTITY_NAME ("MCEdgesS")
	Standard method getEntityName().
MCEdge *	New (MCVertex *_u0, MCVertex *_u1)
	Returns pointer to a newly created edge.
MCEdge *	NewNoTestExistence (MCVertex *_u0, MCVertex *_u1)
	Returns pointer to a newly created edge.
template<class S >
void	serialize (mds::mod::CChannelSerializer< S > &Writer)
	Serializes the container of edges.
MCEdge *	TestExistence (MCVertex *_u0, MCVertex *_u1)
	Checks existence of an edge.
	~MCEdgeS ()
	Empty destructor.

---

Detailed Description

A container of edges in 3D space.

• Derived from the general container of entities.

---

Constructor & Destructor Documentation

vctl::MCEdgeS::MCEdgeS

(

)

[inline]

Default constructor.

vctl::MCEdgeS::~MCEdgeS

(

)

[inline]

Empty destructor.

---

Member Function Documentation

void MCEdgeS::ClearAll

(

)

[virtual]

Clears all edges currently stored in the container.

Reimplemented from vctl::MCEntitieS< MCEdge >.

void MCEdgeS::DeRegistrationAll

(

)

Deregisters all edges in the container from vertices.

template<class S >

void vctl::MCEdgeS::deserialize

(

mds::mod::CChannelSerializer< S > &

Reader

)

[inline]

Deserializes the container of edges.

void MCEdgeS::Erase

(

MCEdge *

del_ent

)

Removes an edge from the container.

• Deregisters the edge and clears the memory.

MCVerticeS* vctl::MCEdgeS::GetVerticeS

(

)

[inline]

Returns pointer to the internal container of vertices.

vctl::MCEdgeS::MDS_ENTITY_COMPRESSION

(

mds::mod::CC_RAW

)

Standard method getEntityCompression().

vctl::MCEdgeS::MDS_ENTITY_NAME

(

"MCEdgesS"

)

Standard method getEntityName().

MCEdge * MCEdgeS::New	(	MCVertex *	_u0,
		MCVertex *	_u1
	)

Returns pointer to a newly created edge.

• Checks existence of the edge.
• Returns pointer to an existing edge, or the newly created one.

MCEdge * MCEdgeS::NewNoTestExistence	(	MCVertex *	_u0,
		MCVertex *	_u1
	)

Returns pointer to a newly created edge.

• This method doesn't test existence of the edge.
• Returns pointer to the newly created edge.

template<class S >

void vctl::MCEdgeS::serialize

(

mds::mod::CChannelSerializer< S > &

Writer

)

[inline]

Serializes the container of edges.

MCEdge * MCEdgeS::TestExistence	(	MCVertex *	_u0,
		MCVertex *	_u1
	)

Checks existence of an edge.

• Returns pointer to the found edge, or NULL.

---

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

• mcedges.h
• mcedges.cpp