lutin.system.System Class Reference

Public Member Functions

def set_help (self, help)
 
def get_help (self)
 
def set_valid (self, state)
 
def get_valid (self)
 
def add_sources (self, list)
 
def add_path (self, list)
 
def add_depend (self, list)
 
def add_flag (self, type, list)
 
def set_version (self, version_list)
 
def add_action (self, name_of_state="PACKAGE", level=5, name="no-name", action=None)
 
def add_header_file (self, list, destination_path=None, clip_path=None, recursive=False)
 
def configure_module (self, target, module)
 

Detailed Description

System class represent the pre-build Module that are already install and accessible in the system environment.

Member Function Documentation

def lutin.system.System.add_action (   self,
  name_of_state = "PACKAGE",
  level = 5,
  name = "no-name",
  action = None 
)

def lutin.system.System.add_depend (   self,
  list 
)

Add a dependency on this module.

Parameters
[in]self(handle) Class handle
[in]list([string,...] or string) Name(s) of the modules dependency
Returns
None
def lutin.system.System.add_flag (   self,
  type,
  list 
)

Add compilation flags.

Parameters
[in]self(handle) Class handle
[in]type(string) inclusion group name 'c', 'c++', 'java' ...
[in]list([string,...] or string) List of path to include
Returns
None
def lutin.system.System.add_header_file (   self,
  list,
  destination_path = None,
  clip_path = None,
  recursive = False 
)

def lutin.system.System.add_path (   self,
  list 
)

Add include path of the sources.

Parameters
[in]self(handle) Class handle
[in]list([string,...]) List of all path to add in the -I include element
Returns
None

todo : add other than C ...

def lutin.system.System.add_sources (   self,
  list 
)

Add source element.

Parameters
[in]self(handle) Class handle
[in]list([string,...]) List of all Files to add. ex: *.a, *.so ...
Returns
None
def lutin.system.System.configure_module (   self,
  target,
  module 
)

Configure a module with internal datas.

Parameters
[in]self(handle) Class handle
[in]target(handle) lutin.module.Target handle
[in]module(handle) lutin.module.Module handle
Returns
None
def lutin.system.System.get_help (   self)

Get the help of this system Module.

Parameters
[in]self(handle) Class handle
Returns
(string) Help for the user
def lutin.system.System.get_valid (   self)

Get validity state of the system Module.

Parameters
[in]self(handle) Class handle
Returns
(bool) New valididty state of the system module
def lutin.system.System.set_help (   self,
  help 
)

Set the help of this system Module.

Parameters
[in]self(handle) Class handle
[in]help(string) Help for the user
Returns
None
def lutin.system.System.set_valid (   self,
  state 
)

Set validity state of the system Module.

Parameters
[in]self(handle) Class handle
[in]state(bool) New valididty state of the system module
Returns
None
def lutin.system.System.set_version (   self,
  version_list 
)

Set version of the module.

Parameters
[in]self(handle) Class handle
[in]version_list([int,...]) Ids of the version. ex: [1,2,5] or [0,8,"dev"]
Returns
None

The documentation for this class was generated from the following file:
  • lutin/lutin/system.py