Git.framework Reference Library

GITGraphNode Class Reference

GITGraphNode Class Reference

Declared in GITGraphNode.h

Overview

A Graph Node is used with a Graph to store objects to be sorted.

If the object responds to committerDate then the return value of this method will be stored in the nodes time field which is required for date based sorting.

Tasks

Properties

key

Node key.

@property id key
Declared In
GITGraphNode.h

object

Node object.

@property id object
Declared In
GITGraphNode.h

visited

Flag indicating if the node has been visited.

@property BOOL visited
Declared In
GITGraphNode.h

Class Methods

nodeWithObject:key:

+ (GITGraphNode *)nodeWithObject:(id)object key:(id)key
Parameters
object

Object to create the node with

key

Key to identify the node

Return Value

new node with the object and key

Discussion

Creates and returns a node with the object and key.

Declared In
GITGraphNode.h

Instance Methods

initWithObject:key:

- (id)initWithObject:(id)object key:(id)key
Parameters
object

Object to create the node with

key

Key to identify the node

Return Value

initialised node with the object and key

Discussion

Initialises and returns a node with the object and key.

Declared In
GITGraphNode.h

resetFlags

- (void)resetFlags
Discussion

Reset the flags on the receiver to defaults

Declared In
GITGraphNode.h

hasBeenVisited

- (BOOL)hasBeenVisited
Return Value

visited state of the receiver

Discussion

Returns the visited state of the receiver.

Declared In
GITGraphNode.h

markVisited

- (void)markVisited
Discussion

Marks the receiver as visited.

Declared In
GITGraphNode.h

hasBeenProcessed

- (BOOL)hasBeenProcessed
Return Value

processed state of the receiver

Discussion

Returns the processed state of the receiver.

Declared In
GITGraphNode.h

markProcessed

- (void)markProcessed
Discussion

Marks the receiver as processed.

Declared In
GITGraphNode.h

addInboundEdgeToNode:

- (void)addInboundEdgeToNode:(GITGraphNode *)node
Parameters
node

Node to create the edge to

Discussion

Add inbound edge from the receiver to the node.

Declared In
GITGraphNode.h

addOutboundEdgeToNode:

- (void)addOutboundEdgeToNode:(GITGraphNode *)node
Parameters
node

Node to create the edge to

Discussion

Add outbound edge from the receiver to the node.

Declared In
GITGraphNode.h

removeInboundEdgeToNode:

- (void)removeInboundEdgeToNode:(GITGraphNode *)node
Parameters
node

Node to remove the edge to

Discussion

Remove inbound edge from the receiver to the node.

Declared In
GITGraphNode.h

removeOutboundEdgeToNode:

- (void)removeOutboundEdgeToNode:(GITGraphNode *)node
Parameters
node

Node to remove the edge to

Discussion

Remove outbound edge from the receiver to the node.

Declared In
GITGraphNode.h

resetInboundEdgeCount

- (void)resetInboundEdgeCount
Discussion

Reset the inbound edge count to the number of nodes in the inbound list.

Declared In
GITGraphNode.h

resetOutboundEdgeCount

- (void)resetOutboundEdgeCount
Discussion

Reset the outbound edge count to the number of nodes in the outbound list.

Declared In
GITGraphNode.h

inboundEdgeCount

- (NSUInteger)inboundEdgeCount
Return Value

number of inbound edges

Discussion

Return the count of inbound edges.

Declared In
GITGraphNode.h

outboundEdgeCount

- (NSUInteger)outboundEdgeCount
Return Value

number of outbound edges

Discussion

Return the count of outbound edges.

Declared In
GITGraphNode.h

decrementedInboundEdgeCount

- (NSUInteger)decrementedInboundEdgeCount
Return Value

decremented inbound edge count

Discussion

Decrements and returns the inbound edge count.

Declared In
GITGraphNode.h

decrementedOutboundEdgeCount

- (NSUInteger)decrementedOutboundEdgeCount
Return Value

decremented outbound edge count

Discussion

Decrements and returns the outbound edge count.

Declared In
GITGraphNode.h

inboundNodes

- (NSArray *)inboundNodes
Return Value

array of inbound nodes the receiver has edges to

Discussion

Returns the array of inbound nodes the receiver has edges to.

Declared In
GITGraphNode.h

outboundNodes

- (NSArray *)outboundNodes
Return Value

array of outbound nodes the receiver has edges to

Discussion

Returns the array of outbound nodes the receiver has edges to.

Declared In
GITGraphNode.h

isEqual:

- (BOOL)isEqual:(id)other
Parameters
other

Object to compare the receiver to

Return Value

YES if the reciever is equal to the other object, NO if not

Discussion

Tests if the receiver is equal to the other object.

Declared In
GITGraphNode.h

compare:

- (NSComparisonResult)compare:(GITGraphNode *)rhs
Parameters
rhs

Other graph node to compare the receiver to

Return Value

NSComparisonResult if the comparison

Discussion

Compares the receiver to the rhs node object.

Declared In
GITGraphNode.h

Last updated: 2011-2-20