STSType Class Reference

Type data class. More...

#include <Sparksee.h>

Inheritance diagram for STSType:

Collaboration diagram for STSType:

Instance Methods
(int)	- getId
	Gets the Sparksee type identifier.
(enum STSObjectType)	- getObjectType
	Gets the object type.
(NSString *)	- getName
	Gets the unique type name.
(long long)	- getNumObjects
	Gets the number of objects belonging to the type.
(BOOL)	- getIsDirected
	Gets if this is a directed edge type.
(BOOL)	- getIsRestricted
	Gets if this is a restricted edge type.
(BOOL)	- getAreNeighborsIndexed
	Gets if this is an edge type with neighbors index.
(int)	- getRestrictedFrom
	Gets the tail or source type identifier for restricted edge types.
(int)	- getRestrictedTo
	Gets the head or target type identifier for restricted edge types.

Class Methods
(int)	+ getInvalidType
	Invalid type identifier.
(int)	+ getGlobalType
	Global type identifier.
(int)	+ getNodesType
	Identifier for all nodeType attributes.
(int)	+ getEdgesType
	Identifier for all edgeType attributes.

Detailed Description

Type data class.

It contains information about a node or edge type.

Author

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

Method Documentation

getAreNeighborsIndexed

- (BOOL) getAreNeighborsIndexed

Gets if this is an edge type with neighbors index.

Returns

TRUE for edges types with neighbors index, FALSE otherwise.

References getAreNeighborsIndexed.

Referenced by getAreNeighborsIndexed.

getId

- (int) getId

Gets the Sparksee type identifier.

Returns

The Sparksee type identifier.

References getId.

Referenced by getId.

getIsDirected

- (BOOL) getIsDirected

Gets if this is a directed edge type.

Returns

TRUE for directed edge types, FALSE otherwise.

References getIsDirected.

Referenced by getIsDirected.

getIsRestricted

- (BOOL) getIsRestricted

Gets if this is a restricted edge type.

Returns

TRUE for restricted edge types, FALSE otherwise.

References getIsRestricted.

Referenced by getIsRestricted.

getName

- (NSString *) getName

Gets the unique type name.

Returns

The unique type name.

References getName.

Referenced by getName.

getNumObjects

- (long long) getNumObjects

Gets the number of objects belonging to the type.

Returns

The number of objects belonging to the type.

References getNumObjects.

Referenced by getNumObjects.

getObjectType

- (enum STSObjectType) getObjectType

Gets the object type.

Returns

The object type.

References getObjectType.

Referenced by getObjectType.

getRestrictedFrom

- (int) getRestrictedFrom

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.

References getRestrictedFrom.

Referenced by getRestrictedFrom.

getRestrictedTo

- (int) getRestrictedTo

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.

References getRestrictedTo.

Referenced by getRestrictedTo.

---

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

• Sparksee.h