Class: Sbuilder::Parameter

Inherits:
Object
  • Object
show all
Includes:
Utils::MyLogger
Defined in:
lib/sbuilder/parameter.rb

Direct Known Subclasses

ParameterContainer, Parameter_Dom, Parameter_Ref

Constant Summary collapse

PROGNAME =

mixer

nil

Constants included from Utils::MyLogger

Utils::MyLogger::LOGFILE

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Utils::MyLogger

#getLogger, #logfile

Constructor Details

#initialize(options = {}) ⇒ Parameter

constrcutore



18
19
20
21
22
23
 
# File 'lib/sbuilder/parameter.rb', line 18

def initialize( options = {} )
  @logger = getLogger( PROGNAME, options )
  @logger.debug( "#{__method__} initialized" )
  # default is not an arrays
  @isArray = false
end

Instance Attribute Details

#name ⇒ Object (readonly)

Returns the value of attribute name.



6
7
8
 
# File 'lib/sbuilder/parameter.rb', line 6

def name
  @name
end

Instance Method Details

#do_parameter_definition(model) ⇒ Object

Raises:

  • (NoMethodError) 


85
86
87
88
89
 
# File 'lib/sbuilder/parameter.rb', line 85

def do_parameter_definition( model )
  msg = "Sub class should implement do_parameter_definition -method"
  @logger.error( "#{__method__} #{msg}" )        
  raise NoMethodError.new( msg  )
end

#doGetType ⇒ Object

Raises:

  • (NoMethodError) 


68
69
70
71
72
 
# File 'lib/sbuilder/parameter.rb', line 68

def doGetType
  msg = "Sub class should implement doGetType -method"
  @logger.error( "#{__method__} #{msg}" )        
  raise NoMethodError.new( msg  )
end

#getName ⇒ Object 



38
39
40
41
 
# File 'lib/sbuilder/parameter.rb', line 38

def getName()
  return name.
          gsub( / /, "" )   # remove spaces
end

#getResolvedReference ⇒ Object

resolve parametSet reference in ‘model’: simple parameter resolves to ‘self’



96
97
98
 
# File 'lib/sbuilder/parameter.rb', line 96

def getResolvedReference
  self
end

#getType ⇒ Object

domain or reference parameter set



64
65
66
 
# File 'lib/sbuilder/parameter.rb', line 64

def getType
  return doGetType
end

#isArray ⇒ Boolean

Returns true is array, default ‘false’.

Returns:

  • (Boolean) —

    true is array, default ‘false’



49
50
51
 
# File 'lib/sbuilder/parameter.rb', line 49

def isArray
  return @isArray == true
end

#isReference ⇒ Object

is NOT reference (override in sub-class if is a reference)



54
55
56
 
# File 'lib/sbuilder/parameter.rb', line 54

def isReference
  false
end

#parameter_definition(model) ⇒ Object

create patermeter definition



77
78
79
80
81
82
 
# File 'lib/sbuilder/parameter.rb', line 77

def parameter_definition( model )
  {
    :parameter_name => getName,
    :isArray => isArray,
  }.merge!( do_parameter_definition( model ) )
end

#setIsArray(isArray = true) ⇒ Object 



43
44
45
46
 
# File 'lib/sbuilder/parameter.rb', line 43

def setIsArray( isArray = true )
  @isArray = isArray
  self
end

#setName(name) ⇒ Object

build identity



33
34
35
36
 
# File 'lib/sbuilder/parameter.rb', line 33

def setName( name )
  @name = name
  self
end