complexType "cc:MultiPeriodGenParams"

Namespace: | http://www.iro.umontreal.ca/lecuyer/contactcenters
Content: | complex, 6 attributes, 4 elements
Defined: | globally in cc.xsd, see XML source
Includes: | definitions of 6 attributes and 4 elements
Used: | at 6 locations

XML Representation Summary
<...
| distributionClass | = | xsd:string
| estimateParameters | = | xsd:boolean : "false"
| generatorClass | = | xsd:string
| mult | = | xsd:double : "1"
| shift | = | xsd:double
| unit | = | ("NANOSECOND" | "MICROSECOND" | "MILLISECOND" | "SECOND" | "MINUTE" | "HOUR" | "DAY" | "WEEK")
| >
Content: | defaultGen?, preGen?, wrapGen?, periodGen*
</...>

Content Elements (4):

  defaultGen (type ssj:RandomVariateGenParams), periodGen (type extension of ssj:RandomVariateGenParams), | preGen (type ssj:RandomVariateGenParams), wrapGen (type ssj:RandomVariateGenParams)

Known Direct Subtypes (1):

  ccmsk:ServiceTimeParams

All Direct / Indirect Based Elements (10):

  arrivalRates (type cc:MultiPeriodGenParams), conferenceTime (type ccmsk:ServiceTimeParams), disconnectTime (type cc:MultiPeriodGenParams), failTime (type cc:MultiPeriodGenParams), patienceTime (type cc:MultiPeriodGenParams), | preServiceTimeNoConf (type ccmsk:ServiceTimeParams), previewTime (type ccmsk:ServiceTimeParams), reachTime (type cc:MultiPeriodGenParams), serviceTime (type ccmsk:ServiceTimeParams), transferTime (type ccmsk:ServiceTimeParams)

Known Usage Locations

- In derivations of other global types (1):

  ccmsk:ServiceTimeParams (as extension base) |

- As direct type of elements (5):

  arrivalRates (type cc:MultiPeriodGenParams), disconnectTime (type cc:MultiPeriodGenParams), failTime (type cc:MultiPeriodGenParams), | patienceTime (type cc:MultiPeriodGenParams), reachTime (type cc:MultiPeriodGenParams)

Annotation
Represents parameters for a random variate generator over multiple periods. Such a generator is defined by specifying a random variate generator for each main period of the time horizon, using `periodGen` elements. One can also give a specific generator for the preliminary and wrap-up periods using `preGen` , and `wrapGen,` respectively. For more convenience, this type defines attributes for the distribution class, generator class, parameter estimation, and shift that are inherited by child elements. This permits one to omit these attributes in the child elements corresponding to parameters of random variate generators. A `repeat` attribute can also be used to duplicate the same parameters over several successive periods. Moreover, the default distribution, if given using the `defaultGen` element, is used as follows by the simulator. Let P be the total number of main periods of the time horizon. If at least P period-specific sets of parameters are available, the first `P` sets are used to construct the generator. Otherwise, the Q < P available sets of parameters are used, and the default set of parameters is used P - Q times to replace missing sets of parameters.

Variates can be transformed after they are generated. First, they are converted from the unit given by `unit` to the default time unit used by the application. Then, they are multiplied by the factor given by the `mult` attribute. They may also be multiplied by other factors depending on the role of the random variates.

The class `CCParamReadHelper` in package `umontreal.iro.lecuyer.contactcenters` provides helper methods to create a random variate generator for multiple periods from any instance of the class derived by JAXB from this complex type.

For example, let `mpg` be an element representing a random variate generator over multiple periods. The following XML code describes a random variate generator with parameters depending on the main period.

    <mpg distributionClass="ExponentialDist" unit="MINUTE">
                     <defaultGen>10</defaultGen> <periodGen repeat="3">5</periodGen>
                     </mpg>

The `distributionClass` attribute of `mpg` is inherited by `defaultGen` and `periodGen` elements so every period-specific distribution is exponential. The mean is 1/3min for the first three periods while it is 1/10min for the other periods.

XML Source (w/o annotations (12); see schema source)

<xsd:complexType name="MultiPeriodGenParams"> <xsd:sequence> <xsd:element maxOccurs="1" minOccurs="0" name="defaultGen" type="ssj:RandomVariateGenParams"> </xsd:element> <xsd:element maxOccurs="1" minOccurs="0" name="preGen" type="ssj:RandomVariateGenParams"> </xsd:element> <xsd:element maxOccurs="1" minOccurs="0" name="wrapGen" type="ssj:RandomVariateGenParams"> </xsd:element> <xsd:element maxOccurs="unbounded" minOccurs="0" name="periodGen"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="ssj:RandomVariateGenParams"> <xsd:attribute default="1" name="repeat" type="ssj:nonNegativeInt"> </xsd:attribute> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:sequence> <xsd:attribute name="distributionClass" type="xsd:string"> </xsd:attribute> <xsd:attribute name="generatorClass" type="xsd:string"> </xsd:attribute> <xsd:attribute name="shift" type="xsd:double"> </xsd:attribute> <xsd:attribute default="false" name="estimateParameters" type="xsd:boolean"> </xsd:attribute> <xsd:attribute name="unit" type="ssj:TimeUnitParam"> </xsd:attribute> <xsd:attribute default="1" name="mult" type="ssj:nonNegativeDouble"> </xsd:attribute> </xsd:complexType>

Attribute Detail
distributionClass

  Gives the default Java class name for the probability distribution. This attribute is inherited by children of this element if they do not specify it.

  Type: | xsd:string
  Use: | optional
  Defined: | locally, within (this) cc:MultiPeriodGenParams complexType

  XML Source (w/o annotations (1); see schema source)

  <xsd:attribute name="distributionClass" type="xsd:string"> </xsd:attribute>

estimateParameters

  Determines if parameter estimation needs to be performed by default.

  Type: | xsd:boolean
  Use: | optional
  Default: | "false"
  Defined: | locally, within (this) cc:MultiPeriodGenParams complexType

  XML Source (w/o annotations (1); see schema source)

  <xsd:attribute default="false" name="estimateParameters" type="xsd:boolean"> </xsd:attribute>

generatorClass

  Gives the default Java class name for the random variate generator. This attribute is inherited by children of this element if they do not specify it.

  Type: | xsd:string
  Use: | optional
  Defined: | locally, within (this) cc:MultiPeriodGenParams complexType

  XML Source (w/o annotations (1); see schema source)

  <xsd:attribute name="generatorClass" type="xsd:string"> </xsd:attribute>

mult

  Determines the multiplier applied to each random value generated by this multi-period generator. This multiplier can be used to change the mean of the random variates without altering each period-specific distribution. The default value of the multiplier is 1.

  Type: | ssj:nonNegativeDouble
  Use: | optional
  Default: | "1"
  Defined: | locally, within (this) cc:MultiPeriodGenParams complexType

  XML Source (w/o annotations (1); see schema source)

  <xsd:attribute default="1" name="mult" type="ssj:nonNegativeDouble"> </xsd:attribute>

shift

  Gives the default shift subtracted to any generated value. This attribute is inherited by children of this element if they do not specify it.

  Type: | xsd:double
  Use: | optional
  Defined: | locally, within (this) cc:MultiPeriodGenParams complexType

  XML Source (w/o annotations (1); see schema source)

  <xsd:attribute name="shift" type="xsd:double"> </xsd:attribute>

unit

  Defines the time unit in which generated values are expressed.

  Type: | ssj:TimeUnitParam
  Use: | optional
  Defined: | locally, within (this) cc:MultiPeriodGenParams complexType

  XML Source (w/o annotations (1); see schema source)

  <xsd:attribute name="unit" type="ssj:TimeUnitParam"> </xsd:attribute>

Content Element Detail
defaultGen

  Defines the parameters of the default random variate generator. These parameters are used when the number of main periods exceeds the number of per-period parameters specified. This can also be used to specify a generator used for all periods.

  Type: | ssj:RandomVariateGenParams, simple content
  Defined: | locally, within (this) cc:MultiPeriodGenParams complexType

  XML Source (w/o annotations (1); see schema source)

  <xsd:element maxOccurs="1" minOccurs="0" name="defaultGen" type="ssj:RandomVariateGenParams"> </xsd:element>

periodGen

  Defines the parameters of a random variate generator used during a specific main period of the time horizon. For convenience, parameters can be repeated more than once for successive main periods by using the `repeat` attribute.

  Type: | embedded (extension of ssj:RandomVariateGenParams), empty content
  Defined: | locally, within (this) cc:MultiPeriodGenParams complexType

preGen

  Defines the parameters of the random variate generator used during the preliminary period. If this element is omitted, the generator of the first main period is used during preliminary period.

  Type: | ssj:RandomVariateGenParams, simple content
  Defined: | locally, within (this) cc:MultiPeriodGenParams complexType

  XML Source (w/o annotations (1); see schema source)

  <xsd:element maxOccurs="1" minOccurs="0" name="preGen" type="ssj:RandomVariateGenParams"> </xsd:element>

wrapGen

  Defines the parameters of the random variate generator used during the wrap-up period. If this element is omitted, the generator of the last main period is used during wrap-up period.

  Type: | ssj:RandomVariateGenParams, simple content
  Defined: | locally, within (this) cc:MultiPeriodGenParams complexType

  XML Source (w/o annotations (1); see schema source)

  <xsd:element maxOccurs="1" minOccurs="0" name="wrapGen" type="ssj:RandomVariateGenParams"> </xsd:element>

XML Schema documentation generated with DocFlex/XML (Kit) v1.6.8 DocFlex/XML (Kit) is a freeware edition of DocFlex/XML, which is a powerful template-driven documentation and report generator from any data stored in XML files. Based on an innovative technology developed by FILIGRIS WORKS, this new tool offers virtuoso data querying and formatting capabilities not found in anything else! Need to convert your XML data into a clear nice-looking documentation or reports? Web-ready hypertext HTML or printable MS Word / OpenOffice.org friendly RTF? DocFlex/XML may be a cheap, quick and effective solution exactly for this task! Have questions? Not sure how to use it? Just send us e-mail to contact@filigris.com and we are always happy to help you! See also our services at www.filigris.com