Cyclus Type System (cyclus.typesystem)

class cyclus.typesystem.Blob

State variable descriptor for cyclus::Blob

alias
categorical
copy()

Copies the Blob into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.Bool

State variable descriptor for bool

alias
categorical
copy()

Copies the Bool into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.Double

State variable descriptor for double

alias
categorical
copy()

Copies the Double into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.Float

State variable descriptor for float

alias
categorical
copy()

Copies the Float into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.Int

State variable descriptor for int

alias
categorical
copy()

Copies the Int into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.Inventory

This class represents the special state variables that represent inventories on a Cyclus agent. It presents the same duck-type interface to the StateVar class, but does not inherit from StateVar.

In addition to the usual state variable annotations, this also has a capacity annotation which can be used to specify another state var to read the capcity value from. The capacity state var should be a Float or Double.

alias
capacity
categorical
copy()

Copies the inventory into a new instance. Note that copying an inventory does not copy the underlying resource buffer.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this inventory as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.ListBlob

State variable descriptor for std::list<cyclus::Blob>

alias
categorical
copy()

Copies the ListBlob into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.ListBool

State variable descriptor for std::list<bool>

alias
categorical
copy()

Copies the ListBool into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.ListDouble

State variable descriptor for std::list<double>

alias
categorical
copy()

Copies the ListDouble into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.ListFloat

State variable descriptor for std::list<float>

alias
categorical
copy()

Copies the ListFloat into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.ListInt

State variable descriptor for std::list<int>

alias
categorical
copy()

Copies the ListInt into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.ListPairIntInt

State variable descriptor for std::list<std::pair<int, int>>

alias
categorical
copy()

Copies the ListPairIntInt into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.ListString

State variable descriptor for std::list<std::string>

alias
categorical
copy()

Copies the ListString into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.ListUuid

State variable descriptor for std::list<boost::uuids::uuid>

alias
categorical
copy()

Copies the ListUuid into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.MapIntBlob

State variable descriptor for std::map<int, cyclus::Blob>

alias
categorical
copy()

Copies the MapIntBlob into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.MapIntBool

State variable descriptor for std::map<int, bool>

alias
categorical
copy()

Copies the MapIntBool into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.MapIntDouble

State variable descriptor for std::map<int, double>

alias
categorical
copy()

Copies the MapIntDouble into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.MapIntFloat

State variable descriptor for std::map<int, float>

alias
categorical
copy()

Copies the MapIntFloat into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.MapIntInt

State variable descriptor for std::map<int, int>

alias
categorical
copy()

Copies the MapIntInt into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.MapIntMapStringDouble

State variable descriptor for std::map<int, std::map<std::string, double>>

alias
categorical
copy()

Copies the MapIntMapStringDouble into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.MapIntString

State variable descriptor for std::map<int, std::string>

alias
categorical
copy()

Copies the MapIntString into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.MapIntUuid

State variable descriptor for std::map<int, boost::uuids::uuid>

alias
categorical
copy()

Copies the MapIntUuid into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.MapPairIntStringDouble

State variable descriptor for std::map<std::pair<int, std::string>, double>

alias
categorical
copy()

Copies the MapPairIntStringDouble into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.MapStringBlob

State variable descriptor for std::map<std::string, cyclus::Blob>

alias
categorical
copy()

Copies the MapStringBlob into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.MapStringBool

State variable descriptor for std::map<std::string, bool>

alias
categorical
copy()

Copies the MapStringBool into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.MapStringDouble

State variable descriptor for std::map<std::string, double>

alias
categorical
copy()

Copies the MapStringDouble into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.MapStringFloat

State variable descriptor for std::map<std::string, float>

alias
categorical
copy()

Copies the MapStringFloat into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.MapStringInt

State variable descriptor for std::map<std::string, int>

alias
categorical
copy()

Copies the MapStringInt into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.MapStringMapIntDouble

State variable descriptor for std::map<std::string, std::map<int, double>>

alias
categorical
copy()

Copies the MapStringMapIntDouble into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.MapStringMapStringInt

State variable descriptor for std::map<std::string, std::map<std::string, int>>

alias
categorical
copy()

Copies the MapStringMapStringInt into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.MapStringPairDoubleMapIntDouble

State variable descriptor for std::map<std::string, std::pair<double, std::map<int, double>>>

alias
categorical
copy()

Copies the MapStringPairDoubleMapIntDouble into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.MapStringPairStringVectorDouble

State variable descriptor for std::map<std::string, std::pair<std::string, std::vector<double>>>

alias
categorical
copy()

Copies the MapStringPairStringVectorDouble into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.MapStringString

State variable descriptor for std::map<std::string, std::string>

alias
categorical
copy()

Copies the MapStringString into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.MapStringUuid

State variable descriptor for std::map<std::string, boost::uuids::uuid>

alias
categorical
copy()

Copies the MapStringUuid into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.MapStringVectorDouble

State variable descriptor for std::map<std::string, std::vector<double>>

alias
categorical
copy()

Copies the MapStringVectorDouble into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.MapStringVectorPairIntPairStringString

State variable descriptor for std::map<std::string, std::vector<std::pair<int, std::pair<std::string, std::string>>>>

alias
categorical
copy()

Copies the MapStringVectorPairIntPairStringString into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.Material

The material class is primarily responsible for enabling basic material manipulation while helping enforce mass conservation. It also provides the ability to easily decay a material up to the current simulation time; it does not perform any decay related logic itself.

absorb()

Combines material mat with this one. mat’s quantity becomes zero.

bump_state_id()

Assigns a new, unique internal id to this resource and its state. This should be called by resource implementations whenever their state changes. A call to bump_state_id is not necessarily accompanied by a change to the state id. This should NEVER be called by agents.

clone()

Returns an untracked (not part of the simulation) copy of the material.

comp()

Returns the nuclide composition of this material.

create()

Creates a new material resource that is “live” and tracked. creator is a pointer to the agent creating the resource (usually will be the caller’s “this” pointer). All future output data recorded will be done using the creator’s context.

create_untracked()

Creates a new material resource that does not actually exist as part of the simulation and is untracked.

decay()

Updates the material’s composition by performing a decay calculation. This is a special case of Transmute where the new composition is calculated automatically. The time delta is calculated as the difference between curr_time and the last time the material’s composition was updated with a decay calculation (i.e. prev_decay_time). This may or may not result in an updated material composition. Does nothing if the simulation decay mode is set to “never” or none of the nuclides’ decay constants are significant with respect to the time delta.

decay_heat()

Returns a double with the decay heat of the material in units of W/kg.

extract_comp()

Creates a new material by extracting from this one.

extract_qty()

Same as ExtractComp with c = this->comp() and returns a Material, not a Resource.

extract_res()

Splits the resource and returns the extracted portion as a new resource object. Allows for things like ResBuf and Traders to split offers/requests of arbitrary resource implementation type.

obj_id

The unique id corresponding to this resource object. Can be used to track and/or associate other information with this resource object. You should NOT track resources by pointer.

prev_decay_time

The last time step on which a decay calculation was performed for the material. This is not necessarily synonymous with the last time step the material’s Decay function was called.

qual_id

Returns an id representing the specific resource implementation’s internal state that is not accessible via the Resource class public interface. Any change to the qual_id should always be accompanied by a call to bump_state_id().

quantity

Returns the quantity of this resource with dimensions as specified by the return value of units().

record()

Records the resource’s state to the output database. This method should generally NOT record data accessible via the Resource class public methods (e.g. qual_id, units, type, quantity).

state_id

The unique id corresponding to this resource and its current state. All resource id’s are unique - even across different resource types/implementations. Runtime tracking of resources should generally use the obj_id rather than this.

transmute()

Changes the material’s composition to c without changing its mass. Use this method for things like converting fresh to spent fuel via burning in a reactor.

type

A unique type/name for the concrete resource implementation.

units

Returns the units this resource is based in (e.g. “kg”).

class cyclus.typesystem.MaterialBid

An representation of a bid for a material

bidder

This bid’s agent

commodity

This bid’s commodity

exclusive

This bid’s exclusivity

offer

This bid’s offer material

preference

This bid’s preference

request

This bids request.

requester

This bid’s requester

class cyclus.typesystem.MaterialRequest

An representation of a request for a material

commodity

This request’s commodity

cost_function

This request’s cost function

exclusive

This request’s exclusivity

preference

This request’s preference

requester

This request’s agent

target

This request’s target material

class cyclus.typesystem.MaterialTrade

Trade is a simple container that associates a request for a resource with a bid for that resource.

amt

The quantity assigned to the Trade. May be less than either the request or bid quantity.

bid

This trade’s bid.

price

Trades have a price member which is not currently used.

request

This trade’s request.

class cyclus.typesystem.PairDoubleDouble

State variable descriptor for std::pair<double, double>

alias
categorical
copy()

Copies the PairDoubleDouble into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.PairDoubleMapIntDouble

State variable descriptor for std::pair<double, std::map<int, double>>

alias
categorical
copy()

Copies the PairDoubleMapIntDouble into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.PairIntBlob

State variable descriptor for std::pair<int, cyclus::Blob>

alias
categorical
copy()

Copies the PairIntBlob into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.PairIntBool

State variable descriptor for std::pair<int, bool>

alias
categorical
copy()

Copies the PairIntBool into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.PairIntDouble

State variable descriptor for std::pair<int, double>

alias
categorical
copy()

Copies the PairIntDouble into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.PairIntFloat

State variable descriptor for std::pair<int, float>

alias
categorical
copy()

Copies the PairIntFloat into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.PairIntInt

State variable descriptor for std::pair<int, int>

alias
categorical
copy()

Copies the PairIntInt into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.PairIntPairStringString

State variable descriptor for std::pair<int, std::pair<std::string, std::string>>

alias
categorical
copy()

Copies the PairIntPairStringString into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.PairIntString

State variable descriptor for std::pair<int, std::string>

alias
categorical
copy()

Copies the PairIntString into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.PairIntUuid

State variable descriptor for std::pair<int, boost::uuids::uuid>

alias
categorical
copy()

Copies the PairIntUuid into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.PairPairDoubleDoubleMapStringDouble

State variable descriptor for std::pair<std::pair<double, double>, std::map<std::string, double>>

alias
categorical
copy()

Copies the PairPairDoubleDoubleMapStringDouble into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.PairStringBlob

State variable descriptor for std::pair<std::string, cyclus::Blob>

alias
categorical
copy()

Copies the PairStringBlob into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.PairStringBool

State variable descriptor for std::pair<std::string, bool>

alias
categorical
copy()

Copies the PairStringBool into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.PairStringDouble

State variable descriptor for std::pair<std::string, double>

alias
categorical
copy()

Copies the PairStringDouble into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.PairStringFloat

State variable descriptor for std::pair<std::string, float>

alias
categorical
copy()

Copies the PairStringFloat into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.PairStringInt

State variable descriptor for std::pair<std::string, int>

alias
categorical
copy()

Copies the PairStringInt into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.PairStringString

State variable descriptor for std::pair<std::string, std::string>

alias
categorical
copy()

Copies the PairStringString into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.PairStringUuid

State variable descriptor for std::pair<std::string, boost::uuids::uuid>

alias
categorical
copy()

Copies the PairStringUuid into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.PairStringVectorDouble

State variable descriptor for std::pair<std::string, std::vector<double>>

alias
categorical
copy()

Copies the PairStringVectorDouble into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.Product

A Product is a general type of resource in the Cyclus simulation, and is a catch-all for non-standard resources. It implements the Resource class interface in a simple way usable for things such as: bananas, water, buying power, etc.

absorb()

Absorbs the contents of the given ‘other’ resource into this resource.

bump_state_id()

Assigns a new, unique internal id to this resource and its state. This should be called by resource implementations whenever their state changes. A call to bump_state_id is not necessarily accompanied by a change to the state id. This should NEVER be called by agents.

clone()

Returns an untracked (not part of the simulation) copy of the product.

create()

Creates a new product resource that is “live” and tracked. creator is a pointer to the agent creating the resource (usually will be the caller’s “this” pointer). All future output data recorded will be done using the creator’s context.

create_untracked()

Creates a new product that does not actually exist as part of the simulation and is untracked.

extract()

Extracts the specified mass from this resource and returns it as a new product object with the same quality/type.

extract_res()

Splits the resource and returns the extracted portion as a new resource object. Allows for things like ResBuf and Traders to split offers/requests of arbitrary resource implementation type.

obj_id

The unique id corresponding to this resource object. Can be used to track and/or associate other information with this resource object. You should NOT track resources by pointer.

qual_id

Returns an id representing the specific resource implementation’s internal state that is not accessible via the Resource class public interface. Any change to the qual_id should always be accompanied by a call to bump_state_id().

quantity

Returns the quantity of this resource with dimensions as specified by the return value of units().

record()

Records the resource’s state to the output database. This method should generally NOT record data accessible via the Resource class public methods (e.g. qual_id, units, type, quantity).

state_id

The unique id corresponding to this resource and its current state. All resource id’s are unique - even across different resource types/implementations. Runtime tracking of resources should generally use the obj_id rather than this.

type

A unique type/name for the concrete resource implementation.

units

Returns the units this resource is based in (e.g. “kg”).

class cyclus.typesystem.ProductBid

An representation of a bid for a product

bidder

This bid’s agent

commodity

This bid’s commodity

exclusive

This bid’s exclusivity

offer

This bid’s offer product

preference

This bid’s preference

request

This bids request.

requester

This bid’s requester

class cyclus.typesystem.ProductRequest

An representation of a request for a product

commodity

This request’s commodity

cost_function

This request’s cost function

exclusive

This request’s exclusivity

preference

This request’s preference

requester

This request’s agent

target

This request’s target product

class cyclus.typesystem.ProductTrade

Trade is a simple container that associates a request for a resource with a bid for that resource.

amt

The quantity assigned to the Trade. May be less than either the request or bid quantity.

bid

This trade’s bid.

price

Trades have a price member which is not currently used.

request

This trade’s request.

class cyclus.typesystem.ResBufMaterial

An Inventory wrapper class for cyclus::toolkit::ResBuf<cyclus::Material>.

capacity

The maximum resource quantity this store can hold.

count

the total number of constituent resource objects in the store.

empty()

Returns true if nothing is stored.

peek()

Returns the next resource in line to be popped from the buffer without actually removing it from the buffer.

pop()

Pops one Material object from the store. Neagtive values of qty and eps are ignored.

pop_all_res()

A consistent interface for popping all of the resources from the buffer. For ResBuf, this is equivalent to self.pop_n_res(len(self))

pop_back()

Same as Pop, except it returns the most recently added resource.

pop_n()

Pops the specified number of Materials from the buffer.

pop_n_res()

Pops the specified number of resources from the buffer.

push()

Pushes a single resource object to the buffer.

push_many()

A consistent interface for pushing many resources into the buffer. For ResBuf, this iteratively calls push().

quantity

The total resource quantity of constituent resource objects in the store.

space

The quantity of space remaining in this store.

class cyclus.typesystem.ResBufMaterialInv

Inventory descriptor for cyclus::toolkit::ResBuf<cyclus::Material>

alias
capacity
categorical
copy()

Copies the ResBufMaterial into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this inventory as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.ResBufProduct

An Inventory wrapper class for cyclus::toolkit::ResBuf<cyclus::Product>.

capacity

The maximum resource quantity this store can hold.

count

the total number of constituent resource objects in the store.

empty()

Returns true if nothing is stored.

peek()

Returns the next resource in line to be popped from the buffer without actually removing it from the buffer.

pop()

Pops one Product object from the store. Neagtive values of qty and eps are ignored.

pop_all_res()

A consistent interface for popping all of the resources from the buffer. For ResBuf, this is equivalent to self.pop_n_res(len(self))

pop_back()

Same as Pop, except it returns the most recently added resource.

pop_n()

Pops the specified number of Products from the buffer.

pop_n_res()

Pops the specified number of resources from the buffer.

push()

Pushes a single resource object to the buffer.

push_many()

A consistent interface for pushing many resources into the buffer. For ResBuf, this iteratively calls push().

quantity

The total resource quantity of constituent resource objects in the store.

space

The quantity of space remaining in this store.

class cyclus.typesystem.ResBufProductInv

Inventory descriptor for cyclus::toolkit::ResBuf<cyclus::Product>

alias
capacity
categorical
copy()

Copies the ResBufProduct into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this inventory as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.ResMapIntMaterial

An Inventory wrapper class for cyclus::toolkit::ResMap<int, cyclus::Material>.

clear()

Removes all elements from the map.

empty()

Returns true if nothing is stored.

pop()

Pops one Material object from the store.

pop_all_res()

A consistent interface for popping all of the resources from the buffer. For ResBuf, this is equivalent to self.res_values()

push_many()

A consistent interface for pushing many resources into the buffer. For ResMap, this calls ResValues(vals).

quantity

The total resource quantity of constituent resource objects in the store.

res_values()

Pops the resources from the buffer. For the version of this method which sets resources, see push_many().

size

The total number of resources in the map.

values()

Returns a vector of the values in the map

class cyclus.typesystem.ResMapIntMaterialInv

Inventory descriptor for cyclus::toolkit::ResMap<int, cyclus::Material>

alias
capacity
categorical
copy()

Copies the ResMapIntMaterial into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this inventory as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.ResMapIntProduct

An Inventory wrapper class for cyclus::toolkit::ResMap<int, cyclus::Product>.

clear()

Removes all elements from the map.

empty()

Returns true if nothing is stored.

pop()

Pops one Product object from the store.

pop_all_res()

A consistent interface for popping all of the resources from the buffer. For ResBuf, this is equivalent to self.res_values()

push_many()

A consistent interface for pushing many resources into the buffer. For ResMap, this calls ResValues(vals).

quantity

The total resource quantity of constituent resource objects in the store.

res_values()

Pops the resources from the buffer. For the version of this method which sets resources, see push_many().

size

The total number of resources in the map.

values()

Returns a vector of the values in the map

class cyclus.typesystem.ResMapIntProductInv

Inventory descriptor for cyclus::toolkit::ResMap<int, cyclus::Product>

alias
capacity
categorical
copy()

Copies the ResMapIntProduct into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this inventory as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.ResMapStringMaterial

An Inventory wrapper class for cyclus::toolkit::ResMap<std::string, cyclus::Material>.

clear()

Removes all elements from the map.

empty()

Returns true if nothing is stored.

pop()

Pops one Material object from the store.

pop_all_res()

A consistent interface for popping all of the resources from the buffer. For ResBuf, this is equivalent to self.res_values()

push_many()

A consistent interface for pushing many resources into the buffer. For ResMap, this calls ResValues(vals).

quantity

The total resource quantity of constituent resource objects in the store.

res_values()

Pops the resources from the buffer. For the version of this method which sets resources, see push_many().

size

The total number of resources in the map.

values()

Returns a vector of the values in the map

class cyclus.typesystem.ResMapStringMaterialInv

Inventory descriptor for cyclus::toolkit::ResMap<std::string, cyclus::Material>

alias
capacity
categorical
copy()

Copies the ResMapStringMaterial into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this inventory as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.ResMapStringProduct

An Inventory wrapper class for cyclus::toolkit::ResMap<std::string, cyclus::Product>.

clear()

Removes all elements from the map.

empty()

Returns true if nothing is stored.

pop()

Pops one Product object from the store.

pop_all_res()

A consistent interface for popping all of the resources from the buffer. For ResBuf, this is equivalent to self.res_values()

push_many()

A consistent interface for pushing many resources into the buffer. For ResMap, this calls ResValues(vals).

quantity

The total resource quantity of constituent resource objects in the store.

res_values()

Pops the resources from the buffer. For the version of this method which sets resources, see push_many().

size

The total number of resources in the map.

values()

Returns a vector of the values in the map

class cyclus.typesystem.ResMapStringProductInv

Inventory descriptor for cyclus::toolkit::ResMap<std::string, cyclus::Product>

alias
capacity
categorical
copy()

Copies the ResMapStringProduct into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this inventory as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.Resource

Resource defines an abstract interface implemented by types that are offered, requested, and transferred between simulation agents. Resources represent the lifeblood of a simulation.

bump_state_id()

Assigns a new, unique internal id to this resource and its state. This should be called by resource implementations whenever their state changes. A call to bump_state_id is not necessarily accompanied by a change to the state id. This should NEVER be called by agents.

clone()

Returns an untracked (not part of the simulation) copy of the resource. A cloned resource should never record anything in the output database.

extract_res()

Splits the resource and returns the extracted portion as a new resource object. Allows for things like ResBuf and Traders to split offers/requests of arbitrary resource implementation type.

obj_id

The unique id corresponding to this resource object. Can be used to track and/or associate other information with this resource object. You should NOT track resources by pointer.

qual_id

Returns an id representing the specific resource implementation’s internal state that is not accessible via the Resource class public interface. Any change to the qual_id should always be accompanied by a call to bump_state_id().

quantity

Returns the quantity of this resource with dimensions as specified by the return value of units().

record()

Records the resource’s state to the output database. This method should generally NOT record data accessible via the Resource class public methods (e.g. qual_id, units, type, quantity).

state_id

The unique id corresponding to this resource and its current state. All resource id’s are unique - even across different resource types/implementations. Runtime tracking of resources should generally use the obj_id rather than this.

type

A unique type/name for the concrete resource implementation.

units

Returns the units this resource is based in (e.g. “kg”).

class cyclus.typesystem.ResourceBuff

An Inventory wrapper class for cyclus::toolkit::ResourceBuff.

capacity

The maximum resource quantity this store can hold.

count

the total number of constituent resource objects in the store.

empty()

Returns true if nothing is stored.

pop()

Pops one resource object from the store.

pop_all_res()

A consistent interface for popping all of the resources from the buffer. For ResourceBuff, this is equivalent to self.pop_n(len(self))

pop_material()

Pops one resource object from the store as a material.

pop_n()

Pops the specified number of resources from the buffer.

pop_product()

Pops one resource object from the store as a product.

pop_qty()

Pops the specified quantity of resources from the buffer. Negative eps values are ignored (default).

push()

Pushes a single resource object to the buffer.

push_all()

Pushes one or more resource objects to the store.

push_many()

A consistent interface for pushing many resources into the buffer. For ResourceBuff, this simply calls push_all().

quantity

The total resource quantity of constituent resource objects in the store.

space

The quantity of space remaining in this store.

class cyclus.typesystem.ResourceBuffInv

Inventory descriptor for cyclus::toolkit::ResourceBuff

alias
capacity
categorical
copy()

Copies the ResourceBuff into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this inventory as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.SetBlob

State variable descriptor for std::set<cyclus::Blob>

alias
categorical
copy()

Copies the SetBlob into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.SetBool

State variable descriptor for std::set<bool>

alias
categorical
copy()

Copies the SetBool into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.SetDouble

State variable descriptor for std::set<double>

alias
categorical
copy()

Copies the SetDouble into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.SetFloat

State variable descriptor for std::set<float>

alias
categorical
copy()

Copies the SetFloat into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.SetInt

State variable descriptor for std::set<int>

alias
categorical
copy()

Copies the SetInt into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.SetString

State variable descriptor for std::set<std::string>

alias
categorical
copy()

Copies the SetString into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.SetUuid

State variable descriptor for std::set<boost::uuids::uuid>

alias
categorical
copy()

Copies the SetUuid into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.StateVar

This class represents a state variable on a Cyclus agent.

key meaning
type The C++ type. Valid types may be found on the dbtypes page. READ ONLY: Do not set this key in #pragma cyclus var {...} as it is set automatically by cycpp. Feel free to use this downstream in your class or in a post-process.
index Which number state variable is this, 0-indexed. READ ONLY: Do not set this key in #pragma cyclus var {...} as it is set automatically by cycpp. Feel free to use this downstream in your class or in a post-process.
default The default value for this variable that is used if otherwise unspecified. The value must match the type of the variable.
internal True if this state variable is only for archetype-internal usage. Although the variable will still be persisted in the database and initialized normally (e.g. with any default), it will not be included in the XML schema or input file.
shape The shape of a variable length datatypes. If present this must be a list of integers whose length (rank) makes sense for this type. Specifying positive values will (depending on the backend) turn a variable length type into a fixed length one with the length of the given value. Putting a -1 in the shape will retain the variable length nature along that axis. Fixed length variables are normally more performant so it is often a good idea to specify the shape where possible. For example, a length-5 string would have a shape of [5] and a length-10 vector of variable length strings would have a shape of [10, -1].
doc Documentation string.
tooltip Brief documentation string for user interfaces.
units The physical units, if any.
userlevel Integer from 0 - 10 for representing ease (0) or difficulty (10) in using this variable, default 0.
alias The name of the state variable in the schema and input file. If this is not present it defaults to the C++ variable name. The alias may also be a nested list of strings that matches the C++ template type. Each member of the hierarchy will recieve the corresponding alias. For example, a [std::map, int, double] could be aliased by ['recipe', 'id', 'mass']. For maps, an additional item tag is inserted. To also alias the item tag, make the top alias into a 2-element list, whose first string represents the map and whose second string is the item alias, e.g. [['recipe', 'entry'], 'id', 'mass']
uilabel The text string a UI will display as the name of this input on the UI input form.
uitype The type of the input field in reference in a UI, currently supported types are; incommodity, outcommodity, commodity, range, combobox, facility, prototype, recipe, nuclide, and none. For ‘nuclide’ when the type is an int, the values will be read in from the input file in human readable string format (‘U-235’) and automatically converted to results of pyne::nucname::id() (922350000) in the database and on the archetype.
range This indicates the range associated with a range type. It must take the form of [min, max] or [min, max, (optional) step size].
categorical This indicates the decrete values a combobox Type can take. It must take the form of [value1, value2, value3, etc].
schematype This is the data type that is used in the schema for input file validation. This enables you to supply just the data type rather than having to overwrite the full schema for this state variable. In most cases - when the shape is rank 0 or 1 such as for scalars or vectors - this is simply a string. In cases where the rank is 2+ this is a list of strings. Please refer to the XML Schema Datatypes page for more information. New in v1.1.
initfromcopy Code snippet to use in the InitFrom(Agent* m) function for this state variable instead of using code generation. This is a string.
initfromdb Code snippet to use in the InitFrom(QueryableBackend* b) function for this state variable instead of using code generation. This is a string.
infiletodb Code snippets to use in the InfileToDb() function for this state variable instead of using code generation. This is a dictionary of string values with the two keys ‘read’ and ‘write’ which represent reading values from the input file writing them out to the database respectively.
schema Code snippet to use in the schema() function for this state variable instead of using code generation. This is an RNG string. If you supply this then you likely need to supply infiletodb as well to ensure that your custom schema is read into the database correctly.
snapshot Code snippet to use in the Snapshot() function for this state variable instead of using code generation. This is a string.
snapshotinv Code snippet to use in the SnapshotInv() function for this state variable instead of using code generation. This is a string.
initinv Code snippet to use in the InitInv() function for this state variable instead of using code generation. This is a string.
uniquetypeid The dbtype id for the type that is unique among all dbtypes for a given C++ representations. READ ONLY: Do not set this key!!!
alias
categorical
copy()

Copies the state variable into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.String

State variable descriptor for std::string

alias
categorical
copy()

Copies the String into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.Uuid

State variable descriptor for boost::uuids::uuid

alias
categorical
copy()

Copies the Uuid into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.VectorBlob

State variable descriptor for std::vector<cyclus::Blob>

alias
categorical
copy()

Copies the VectorBlob into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.VectorBool

State variable descriptor for std::vector<bool>

alias
categorical
copy()

Copies the VectorBool into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.VectorDouble

State variable descriptor for std::vector<double>

alias
categorical
copy()

Copies the VectorDouble into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.VectorFloat

State variable descriptor for std::vector<float>

alias
categorical
copy()

Copies the VectorFloat into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.VectorInt

State variable descriptor for std::vector<int>

alias
categorical
copy()

Copies the VectorInt into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.VectorPairIntPairStringString

State variable descriptor for std::vector<std::pair<int, std::pair<std::string, std::string>>>

alias
categorical
copy()

Copies the VectorPairIntPairStringString into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.VectorPairPairDoubleDoubleMapStringDouble

State variable descriptor for std::vector<std::pair<std::pair<double, double>, std::map<std::string, double>>>

alias
categorical
copy()

Copies the VectorPairPairDoubleDoubleMapStringDouble into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.VectorString

State variable descriptor for std::vector<std::string>

alias
categorical
copy()

Copies the VectorString into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
class cyclus.typesystem.VectorUuid

State variable descriptor for std::vector<boost::uuids::uuid>

alias
categorical
copy()

Copies the VectorUuid into a new instance.

default
doc
index
infiletodb
initfromcopy
initfromdb
initinv
internal
name
range
schema
schematype
shape
snapshot
snapshotinv
to_dict()

Returns a representation of this state variable as a dict.

tooltip
type
uilabel
uitype
uniquetypeid
units
userlevel
value
cyclus.typesystem.prepare_type_representation()

Updates othertype to conform to the length of cpptype using None’s.