Type Class Reference

Type data class. More...

#include <Graph_data.h>

Public Member Functions
	~Type ()
	Destructor.
type_t	GetId () const
	Gets the Sparksee type identifier.
ObjectType	GetObjectType () const
	Gets the object type.
const std::wstring &	GetName () const
	Gets the unique type name.
int64_t	GetNumObjects () const
	Gets the number of objects belonging to the type.
bool_t	GetIsDirected () const
	Gets if this is a directed edge type.
bool_t	GetIsRestricted () const
	Gets if this is a restricted edge type.
bool_t	GetAreNeighborsIndexed () const
	Gets if this is an edge type with neighbors index.
type_t	GetRestrictedFrom () const
	Gets the tail or source type identifier for restricted edge types.
type_t	GetRestrictedTo () const
	Gets the head or target type identifier for restricted edge types.

Static Public Attributes
static const type_t	InvalidType
	Invalid type identifier.
static const type_t	GlobalType
	Global type identifier.
static const type_t	NodesType
	Identifier for all nodeType attributes.
static const type_t	EdgesType
	Identifier for all edgeType attributes.

Friends
class	Graph

Detailed Description

Type data class.

It contains information about a node or edge type.

Author

Sparsity Technologies http://www.sparsity-technologies.com

Member Function Documentation

GetAreNeighborsIndexed()

bool_t Type::GetAreNeighborsIndexed ( ) const

inline

Gets if this is an edge type with neighbors index.

Returns

TRUE for edges types with neighbors index, FALSE otherwise.

GetId()

type_t Type::GetId ( ) const

inline

Gets the Sparksee type identifier.

Returns

The Sparksee type identifier.

GetIsDirected()

bool_t Type::GetIsDirected ( ) const

inline

Gets if this is a directed edge type.

Returns

TRUE for directed edge types, FALSE otherwise.

GetIsRestricted()

bool_t Type::GetIsRestricted ( ) const

inline

Gets if this is a restricted edge type.

Returns

TRUE for restricted edge types, FALSE otherwise.

GetName()

const std::wstring & Type::GetName ( ) const

inline

Gets the unique type name.

Returns

The unique type name.

GetNumObjects()

int64_t Type::GetNumObjects ( ) const

inline

Gets the number of objects belonging to the type.

Returns

The number of objects belonging to the type.

GetObjectType()

ObjectType Type::GetObjectType ( ) const

inline

Gets the object type.

Returns

The object type.

GetRestrictedFrom()

type_t Type::GetRestrictedFrom ( ) const

inline

Gets the tail or source type identifier for restricted edge types.

Returns

For restricted edge types, the tail or source type identifier, the Type InvalidType otherwise.

GetRestrictedTo()

type_t Type::GetRestrictedTo ( ) const

inline

Gets the head or target type identifier for restricted edge types.

Returns

For restricted edge types, the head or target type identifier, the Type InvalidType otherwise.

---

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

• Graph_data.h