All Categories  Class Hierarchy  This Category  Previous  Next  Indexes

Product Class CATVPMNode

CATVPMNode

public class CATVPMNode

Constructor and Destructor Index

o CATVPMNode()
o ~CATVPMNode()

Method Index

o AddAttribute(CATUnicodeString&,CATUnicodeString&): Adds a new attribute to this node
o Deselect(): Deselect interactive node
o DeselectAllInGraph(): Deselect interactive node
o Expand(int): Expand children of current node
o GetAttributeValue(CATUnicodeString&,CATUnicodeString&): Get an attribute value by its name
o GetAttributeValue(int,CATUnicodeString&,CATUnicodeString&): Get an attribute by its index
o GetCLink(): Get the COMPID of the link
o GetCaenv(): Get the environment of the object
o GetCatab(): Get the table of the object
o GetChildren(CATListOfCATVPMNode&,CATVPMChildrenOption,int): Get the childs of a node
o GetCoid(): Get the Coid of the object
o GetCompid(): Get the Compid of the object
o GetFather(): Get the father node
o GetGraphId(): Get the graph id
o GetNbAttribute(): Get the number of attributes added
o GetNode(double&): Get a node from its link
o GetPart(CATListOfDouble&,int&): Get a part from its path
o GetPart(double&,int&): Get a part from its link
o GetPartAsmID(double): Builds a PartAsmID from the node
o GetRep(double&): Get the representation from its compid
o GetRoot(): Get the root part of assembly
o GetUuid(): Get the UUID of the object
o GetUuid(char*): Get the UUID of the object
o Hide(): Hide interactive node
o IsSelected(): returns the node selection status
o Refresh(): Refresh the interactive node display
o RemoveAllAttribute(): Removes all attributes from this node
o RemoveAttribute(CATUnicodeString&): Removes an attribute from this node
o ResetColor(): Reset the color of interactive node
o Select(): Select interactive node
o SetColor(int&): Modify the color of interactive node
o SetIcon(CATUnicodeString&): Modify the icon of interactive node
o Show(): Show interactive node
o SortChildren(int(*iFct)(CATVPMNode*iNode1, CATVPMNode*)): Sort the children of this node

o _Depth
o _ExpandStatus
o _Graph

Constructor and Destructor

o CATVPMNode

public CATVPMNode(

)

o ~CATVPMNode

public virtual ~CATVPMNode(

)

Methods

o AddAttribute

public virtual int AddAttribute(	const CATUnicodeString&	`iAttName`,
	const CATUnicodeString&	`iAttVal`)=0

Adds a new attribute to this node

Returns:: 1 Add successfull
0 Attribute already exists => action canceled

o Deselect

public virtual void Deselect(

)= 0

Deselect interactive node

o DeselectAllInGraph

public virtual void DeselectAllInGraph(

)= 0

Deselect interactive node

o Expand

public virtual int Expand( int iDepth) = 0

Expand children of current node

Parameters:

iDepth: Deth to be expanded

Returns:

Error

o GetAttributeValue

public virtual int GetAttributeValue(	const CATUnicodeString&	`iAttName`,
	CATUnicodeString&	`oAttVal`)=0

Get an attribute value by its name

Parameters:

iAttName: name of the attribute
oAttVal: value of the attribute

Returns:

1 Get value successful
0 Attribute does not exists

o GetAttributeValue

public virtual int GetAttributeValue(	const int	`iIndex`,
	CATUnicodeString&	`oAttName`,
	CATUnicodeString&	`oAttVal`)=0

Get an attribute by its index

Parameters:

iIndex: index of the attribute
oAttName: name of the attribute
oAttVal: value of the attribute

Returns:

1 Get attribute successful
0 Attribute index does not exists

o GetCLink

public virtual double GetCLink(

)const = 0

Get the COMPID of the link

Returns:: the COMPID of the link

o GetCaenv

public virtual CATUnicodeString GetCaenv(

)

Get the environment of the object

Returns:: the environment of the object

o GetCatab

public virtual CATUnicodeString GetCatab(

)

Get the table of the object

Returns:: the table of the object

o GetChildren

public virtual void GetChildren(	CATListOfCATVPMNode&	`oChildren`,
	CATVPMChildrenOption	`iOption`	`= AllParts`,
	int	`NbLevels`	`= 1`) const = 0

Get the childs of a node

Parameters:

oChidren: list of the childrens
iOption: filter for childrens
All -> all objects
Rep -> representations
AllParts -> all parts (default)
PartLeaves -> part leaves only
iNbLevels: number of levels to scan

o GetCoid

public virtual double GetCoid(

)

Get the Coid of the object

Returns:: the Coid of the object

o GetCompid

public virtual double GetCompid(

)

Get the Compid of the object

Returns:: the Compid of the object

o GetFather

public virtual CATVPMNode * GetFather(

)const = 0

Get the father node

Returns:: father node

o GetGraphId

public virtual int GetGraphId(

)= 0

Get the graph id

Returns:: graph id

o GetNbAttribute

public virtual int GetNbAttribute(

)=0

Get the number of attributes added

Returns:: number of attributes added

o GetNode

public CATVPMNode* GetNode( const double& iCLink)

Get a node from its link

Parameters:

iClink: compid of the link of the node

Returns:

node corresponding to the link

o GetPart

public CATVPMNode* GetPart(	CATListOfDouble&	`iNodePath`,
	const int&	`iExact`	`= 1`) const

Get a part from its path

Parameters:

iNodePath: list of compid of the links to the node
iExact: get the exact part (1) or an equivalent one (0), corresponding to a move, a replace...

Returns:

part corresponding to path

o GetPart

public CATVPMNode* GetPart(	double&	`iCLink`,
	const int&	`iExact`	`= 1`) const

Get a part from its link

Parameters:

iClink: compid of the link of the node
iExact: get the exact part (1) or an equivalent one (0), corresponding to a move, a replace...

Returns:

part corresponding to the link

o GetPartAsmID

public PartAsmID* GetPartAsmID( double iViewerUnit =0.0)

Builds a PartAsmID from the node

Returns:: the part structure

o GetRep

public CATVPMNode* GetRep( double& iCompid) const

Get the representation from its compid

Parameters:

iCompid: compid of the representation

Returns:

the representation

o GetRoot

public virtual CATVPMNode * GetRoot(

)= 0

Get the root part of assembly

Returns:: root part

o GetUuid

public virtual char * GetUuid(

)const = 0

Get the UUID of the object

Returns:: the UUID of the object delete return address using : delete [] ;

o GetUuid

public virtual char * GetUuid( char* iUuid) const = 0

Get the UUID of the object

Parameters:

iUuid: buffer for UUID length 50

Returns:

the UUID of the object which is &iUuuid[0]

o Hide

public virtual void Hide(

)= 0

Hide interactive node

o IsSelected

public int IsSelected(

)

returns the node selection status

o Refresh

public virtual void Refresh(

)= 0

Refresh the interactive node display

o RemoveAllAttribute

public virtual void RemoveAllAttribute(

)=0

Removes all attributes from this node

o RemoveAttribute

public virtual int RemoveAttribute( const CATUnicodeString& iAttName)=0

Removes an attribute from this node

Returns:: 1 Remove successful
0 Attribute does not exists

o ResetColor

public virtual void ResetColor(

)= 0

Reset the color of interactive node

o Select

public virtual void Select(

)= 0

Select interactive node

o SetColor

public virtual void SetColor( const int& iColor) = 0

Modify the color of interactive node

Parameters:

iColor: color number

o SetIcon

public virtual void SetIcon( const CATUnicodeString& iIcon) = 0

Modify the icon of interactive node

Parameters:

iIcon: icon name

o Show

public virtual void Show(

)= 0

Show interactive node

o SortChildren

public virtual void SortChildren( int(*iFct)(CATVPMNode*iNode1, CATVPMNode*) iNode2)

Sort the children of this node

Parameters:

iFct: function to compare two nodes that will be used to sort them

Returns:

void

Data Members

o _Depth

  protected int _Depth

o _ExpandStatus

  protected CATVPMExpandStatus _ExpandStatus

o _Graph

  protected void* _Graph

This object is included in the file: CATVPMNode.h
If needed, your Imakefile.mk should include the module: LV0PSBAS

Product Class CATVPMNode

Constructor and Destructor Index

Method Index

Data Member Index

Constructor and Destructor

Methods

Data Members