TreeNode 1.5.2
A library to manipulate phylogenetic trees
Loading...
Searching...
No Matches
PhyloTree.Formats.Attribute Struct Reference

Describes an attribute of a node. More...

Inheritance diagram for PhyloTree.Formats.Attribute:

Public Member Functions

 Attribute (string attributeName, bool isNumeric)
 Constructs a new Attribute. More...
 
override bool Equals (object obj)
 Compares an Attribute and another object. More...
 
override int GetHashCode ()
 Returns the hash code for this Attribute. More...
 
bool Equals (Attribute other)
 Compares two Attributes. More...
 

Static Public Member Functions

static bool operator== (Attribute left, Attribute right)
 Compares two Attributes. More...
 
static bool operator!= (Attribute left, Attribute right)
 Compares two Attributes (negated). More...
 

Properties

string AttributeName [get]
 The name of the attribute. More...
 
bool IsNumeric [get]
 Whether the attribute is represented by a numeric value or a string. More...
 

Detailed Description

Describes an attribute of a node.

Definition at line 692 of file Binary.cs.

Constructor & Destructor Documentation

◆ Attribute()

PhyloTree.Formats.Attribute.Attribute ( string  attributeName,
bool  isNumeric 
)

Constructs a new Attribute.

Parameters
attributeNameThe name of the attribute.
isNumericWhether the attribute is represented by a numeric value or a string.

Definition at line 709 of file Binary.cs.

Member Function Documentation

◆ Equals() [1/2]

bool PhyloTree.Formats.Attribute.Equals ( Attribute  other)

Compares two Attributes.

Parameters
otherThe Attribute to compare to.
Returns
true if other has the same AttributeName (case insensitive) and value for IsNumeric as the current instance. false otherwise.

Definition at line 768 of file Binary.cs.

◆ Equals() [2/2]

override bool PhyloTree.Formats.Attribute.Equals ( object  obj)

Compares an Attribute and another object.

Parameters
objThe object to compare to.
Returns
true if obj is an Attribute and it has the same AttributeName (case insensitive) and value for IsNumeric as the current instance. false otherwise.

Definition at line 720 of file Binary.cs.

◆ GetHashCode()

override int PhyloTree.Formats.Attribute.GetHashCode ( )

Returns the hash code for this Attribute.

Returns
The hash code for this Attribute.

Definition at line 736 of file Binary.cs.

◆ operator!=()

static bool PhyloTree.Formats.Attribute.operator!= ( Attribute  left,
Attribute  right 
)
static

Compares two Attributes (negated).

Parameters
leftThe first Attribute to compare.
rightThe second Attribute to compare.
Returns
false if both Attributes have the same AttributeName (case insensitive) and value for IsNumeric. true otherwise.

Definition at line 758 of file Binary.cs.

◆ operator==()

static bool PhyloTree.Formats.Attribute.operator== ( Attribute  left,
Attribute  right 
)
static

Compares two Attributes.

Parameters
leftThe first Attribute to compare.
rightThe second Attribute to compare.
Returns
true if both Attributes have the same AttributeName (case insensitive) and value for IsNumeric. false otherwise.

Definition at line 747 of file Binary.cs.

Property Documentation

◆ AttributeName

string PhyloTree.Formats.Attribute.AttributeName
get

The name of the attribute.

Definition at line 697 of file Binary.cs.

◆ IsNumeric

bool PhyloTree.Formats.Attribute.IsNumeric
get

Whether the attribute is represented by a numeric value or a string.

Definition at line 702 of file Binary.cs.


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