Bio::EnsEMBL::Attribute Class Reference

Public Member Functions
public Bio::EnsEMBL::Attribute	new ()
public Bio::EnsEMBL::Attribute	new_fast ()
public String	code ()
public String	name ()
public String	description ()
public String	value ()

Detailed Description

Synopsis

use Bio::EnsEMBL::Attribute;
 
my $attribute = Bio::EnsEMBL::Attribute->new
     (-CODE => 'myCode',
      -NAME => 'My Attribute',
      -DESCRIPTION => 'This is my attribute description.',
      -VALUE => '10023');
 
print $attrib->name(), "\n";
print $attrib->code(), "\n";
print $attrib->description(), "\n";
print $attrib->value(), "\n";

Description

This is a generic attribute class used to represent attributes
associated with seq_regions (and their Slices) and MiscFeatures.

See-also

Bio::EnsEMBL::Slice Bio::EnsEMBL::MiscFeature Bio::EnsEMBL::DBSQL::AttributeAdaptor

Definition at line 34 of file Attribute.pm.

Member Function Documentation

code()

public String Bio::EnsEMBL::Attribute::code

(

)

  Arg [1]    : string $code (optional)
  Example    :

$code = $attribute->code();

  Description: Getter/Setter for code attribute
  Returntype : string
  Exceptions : none
  Caller     : general
  Status     : Stable

Code:

description()

public String Bio::EnsEMBL::Attribute::description

(

)

  Arg [1]    : string $description (optional)
  Example    :

$description = $attribute->description();

  Description: Getter/Setter for description attribute
  Returntype : string
  Exceptions : none
  Caller     : general
  Status     : Stable

Code:

name()

public String Bio::EnsEMBL::Attribute::name

(

)

  Arg [1]    : string $name (optional)
  Example    :

$name = $attribute->name();

  Description: Getter/Setter for name attribute
  Returntype : string
  Exceptions : none
  Caller     : general
  Status     : Stable

Code:

new()

public Bio::EnsEMBL::Attribute Bio::EnsEMBL::Attribute::new

(

)

  Arg [-CODE]        : string - the code for this attribute
  Arg [-NAME]        : string - a human readable name for this attribute
  Arg [-DESCRIPTION] : string - a description for this attribute
  Arg [-VALUE]       : value  - the value of this attribute
  Example            :

my $attribute = Bio::EnsEMBL::Attribute->new
                        (-CODE => 'myCode',
                         -NAME => 'My Attribute',
                         -DESCRIPTION => 'This is my attribute description.',
                         -VALUE => '10023');

  Description        : Constructor.  Instantiates a Bio::EnsEMBL::Attribute object.
  Returntype         : Bio::EnsEMBL::Attribute
  Exceptions         : none
  Caller             : general
  Status             : Stable

Code:

new_fast()

public Bio::EnsEMBL::Attribute Bio::EnsEMBL::Attribute::new_fast

(

)

  Arg [1]    : hashref to be blessed
  Description: Construct a new Bio::EnsEMBL::Attribute using the hashref.
  Exceptions : none
  Returntype : Bio::EnsEMBL::Attribute
  Caller     : general, subclass constructors
  Status     : Stable

Code:

value()

public String Bio::EnsEMBL::Attribute::value

(

)

  Arg [1]    : string $value (optional)
  Example    :

$value = $attribute->value();

  Description: Getter/Setter for value attribute
  Returntype : string
  Exceptions : none
  Caller     : general
  Status     : Stable

Code:

---

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

• ensembl/modules/Bio/EnsEMBL/Attribute.pm