Files

Class/Module Index [+]

Quicksearch

BinData::Framework

All methods provided by the framework are to be implemented or overridden by subclasses of BinData::Base.

Public Instance Methods

assign(val) click to toggle source

Assigns the value of val to this data object. Note that val must always be deep copied to ensure no aliasing problems can occur.

# File lib/bindata/framework.rb, line 40
def assign(val)
  raise NotImplementedError
end
clear?() click to toggle source

Returns true if the object has not been changed since creation.

# File lib/bindata/framework.rb, line 34
def clear?
  raise NotImplementedError
end
snapshot() click to toggle source

Returns a snapshot of this data object.

# File lib/bindata/framework.rb, line 45
def snapshot
  raise NotImplementedError
end

Protected Instance Methods

initialize_instance() click to toggle source

Initializes the state of the object. All instance variables that are used by the object must be initialized here.

# File lib/bindata/framework.rb, line 21
def initialize_instance
end
initialize_shared_instance() click to toggle source

Initialises state that is shared by objects with the same parameters.

This should only be used when optimising for performance. Instance variables set here, and changes to the singleton class will be shared between all objects that are initialized with the same parameters. This method is called only once for a particular set of parameters.

# File lib/bindata/framework.rb, line 30
def initialize_shared_instance
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.