dolibarr  9.0.0
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
Expedition Class Reference

Class to manage shipments. More...

+ Inheritance diagram for Expedition:
+ Collaboration diagram for Expedition:

Public Member Functions

 __construct ($db)
 Constructor. More...
 
 getNextNumRef ($soc)
 Return next contract ref. More...
 
 create ($user, $notrigger=0)
 Create expedition en base. More...
 
 create_line ($entrepot_id, $origin_line_id, $qty, $array_options=0)
 Create a expedition line. More...
 
 create_line_batch ($line_ext, $array_options=0)
 Create the detail (eat-by date) of the expedition line. More...
 
 fetch ($id, $ref='', $ref_ext='', $ref_int='')
 Get object and lines from database. More...
 
 valid ($user, $notrigger=0)
 Validate object and update stock if option enabled. More...
 
 create_delivery ($user)
 Create a delivery receipt from a shipment. More...
 
 addline ($entrepot_id, $id, $qty, $array_options=0)
 Add an expedition line. More...
 
 addline_batch ($dbatch, $array_options=0)
 Add a shipment line with batch record. More...
 
 update ($user=null, $notrigger=0)
 Update database. More...
 
 delete ()
 Delete shipment. More...
 
 fetch_lines ()
 Load lines. More...
 
 deleteline ($user, $lineid)
 Delete detail line. More...
 
 getNomUrl ($withpicto=0, $option='', $max=0, $short=0, $notooltip=0, $save_lastsearch_value=-1)
 Return clicable link of object (with eventually picto) More...
 
 getLibStatut ($mode=0)
 Return status label. More...
 
 LibStatut ($statut, $mode)
 Return label of a status. More...
 
 initAsSpecimen ()
 Initialise an instance with random values. More...
 
 set_date_livraison ($user, $date_livraison)
 Set the planned delivery date. More...
 
 fetch_delivery_methods ()
 Fetch deliveries method and return an array. More...
 
 list_delivery_methods ($id='')
 Fetch all deliveries method and return an array. More...
 
 update_delivery_method ($id='')
 Update/create delivery method. More...
 
 activ_delivery_method ($id)
 Activate delivery method. More...
 
 disable_delivery_method ($id)
 DesActivate delivery method. More...
 
 GetUrlTrackingStatus ($value='')
 Forge an set tracking url. More...
 
 setClosed ()
 Classify the shipping as closed. More...
 
 set_billed ()
 Classify the shipping as invoiced (used when WORKFLOW_BILL_ON_SHIPMENT is on) More...
 
 reOpen ()
 Classify the shipping as validated/opened. More...
 
 generateDocument ($modele, $outputlangs, $hidedetails=0, $hidedesc=0, $hideref=0, $moreparams=null)
 Create a document onto disk according to template module. More...
 
- Public Member Functions inherited from CommonObject
 errorsToString ()
 Method to output saved errors. More...
 
 getFullName ($langs, $option=0, $nameorder=-1, $maxlen=0)
 Return full name (civility+' '+name+' '+lastname) More...
 
 getFullAddress ($withcountry=0, $sep="\, $withregion=0)
 Return full address of contact. More...
 
 getBannerAddress ($htmlkey, $object)
 Return full address for banner. More...
 
 getLastMainDocLink ($modulepart, $initsharekey=0, $relativelink=0)
 Return the link of last main doc file for direct public download. More...
 
 add_contact ($fk_socpeople, $type_contact, $source='external', $notrigger=0)
 Add a link between element $this->element and a contact. More...
 
 copy_linked_contact ($objFrom, $source='internal')
 Copy contact from one element to current. More...
 
 update_contact ($rowid, $statut, $type_contact_id=0, $fk_socpeople=0)
 Update a link to contact line. More...
 
 delete_contact ($rowid, $notrigger=0)
 Delete a link to contact line. More...
 
 delete_linked_contact ($source='', $code='')
 Delete all links between an object $this and all its contacts. More...
 
 liste_contact ($statut=-1, $source='external', $list=0, $code='')
 Get array of all contacts for an object. More...
 
 swapContactStatus ($rowid)
 Update status of a contact linked to object. More...
 
 liste_type_contact ($source='internal', $order='position', $option=0, $activeonly=0, $code='')
 Return array with list of possible values for type of contacts. More...
 
 getIdContact ($source, $code, $status=0)
 Return id of contacts for a source and a contact code. More...
 
 fetch_contact ($contactid=null)
 Load object contact with id=$this->contactid into $this->contact. More...
 
 fetch_thirdparty ($force_thirdparty_id=0)
 Load the third party of object, from id $this->socid or $this->fk_soc, into this->thirdparty. More...
 
 fetchOneLike ($ref)
 Looks for an object with ref matching the wildcard provided It does only work when $this->table_ref_field is set. More...
 
 fetch_barcode ()
 Load data for barcode into properties ->barcode_type* Properties ->barcode_type that is id of barcode. More...
 
 fetch_projet ()
 Load the project with id $this->fk_project into this->project. More...
 
 fetch_product ()
 Load the product with id $this->fk_product into this->product. More...
 
 fetch_user ($userid)
 Load the user with id $userid into this->user. More...
 
 fetch_origin ()
 Read linked origin object. More...
 
 fetchObjectFrom ($table, $field, $key, $element=null)
 Load object from specific field. More...
 
 getValueFrom ($table, $id, $field)
 Getter generic. More...
 
 setValueFrom ($field, $value, $table='', $id=null, $format='', $id_field='', $fuser=null, $trigkey='', $fk_user_field='fk_user_modif')
 Setter generic. More...
 
 load_previous_next_ref ($filter, $fieldid, $nodbprefix=0)
 Load properties id_previous and id_next by comparing $fieldid with $this->ref. More...
 
 getListContactId ($source='external')
 Return list of id of contacts of object. More...
 
 setProject ($projectid)
 Link element with a project. More...
 
 setPaymentMethods ($id)
 Change the payments methods. More...
 
 setMulticurrencyCode ($code)
 Change the multicurrency code. More...
 
 setMulticurrencyRate ($rate, $mode=1)
 Change the multicurrency rate. More...
 
 setPaymentTerms ($id)
 Change the payments terms. More...
 
 setDeliveryAddress ($id)
 Define delivery address. More...
 
 setShippingMethod ($shipping_method_id, $notrigger=false, $userused=null)
 Change the shipping method. More...
 
 setWarehouse ($warehouse_id)
 Change the warehouse. More...
 
 setDocModel ($user, $modelpdf)
 Set last model used by doc generator. More...
 
 setBankAccount ($fk_account, $notrigger=false, $userused=null)
 Change the bank account. More...
 
 line_order ($renum=false, $rowidorder='ASC', $fk_parent_line=true)
 Save a new position (field rang) for details lines. More...
 
 getChildrenOfLine ($id)
 Get children of line. More...
 
 line_up ($rowid, $fk_parent_line=true)
 Update a line to have a lower rank. More...
 
 line_down ($rowid, $fk_parent_line=true)
 Update a line to have a higher rank. More...
 
 updateRangOfLine ($rowid, $rang)
 Update position of line (rang) More...
 
 line_ajaxorder ($rows)
 Update position of line with ajax (rang) More...
 
 updateLineUp ($rowid, $rang)
 Update position of line up (rang) More...
 
 updateLineDown ($rowid, $rang, $max)
 Update position of line down (rang) More...
 
 getRangOfLine ($rowid)
 Get position of line (rang) More...
 
 getIdOfLine ($rang)
 Get rowid of the line relative to its position. More...
 
 line_max ($fk_parent_line=0)
 Get max value used for position of line (rang) More...
 
 update_ref_ext ($ref_ext)
 Update external ref of element. More...
 
 update_note ($note, $suffix='')
 Update note of element. More...
 
 update_note_public ($note)
 Update public note (kept for backward compatibility) More...
 
 update_price ($exclspec=0, $roundingadjust='none', $nodatabaseupdate=0, $seller=null)
 Update total_ht, total_ttc, total_vat, total_localtax1, total_localtax2 for an object (sum of lines). More...
 
 add_object_linked ($origin=null, $origin_id=null)
 Add objects linked in llx_element_element. More...
 
 fetchObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $clause='OR', $alsosametype=1, $orderby='sourcetype', $loadalsoobjects=1)
 Fetch array of objects linked to current object (object of enabled modules only). More...
 
 updateObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='')
 Update object linked of a current object. More...
 
 deleteObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $rowid='')
 Delete all links between an object $this. More...
 
 setStatut ($status, $elementId=null, $elementType='', $trigkey='')
 Set status of an object. More...
 
 getCanvas ($id=0, $ref='')
 Load type of canvas of an object if it exists. More...
 
 getSpecialCode ($lineid)
 Get special code of a line. More...
 
 isObjectUsed ($id=0)
 Function to check if an object is used by others. More...
 
 hasProductsOrServices ($predefined=-1)
 Function to say how many lines object contains. More...
 
 getTotalDiscount ()
 Function that returns the total amount HT of discounts applied for all lines. More...
 
 getTotalWeightVolume ()
 Return into unit=0, the calculated total of weight and volume of all lines * qty Calculate by adding weight and volume of each product line, so properties ->volume/volume_units/weight/weight_units must be loaded on line. More...
 
 setExtraParameters ()
 Set extra parameters. More...
 
 display_incoterms ()
 Return incoterms informations TODO Use a cache for label get. More...
 
 getIncotermsForPDF ()
 Return incoterms informations for pdf display. More...
 
 setIncoterms ($id_incoterm, $location)
 Define incoterms values of current object. More...
 
 formAddObjectLine ($dateSelector, $seller, $buyer)
 Show add free and predefined products/services form. More...
 
 printObjectLines ($action, $seller, $buyer, $selected=0, $dateSelector=0)
 Return HTML table for object lines TODO Move this into an output class file (htmlline.class.php) If lines are into a template, title must also be into a template But for the moment we don't know if it's possible as we keep a method available on overloaded objects. More...
 
 printObjectLine ($action, $line, $var, $num, $i, $dateSelector, $seller, $buyer, $selected=0, $extrafieldsline=0)
 Return HTML content of a detail line TODO Move this into an output class file (htmlline.class.php) More...
 
 printOriginLinesList ($restrictlist='')
 Return HTML table table of source object lines TODO Move this and previous function into output html class file (htmlline.class.php). More...
 
 printOriginLine ($line, $var, $restrictlist='')
 Return HTML with a line of table array of source object lines TODO Move this and previous function into output html class file (htmlline.class.php). More...
 
 add_element_resource ($resource_id, $resource_type, $busy=0, $mandatory=0)
 Add resources to the current object : add entry into llx_element_resources Need $this->element & $this->id. More...
 
 delete_resource ($rowid, $element, $notrigger=0)
 Delete a link to resource line. More...
 
 __clone ()
 Overwrite magic function to solve problem of cloning object that are kept as references. More...
 
 addThumbs ($file)
 Build thumb Move this into files.lib.php. More...
 
 getDefaultCreateValueFor ($fieldname, $alternatevalue=null)
 Return the default value to use for a field when showing the create form of object. More...
 
 call_trigger ($trigger_name, $user)
 Call trigger based on this instance. More...
 
 fetch_optionals ($rowid=null, $optionsArray=null)
 Function to get extra fields of an object into $this->array_options This method is in most cases called by method fetch of objects but you can call it separately. More...
 
 deleteExtraFields ()
 Delete all extra fields values for the current object. More...
 
 insertExtraFields ($trigger='', $userused=null)
 Add/Update all extra fields values for the current object. More...
 
 updateExtraField ($key, $trigger=null, $userused=null)
 Update an extra field value for the current object. More...
 
 showInputField ($val, $key, $value, $moreparam='', $keysuffix='', $keyprefix='', $morecss=0)
 Return HTML string to put an input field into a page Code very similar with showInputField of extra fields. More...
 
 showOutputField ($val, $key, $value, $moreparam='', $keysuffix='', $keyprefix='', $showsize=0)
 Return HTML string to show a field into a page Code very similar with showOutputField of extra fields. More...
 
 showOptionals ($extrafields, $mode='view', $params=null, $keysuffix='', $keyprefix='', $onetrtd=0)
 Function to show lines of extrafields with output datas. More...
 
 getRights ()
 Returns the rights used for this class. More...
 
 defineBuyPrice ($unitPrice=0.0, $discountPercent=0.0, $fk_product=0)
 Get buy price to use for margin calculation. More...
 
 show_photos ($modulepart, $sdir, $size=0, $nbmax=0, $nbbyrow=5, $showfilename=0, $showaction=0, $maxHeight=120, $maxWidth=160, $nolink=0, $notitle=0, $usesharelink=0)
 Show photos of an object (nbmax maximum), into several columns. More...
 
 isDate ($info)
 Function test if type is date. More...
 
 isInt ($info)
 Function test if type is integer. More...
 
 isFloat ($info)
 Function test if type is float. More...
 
 isText ($info)
 Function test if type is text. More...
 
 createCommon (User $user, $notrigger=false)
 Create object into database. More...
 
 fetchCommon ($id, $ref=null, $morewhere='')
 Load object in memory from the database. More...
 
 updateCommon (User $user, $notrigger=false)
 Update object into database. More...
 
 deleteCommon (User $user, $notrigger=false, $forcechilddeletion=0)
 Delete object in database. More...
 
 initAsSpecimenCommon ()
 Initialise object with example values Id must be 0 if object instance is a specimen. More...
 
 fetchComments ()
 Load comments linked with current task. More...
 
 getNbComments ()
 Return nb comments already posted. More...
 
 trimParameters ($parameters)
 Trim object parameters. More...
 

Static Public Member Functions

static replaceThirdparty (DoliDB $db, $origin_id, $dest_id)
 Function used to replace a thirdparty id with another one. More...
 
- Static Public Member Functions inherited from CommonObject
static isExistingObject ($element, $id, $ref='', $ref_ext='')
 Check an object id/ref exists If you don't need/want to instantiate object and just need to know if object exists, use this method instead of fetch. More...
 
static commonReplaceThirdparty (DoliDB $db, $origin_id, $dest_id, array $tables, $ignoreerrors=0)
 Function used to replace a thirdparty id with another one. More...
 

Public Attributes

 $date
 
 $date_expedition
 
const STATUS_DRAFT = 0
 Draft status.
 
const STATUS_VALIDATED = 1
 Validated status.
 
const STATUS_CLOSED = 2
 Closed status.
 
- Public Attributes inherited from CommonObject
 $projet
 
 $note
 

Additional Inherited Members

- Protected Member Functions inherited from CommonObject
 commonGenerateDocument ($modelspath, $modele, $outputlangs, $hidedetails, $hidedesc, $hideref, $moreparams=null)
 Common function for all objects extending CommonObject for generating documents. More...
 
 isArray ($info)
 Function test if type is array. More...
 
 isNull ($info)
 Function test if type is null. More...
 
 isIndex ($info)
 Function test if is indexed. More...
 
 setSaveQuery ()
 Function to prepare the values to insert. More...
 
 setVarsFromFetchObj (&$obj)
 Function to load data from a SQL pointer into properties of current object $this. More...
 
 getFieldList ()
 Function to concat keys of fields. More...
 
 quote ($value, $fieldsentry)
 Add quote to field value if necessary. More...
 

Detailed Description

Class to manage shipments.

Definition at line 46 of file expedition.class.php.

Constructor & Destructor Documentation

◆ __construct()

Expedition::__construct (   $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

Definition at line 174 of file expedition.class.php.

Member Function Documentation

◆ activ_delivery_method()

Expedition::activ_delivery_method (   $id)

Activate delivery method.

Parameters
id$idid method to activate
Returns
void

Definition at line 1913 of file expedition.class.php.

◆ addline()

Expedition::addline (   $entrepot_id,
  $id,
  $qty,
  $array_options = 0 
)

Add an expedition line.

If STOCK_WAREHOUSE_NOT_REQUIRED_FOR_SHIPMENTS is set, you can add a shipment line, with no stock source defined If STOCK_MUST_BE_ENOUGH_FOR_SHIPMENT is not set, you can add a shipment line, even if not enough into stock

Parameters
int$entrepot_idId of warehouse
int$idId of source line (order line)
int$qtyQuantity
array$array_optionsextrafields array
Returns
int <0 if KO, >0 if OK

Definition at line 911 of file expedition.class.php.

◆ addline_batch()

Expedition::addline_batch (   $dbatch,
  $array_options = 0 
)

Add a shipment line with batch record.

Parameters
array$dbatchArray of value (key 'detail' -> Array, key 'qty' total quantity for line, key ix_l : original line index)
array$array_optionsextrafields array
Returns
int <0 if KO, >0 if OK

Definition at line 982 of file expedition.class.php.

◆ create()

Expedition::create (   $user,
  $notrigger = 0 
)

Create expedition en base.

Parameters
User$userObjet du user qui cree
int$notrigger1=Does not execute triggers, 0= execute triggers
Returns
int <0 si erreur, id expedition creee si ok

Definition at line 267 of file expedition.class.php.

◆ create_delivery()

Expedition::create_delivery (   $user)

Create a delivery receipt from a shipment.

Parameters
User$userUser
Returns
int <0 if KO, >=0 if OK

Definition at line 872 of file expedition.class.php.

◆ create_line()

Expedition::create_line (   $entrepot_id,
  $origin_line_id,
  $qty,
  $array_options = 0 
)

Create a expedition line.

Parameters
int$entrepot_idId of warehouse
int$origin_line_idId of source line
int$qtyQuantity
array$array_optionsextrafields array
Returns
int <0 if KO, line_id if OK

Definition at line 447 of file expedition.class.php.

◆ create_line_batch()

Expedition::create_line_batch (   $line_ext,
  $array_options = 0 
)

Create the detail (eat-by date) of the expedition line.

Parameters
object$line_extfull line informations
array$array_optionsextrafields array
Returns
int <0 if KO, >0 if OK

Definition at line 473 of file expedition.class.php.

◆ delete()

Expedition::delete ( )

Delete shipment.

Warning, do not delete a shipment if a delivery is linked to (with table llx_element_element)

Returns
int >0 if OK, 0 if deletion done but failed to delete files, <0 if KO

Definition at line 1155 of file expedition.class.php.

◆ deleteline()

Expedition::deleteline (   $user,
  $lineid 
)

Delete detail line.

Parameters
User$userUser making deletion
int$lineidId of line to delete
Returns
int >0 if OK, <0 if KO

Definition at line 1551 of file expedition.class.php.

◆ disable_delivery_method()

Expedition::disable_delivery_method (   $id)

DesActivate delivery method.

Parameters
id$idid method to desactivate
Returns
void

Definition at line 1930 of file expedition.class.php.

◆ fetch()

Expedition::fetch (   $id,
  $ref = '',
  $ref_ext = '',
  $ref_int = '' 
)

Get object and lines from database.

Parameters
int$idId of object to load
string$refRef of object
string$ref_extExternal reference of object
string$ref_intInternal reference of other object
Returns
int >0 if OK, 0 if not found, <0 if KO

Definition at line 523 of file expedition.class.php.

◆ fetch_delivery_methods()

Expedition::fetch_delivery_methods ( )

Fetch deliveries method and return an array.

Load array this->meths(rowid=>label).

Returns
void

Definition at line 1817 of file expedition.class.php.

◆ fetch_lines()

Expedition::fetch_lines ( )

Load lines.

Returns
int >0 if OK, Otherwise if KO

Definition at line 1369 of file expedition.class.php.

◆ generateDocument()

Expedition::generateDocument (   $modele,
  $outputlangs,
  $hidedetails = 0,
  $hidedesc = 0,
  $hideref = 0,
  $moreparams = null 
)

Create a document onto disk according to template module.

Parameters
string$modeleForce the model to using ('' to not force)
Translate$outputlangsobject lang to use for translations
int$hidedetailsHide details of lines
int$hidedescHide description
int$hiderefHide ref
null | array$moreparamsArray to provide more information
Returns
int 0 if KO, 1 if OK

Definition at line 2309 of file expedition.class.php.

◆ getLibStatut()

Expedition::getLibStatut (   $mode = 0)

Return status label.

Parameters
int$mode0=Long label, 1=Short label, 2=Picto + Short label, 3=Picto, 4=Picto + Long label, 5=Short label + Picto
Returns
string Libelle

Definition at line 1646 of file expedition.class.php.

◆ getNextNumRef()

Expedition::getNextNumRef (   $soc)

Return next contract ref.

Parameters
Societe$socThirdparty object
Returns
string Free reference for contract

Definition at line 210 of file expedition.class.php.

◆ getNomUrl()

Expedition::getNomUrl (   $withpicto = 0,
  $option = '',
  $max = 0,
  $short = 0,
  $notooltip = 0,
  $save_lastsearch_value = -1 
)

Return clicable link of object (with eventually picto)

Parameters
int$withpictoAdd picto into link
string$optionWhere the link point to
int$maxMax length to show
int$shortUse short labels
int$notooltip1=No tooltip
int$save_lastsearch_value-1=Auto, 0=No save of lastsearch_values when clicking, 1=Save lastsearch_values whenclicking
Returns
string String with URL

Definition at line 1596 of file expedition.class.php.

◆ GetUrlTrackingStatus()

Expedition::GetUrlTrackingStatus (   $value = '')

Forge an set tracking url.

Parameters
string$valueValue
Returns
void

Definition at line 1947 of file expedition.class.php.

◆ initAsSpecimen()

Expedition::initAsSpecimen ( )

Initialise an instance with random values.

Used to build previews or test instances. id must be 0 if object instance is a specimen.

Returns
void

Definition at line 1703 of file expedition.class.php.

◆ LibStatut()

Expedition::LibStatut (   $statut,
  $mode 
)

Return label of a status.

Parameters
int$statutId statut
int$mode0=Long label, 1=Short label, 2=Picto + Short label, 3=Picto, 4=Picto + Long label, 5=Short label + Picto
Returns
string Label of status

Definition at line 1659 of file expedition.class.php.

◆ list_delivery_methods()

Expedition::list_delivery_methods (   $id = '')

Fetch all deliveries method and return an array.

Load array this->listmeths.

Parameters
id$idonly this carrier, all if none
Returns
void

Definition at line 1846 of file expedition.class.php.

◆ reOpen()

Expedition::reOpen ( )

Classify the shipping as validated/opened.

Returns
int <0 if KO, 0 if already open, >0 if OK

Definition at line 2176 of file expedition.class.php.

◆ replaceThirdparty()

static Expedition::replaceThirdparty ( DoliDB  $db,
  $origin_id,
  $dest_id 
)
static

Function used to replace a thirdparty id with another one.

Parameters
DoliDB$dbDatabase handler
int$origin_idOld thirdparty id
int$dest_idNew thirdparty id
Returns
bool

Definition at line 2341 of file expedition.class.php.

References CommonObject\commonReplaceThirdparty().

◆ set_billed()

Expedition::set_billed ( )

Classify the shipping as invoiced (used when WORKFLOW_BILL_ON_SHIPMENT is on)

Returns
int <0 if ko, >0 if ok

Definition at line 2133 of file expedition.class.php.

◆ set_date_livraison()

Expedition::set_date_livraison (   $user,
  $date_livraison 
)

Set the planned delivery date.

Parameters
User$userObjet utilisateur qui modifie
timestamp$date_livraisonDate de livraison
Returns
int <0 if KO, >0 if OK

Definition at line 1783 of file expedition.class.php.

◆ setClosed()

Expedition::setClosed ( )

Classify the shipping as closed.

Returns
int <0 if KO, >0 if OK

Definition at line 1982 of file expedition.class.php.

◆ update()

Expedition::update (   $user = null,
  $notrigger = 0 
)

Update database.

Parameters
User$userUser that modify
int$notrigger0=launch triggers after, 1=disable triggers
Returns
int <0 if KO, >0 if OK

Definition at line 1051 of file expedition.class.php.

◆ update_delivery_method()

Expedition::update_delivery_method (   $id = '')

Update/create delivery method.

Parameters
string$idid method to activate
Returns
void

Definition at line 1883 of file expedition.class.php.

◆ valid()

Expedition::valid (   $user,
  $notrigger = 0 
)

Validate object and update stock if option enabled.

Parameters
User$userObject user that validate
int$notrigger1=Does not execute triggers, 0= execute triggers
Returns
int <0 if OK, >0 if KO

Definition at line 649 of file expedition.class.php.

Member Data Documentation

◆ $date

Expedition::$date
Deprecated:
See also
date_shipping

Definition at line 132 of file expedition.class.php.

◆ $date_expedition

Expedition::$date_expedition
Deprecated:
See also
date_shipping

Definition at line 138 of file expedition.class.php.


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