FH98ViewOnPlaneSoftware/Src/XtremeToolKitPro/FlowGraph/XTPFlowGraphNodes.h

// XTPFlowGraphNodes.h: interface for the CXTPFlowGraphNodes class.
//
// This file is a part of the XTREME TOOLKIT PRO MFC class library.
// (c)1998-2012 Codejock Software, All Rights Reserved.
//
// THIS SOURCE FILE IS THE PROPERTY OF CODEJOCK SOFTWARE AND IS NOT TO BE
// RE-DISTRIBUTED BY ANY MEANS WHATSOEVER WITHOUT THE EXPRESSED WRITTEN
// CONSENT OF CODEJOCK SOFTWARE.
//
// THIS SOURCE CODE CAN ONLY BE USED UNDER THE TERMS AND CONDITIONS OUTLINED
// IN THE XTREME TOOLKIT PRO LICENSE AGREEMENT. CODEJOCK SOFTWARE GRANTS TO
// YOU (ONE SOFTWARE DEVELOPER) THE LIMITED RIGHT TO USE THIS SOFTWARE ON A
// SINGLE COMPUTER.
//
// CONTACT INFORMATION:
// support@codejock.com
// http://www.codejock.com
//
/////////////////////////////////////////////////////////////////////////////

//{{AFX_CODEJOCK_PRIVATE
#if !defined(__XTPFLOWGRAPHNODES_H__)
#define __XTPFLOWGRAPHNODES_H__
//}}AFX_CODEJOCK_PRIVATE

#if _MSC_VER > 1000
#pragma once
#endif // _MSC_VER > 1000

class CXTPFlowGraphPage;
class CXTPFlowGraphNode;

// -----------------------------------------------------------------------
//
// Summary:
//     Represents a collection of nodes in a page or group.
//
// Remarks:
//     Nodes are the main objects that are displayed in the flow graph. In
//     terms of a database they can be thought of as the tables in the
//     database. The nodes contain many connection points, which are like
//     the fields in a table. Finally there are connections that are used
//     to draw a relationship between the field of two tables.
// -----------------------------------------------------------------------
class _XTP_EXT_CLASS CXTPFlowGraphNodes : public CXTPCmdTarget
{
protected:
	// ------------------------------------------
	// Summary:
	//     Constructs a CXTPFlowGraphPage object.
	// ------------------------------------------
	CXTPFlowGraphNodes(CXTPFlowGraphPage* pPage);
	// -------------------------------------------------------------
	// Summary:
	//     Destroys a CXTPFlowGraphNodes object, handles cleanup and
	//     deallocation.
	// -------------------------------------------------------------
	virtual ~CXTPFlowGraphNodes();

public:
	// ---------------------------------------------
	// Summary:
	//     Removes all nodes from the page or group.
	// ---------------------------------------------
	void RemoveAll();
	// ------------------------------------------
	//
	// Summary:
	//     Adds a node to a page or group.
	// Parameters:
	//     pNode :  Reference to the node to add.
	//
	// Returns:
	//     Reference to the node to added.
	// ------------------------------------------
	CXTPFlowGraphNode* AddNode(CXTPFlowGraphNode* pNode);

	// ---------------------------------------------
	//
	// Summary:
	//     Removes the specifies node.
	// Parameters:
	//     pNode :  Reference to the node to remove.
	// ---------------------------------------------
	void Remove(CXTPFlowGraphNode* pNode);
	// ------------------------------------------------------
	//
	// Summary:
	//     Removes the specified node from the page or group.
	// Parameters:
	//     nIndex :  Index of the node to remove.
	// ------------------------------------------------------
	void RemoveAt(int nIndex);

	// --------------------------------------------------------------------
	//
	// Summary:
	//     Finds and returns the specified node.
	// Parameters:
	//     nId :  ID of the node to find and return.
	//
	// Returns:
	//     If found, reference to the node with the specified ID, otherwise
	//     nothing\\null will be returned.
	// --------------------------------------------------------------------
	CXTPFlowGraphNode* FindNode(int nId) const;

	// ------------------------------------------------------------
	//
	// Summary:
	//     \Returns the total number of nodes in the page or group.
	// Returns:
	//     \Returns the total number of nodes in the page or group.
	// ------------------------------------------------------------
	int GetCount() const;
	// --------------------------------------------------------
	//
	// Summary:
	//     Gets the node at the specified index.
	// Parameters:
	//     nIndex :  Index of the specified node.
	//
	// Returns:
	//     \Returns a reference to the specified FlowGraphNode.
	// --------------------------------------------------------
	CXTPFlowGraphNode* GetAt(int nIndex) const;

	// --------------------------------------------------------
	//
	// Summary:
	//     Moves the specified node to the front.
	// Parameters:
	//     pNode :  Reference to the node to move to the front.
	// --------------------------------------------------------
	void MoveToFront(CXTPFlowGraphNode* pNode);

public:
	// ------------------------------------------------------------------------
	// Summary:
	//     Call this member function to Store/Load a collection of nodes
	//     using the specified data object.
	// Parameters:
	//     pPX :  Source or destination CXTPPropExchange data object reference.
	// Remarks:
	//     This member function is used to store or load a collection nodes
	//     data to or from a storage.
	// ------------------------------------------------------------------------
	void DoPropExchange(CXTPPropExchange* pPX);

protected:
	CXTPFlowGraphPage* m_pPage; // Pointer to the page this collection of nodes is displayed on.

	CArray<CXTPFlowGraphNode*, CXTPFlowGraphNode*> m_arrNodes; // Collection of nodes.

	friend class CXTPFlowGraphPage;

};

AFX_INLINE int CXTPFlowGraphNodes::GetCount() const {
	return (int)m_arrNodes.GetSize();
}
AFX_INLINE CXTPFlowGraphNode* CXTPFlowGraphNodes::GetAt(int nIndex) const {
	return nIndex >= 0 && nIndex < m_arrNodes.GetSize() ? m_arrNodes[nIndex] : NULL;
}

#endif //#if !defined(__XTPFLOWGRAPHNODES_H__)