Kinetic::Key Concept Reference

Definition

The concept Key is a unique identifier for something in some sort of table. In general, they can be only created by the table and are returned when a appropriate new_foo() method is called on the table. There are two classes of values for a Key, valid and invalid. The latter cannot refer to something in a table. Use the method is_valid() to differentiate.

Has Models:

CGAL::Kinetic::Simulator::Event_key

CGAL::Kinetic::Active_objects_vector::Key

Public Member Functions
	Key ()
	The default constructor is guaranteed to construct an invalid key (i.e. one which is false when cast to a bool. More...

Operations
bool	is_valid () const
	This method returns false if the key was created using the default constructor or was otherwise created to be invalid. More...
std::ostream &	operator<< (std::ostream &, Key)
	Write a text description of the key to a standard stream. More...

Constructor & Destructor Documentation

Kinetic::Key::Key

(

)

The default constructor is guaranteed to construct an invalid key (i.e. one which is false when cast to a bool.

Member Function Documentation

bool Kinetic::Key::is_valid

(

)

const

This method returns false if the key was created using the default constructor or was otherwise created to be invalid.

std::ostream& Kinetic::Key::operator<<	(	std::ostream &	,
		Key
	)

Write a text description of the key to a standard stream.