Rogue Wave Views
Gantt Package API Reference Guide
Product Documentation:

Rogue Wave Views
Documentation Home
List of all members | Public Member Functions
IlvGanttLink Class Reference

Gantt chart link class. More...

#include <ilviews/gantt/gantt.h>

Inheritance diagram for IlvGanttLink:
IlvGanttAbstractObject IlvValueInterface

Public Member Functions

 IlvGanttLink (IlvGanttNode *from, IlvGanttNode *to, IlvGanttLinkType type=IlvStartsAfterEnd, IlInt delay=0, IlvGraphic *graphic=0)
 Constructor. More...
 
IlInt getDelay () const
 Gets the precedence delay. More...
 
IlvGanttNodegetFrom () const
 Gets the start node. More...
 
IlvGanttNodegetTo () const
 Gets the end node. More...
 
IlvGanttLinkType getType () const
 Gets the link type. More...
 
void setDelay (IlInt delay, IlBoolean redraw=IlTrue)
 Sets the precedence delay. More...
 
void setFrom (IlvGanttNode *from, IlBoolean redraw=IlTrue)
 Sets the start node. More...
 
void setTo (IlvGanttNode *to, IlBoolean redraw=IlTrue)
 Sets the end node. More...
 
void setType (IlvGanttLinkType type, IlBoolean redraw=IlTrue)
 Sets the link type. More...
 
- Public Member Functions inherited from IlvGanttAbstractObject
 IlvGanttAbstractObject (const char *name=0, IlBoolean copy=IlTrue, IlvGraphic *graphic=0)
 Constructor. More...
 
virtual ~IlvGanttAbstractObject ()
 Destructor. More...
 
IlAny getClientData () const
 Gets the client data if any has been set. More...
 
IlvGraphicgetGraphic () const
 Gets the graphic object stored in the Gantt object. More...
 
const char * getName () const
 Gets the name stored in the Gantt object. More...
 
void setClientData (IlAny data)
 Sets the new client data in this Gantt object. More...
 
virtual void setGraphic (IlvGraphic *graphic, IlBoolean destroyOld=IlTrue, IlBoolean redraw=IlTrue)
 Sets the graphic object displayed by this Gantt object to graphic. More...
 
void setName (const char *name, IlBoolean copy=IlTrue)
 Sets the name of the Gantt object. More...
 

Detailed Description

Gantt chart link class.

Library: ilvgantt

An IlvGanttLink object describes a Gantt precedence constraint. Precedence means one activity occurring before another. It defines the order in which two activities are executed.

See also
IlvGanttChart, IlvGanttAbstractObject, IlvGanttNode.

Constructor & Destructor Documentation

IlvGanttLink::IlvGanttLink ( IlvGanttNode from,
IlvGanttNode to,
IlvGanttLinkType  type = IlvStartsAfterEnd,
IlInt  delay = 0,
IlvGraphic graphic = 0 
)

Constructor.

The constructor initializes an IlvGanttLink object with the parameters you provide.

You can set the type parameter to one of the eight values given in IlvGanttLinkType. Set the graphic parameter to an IlvGraphic object to have a specific representation for this Gantt object.

Parameters
fromThe start Gantt node.
toThe end Gantt node.
typeThe type of the Gantt link. It can be one of the following eight values: IlvStartsAfterEnd, IlvStartsAfterStart, IlvEndsAfterStart, IlvEndsAfterEnd,IlvStartsAtEnd, IlvStartsAtStart, IlvEndsAtStart, IlvEndsAtEnd.
delayIndicates the time between the two nodes.
graphicThe IlvGraphic that represents the object.

Member Function Documentation

IlInt IlvGanttLink::getDelay ( ) const

Gets the precedence delay.

Returns
The precedence delay.
IlvGanttNode* IlvGanttLink::getFrom ( ) const

Gets the start node.

Returns
The start node.
IlvGanttNode* IlvGanttLink::getTo ( ) const

Gets the end node.

Returns
The end node.
IlvGanttLinkType IlvGanttLink::getType ( ) const

Gets the link type.

Returns
The type of the link.
void IlvGanttLink::setDelay ( IlInt  delay,
IlBoolean  redraw = IlTrue 
)

Sets the precedence delay.

Parameters
delayThe precedence delay.
redrawIndicates whether the link should be refreshed.
void IlvGanttLink::setFrom ( IlvGanttNode from,
IlBoolean  redraw = IlTrue 
)

Sets the start node.

Parameters
fromThe start node.
redrawIndicates whether the link should be refreshed.
void IlvGanttLink::setTo ( IlvGanttNode to,
IlBoolean  redraw = IlTrue 
)

Sets the end node.

Parameters
toThe end node.
redrawIndicates whether the link should be refreshed.
void IlvGanttLink::setType ( IlvGanttLinkType  type,
IlBoolean  redraw = IlTrue 
)

Sets the link type.

Parameters
typeThe link type.
redrawIndicates whether the link should be refreshed.

© Copyright 2016, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.