Sparksee  6.0.2
Type Class Reference

Type data class. More...

Public Member Functions

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

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

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.
type_t Type::GetId ( ) const
inline

Gets the Sparksee type identifier.

Returns
The Sparksee type identifier.
bool_t Type::GetIsDirected ( ) const
inline

Gets if this is a directed edge type.

Returns
TRUE for directed edge types, FALSE otherwise.
bool_t Type::GetIsRestricted ( ) const
inline

Gets if this is a restricted edge type.

Returns
TRUE for restricted edge types, FALSE otherwise.
const std::wstring& Type::GetName ( ) const
inline

Gets the unique type name.

Returns
The unique type name.
int64_t Type::GetNumObjects ( ) const
inline

Gets the number of objects belonging to the type.

Returns
The number of objects belonging to the type.
ObjectType Type::GetObjectType ( ) const
inline

Gets the object type.

Returns
The object type.
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.
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: