sheaf::schema_descriptor Class Reference

A description of a dof in a schema. More...

#include <schema_descriptor.h>

Inheritance diagram for sheaf::schema_descriptor:

Public Member Functions
virtual bool	is_ancestor_of (const any *other) const
	Conformance test; true if other conforms to this. More...
virtual schema_descriptor *	clone () const
	Virtual constructor, makes a new instance of the same type as this. More...
bool	operator== (const schema_descriptor &xother) const
	Equality operator. More...
virtual bool	invariant () const
	Class invariant. More...
	schema_descriptor ()
	Default constructor. More...
	schema_descriptor (const schema_descriptor &xother)
	Copy constructor. More...
	schema_descriptor (const std::string &xname, primitive_type xtype=NOT_A_PRIMITIVE_TYPE, bool xis_table_dof=true)
	Creates an instance with name == xname, type == xtype, and is_table_dof == xis_table_dof. More...
virtual	~schema_descriptor ()
	Destructor. More...
Public Member Functions inherited from sheaf::any
bool	is_same_type (const any *other) const
	True if other is the same type as this. More...
virtual	~any ()
	Destructor. More...
bool	invariant_check () const
	True if invariant checking is enabled. More...
void	enable_invariant_check () const
	Enable invariant checking. More...
void	disable_invariant_check () const
	Disable invariant check. Intended for preventing recursive calls to invariant and for suppressing invariant checking during multi-phase initialization. More...
int	disable_invariance_check_request_depth () const
	Number of times disable_invariant_check has been called without matching call to enable_invariant_check. More...

Public Attributes
std::string	name
	The name of the dof described by this. More...
primitive_type	type
	The type of the dof described by this. More...
bool	is_table_dof
	The role of the dof described by this; true if this describes a table dof. More...

Additional Inherited Members
Protected Member Functions inherited from sheaf::any
	any ()
	default constructor More...

Detailed Description

A description of a dof in a schema.

Definition at line 45 of file schema_descriptor.h.

Constructor & Destructor Documentation

schema_descriptor() [1/3]

sheaf::schema_descriptor::schema_descriptor

(

)

Default constructor.

Postcondition

• invariant()

• name.empty()

• type == NOT_A_PRIMITIVE_TYPE

• !is_table_dof

Definition at line 141 of file schema_descriptor.cc.

Referenced by invariant(), and schema_descriptor().

schema_descriptor() [2/3]

sheaf::schema_descriptor::schema_descriptor

(

const schema_descriptor &

xother

)

Copy constructor.

Postcondition

• invariant()

• *this == xother

Definition at line 167 of file schema_descriptor.cc.

References schema_descriptor().

schema_descriptor() [3/3]

sheaf::schema_descriptor::schema_descriptor	(	const std::string &	xname,
		primitive_type	xtype = NOT_A_PRIMITIVE_TYPE,
		bool	xis_table_dof = true
	)

Creates an instance with name == xname, type == xtype, and is_table_dof == xis_table_dof.

Postcondition

• name == xname

• type == xtype

• is_table_dof == xis_table_dof

Definition at line 189 of file schema_descriptor.cc.

References ~schema_descriptor().

~schema_descriptor()

sheaf::schema_descriptor::~schema_descriptor ( )

virtual

Destructor.

Definition at line 214 of file schema_descriptor.cc.

Referenced by schema_descriptor().

Member Function Documentation

clone()

sheaf::schema_descriptor * sheaf::schema_descriptor::clone ( ) const

virtual

Virtual constructor, makes a new instance of the same type as this.

Postcondition

• result != 0

• is_same_type(result)

Reimplemented from sheaf::any.

Definition at line 55 of file schema_descriptor.cc.

References operator==().

Referenced by is_ancestor_of().

invariant()

bool sheaf::schema_descriptor::invariant ( ) const

virtual

Class invariant.

Invariant

• any::invariant()

Reimplemented from sheaf::any.

Definition at line 105 of file schema_descriptor.cc.

References schema_descriptor().

Referenced by operator==().

is_ancestor_of()

bool sheaf::schema_descriptor::is_ancestor_of ( const any *  other ) const

virtual

Conformance test; true if other conforms to this.

Precondition

• other != 0

Reimplemented from sheaf::any.

Definition at line 34 of file schema_descriptor.cc.

References clone().

operator==()

bool sheaf::schema_descriptor::operator==

(

const schema_descriptor &

xother

)

const

Equality operator.

Definition at line 80 of file schema_descriptor.cc.

References invariant(), is_table_dof, name, and type.

Referenced by clone().

Member Data Documentation

is_table_dof

bool sheaf::schema_descriptor::is_table_dof

The role of the dof described by this; true if this describes a table dof.

Definition at line 120 of file schema_descriptor.h.

Referenced by sheaf::operator<<(), operator==(), and sheaf::operator>>().

name

std::string sheaf::schema_descriptor::name

The name of the dof described by this.

Definition at line 109 of file schema_descriptor.h.

Referenced by sheaf::operator<<(), operator==(), and sheaf::operator>>().

type

primitive_type sheaf::schema_descriptor::type

The type of the dof described by this.

Definition at line 114 of file schema_descriptor.h.

Referenced by sheaf::operator<<(), operator==(), and sheaf::operator>>().

---

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

• schema_descriptor.h
• schema_descriptor.cc