Class TaskJuggler::AttributeBase
In: lib/taskjuggler/AttributeBase.rb
Parent: Object

This class is the base for all property attribute types. Each property can have multiple attributes of different type. For each type, there must be a special Ruby class. Each of these classes must be derived from this class. The class holds information like a reference to the property that owns the attribute and the type of the attribute.

The class can track wheter the attribute value was provided by the project file, inherited from another property or computed during scheduling.

Attributes that are of an inherited type will be copied from a parent property or the global scope.

Methods

get   id   inherit   mode   name   new   nil?   reset   set   setMode   to_num   to_rti   to_s   to_sort   to_tjp   value  

Attributes

inherited  [R] 
property  [R] 
provided  [R] 
type  [R] 

Public Class methods

mode()

Return the current attribute setting mode.

[Source]

# File lib/taskjuggler/AttributeBase.rb, line 72
    def AttributeBase.mode
      @@mode
    end
new(property, type, container)

Create a new AttributeBase object. type specifies the specific type of the object. property is the PropertyTreeNode object this attribute belongs to.

[Source]

# File lib/taskjuggler/AttributeBase.rb, line 38
    def initialize(property, type, container)
      @type = type
      @property = property
      @container = container

      reset
    end
setMode(mode)

Change the @@mode. 0 means values are provided, 1 means values are inherited, any other value means calculated.

[Source]

# File lib/taskjuggler/AttributeBase.rb, line 78
    def AttributeBase.setMode(mode)
      @@mode = mode
    end

Public Instance methods

get()

Return the attribute value.

[Source]

# File lib/taskjuggler/AttributeBase.rb, line 107
    def get
      @container.instance_variable_get(('@' + type.id).intern)
    end
id()

Return the ID of the attribute.

[Source]

# File lib/taskjuggler/AttributeBase.rb, line 83
    def id
      type.id
    end
inherit(value)

Call this function to inherit value from the parent property. It is very important that the values are deep copied as they may be modified later on.

[Source]

# File lib/taskjuggler/AttributeBase.rb, line 66
    def inherit(value)
      @inherited = true
      @container.instance_variable_set(('@' + type.id).intern, value.deep_clone)
    end
name()

Return the name of the attribute.

[Source]

# File lib/taskjuggler/AttributeBase.rb, line 88
    def name
      type.name
    end
nil?()

Check whether the value is uninitialized or nil.

[Source]

# File lib/taskjuggler/AttributeBase.rb, line 115
    def nil?
      if (v = get).is_a?(Array)
        v.empty?
      else
        v.nil?
      end
    end
reset()

Reset the attribute value to the default value.

[Source]

# File lib/taskjuggler/AttributeBase.rb, line 47
    def reset
      @inherited = false
      # Flag that marks whether the value of this attribute was provided by the
      # user (in contrast to being calculated).
      @provided = false
      # If type is an AttributeDefinition, create the initial value according
      # to the specified default for this type. Otherwise type is the initial
      # value.
      if @type.is_a?(AttributeDefinition)
        @container.instance_variable_set(('@' + type.id).intern,
                                         @type.default.deep_clone)
      else
        @container.instance_variable_set(('@' + type.id).intern, @type)
      end
    end
set(value)

Set the value of the attribute. Depending on the mode we are in, the flags are updated accordingly.

[Source]

# File lib/taskjuggler/AttributeBase.rb, line 94
    def set(value)
      case @@mode
        when 0
          @provided = true
        when 1
          @inherited = true
      end
      # Store the value in an instance variable in the PropertyTreeNode or
      # ScenarioData object referred to by @container.
      @container.instance_variable_set(('@' + type.id).intern, value)
    end
to_num()

[Source]

# File lib/taskjuggler/AttributeBase.rb, line 128
    def to_num
      v = get
      if v.is_a?(Fixnum) || v.is_a?(Bignum) || v.is_a?(Float)
        v
      else
        nil
      end
    end
to_rti(query)

[Source]

# File lib/taskjuggler/AttributeBase.rb, line 148
    def to_rti(query)
      get.is_a?(RichTextIntermediate) ? !value : nil
    end
to_s(query = nil)

Return the value as String.

[Source]

# File lib/taskjuggler/AttributeBase.rb, line 124
    def to_s(query = nil)
      get.to_s
    end
to_sort()

[Source]

# File lib/taskjuggler/AttributeBase.rb, line 137
    def to_sort
      v = get
      if v.is_a?(Fixnum) || v.is_a?(Bignum) || v.is_a?(Float)
        v
      elsif v.respond_to?('to_s')
        v.to_s
      else
        nil
      end
    end
to_tjp()

Return the value in TJP file syntax.

[Source]

# File lib/taskjuggler/AttributeBase.rb, line 153
    def to_tjp
      @type.id + " " + get.to_s
    end
value()

Alias for get

[Validate]