Antares Xpansion
Investment simulations for Antares studies
Loading...
Searching...
No Matches
user_input_translation.TrajectoryConstraint Class Reference
Inheritance diagram for user_input_translation.TrajectoryConstraint:

Public Member Functions

List[Dict[str, Any]] to_individual_max_investment (self, Dict[str, Set[str]] candidate_appear_in_nodes)
 
List[Dict[str, Any]] to_individual_max_retirement (self, Dict[str, Set[str]] candidate_appear_in_nodes)
 
List[Dict[str, Any]] to_cumulative_max_investment (self, Dict[str, Set[str]] candidate_appear_in_nodes)
 
List[Dict[str, Any]] to_cumulative_max_retirement (self, Dict[str, Set[str]] candidate_appear_in_nodes)
 
List[Dict[str, Any]] to_individual_min_investment (self, Dict[str, Set[str]] candidate_appear_in_nodes)
 
List[Dict[str, Any]] to_individual_min_retirement (self, Dict[str, Set[str]] candidate_appear_in_nodes)
 
List[Dict[str, Any]] to_merger_json (self, Dict[str, Set[str]] candidate_appear_in_nodes)
 

Static Public Member Functions

 build_variable_reference (str node, str candidate, InvestmentVariableTypeEnum variable_type)
 

Public Attributes

list cons_type = []
 
dict candidates = {}
 
dict nodes = {}
 

Static Public Attributes

str name = Field(alias=InKeys.constraint_name_key())
 
Union nodes
 
Union candidates
 
ConstraintTypeEnum cons_type = Field(alias=InKeys.constraint_type_key())
 
float rhs = Field(alias=InKeys.constraint_rhs_key())
 

Member Function Documentation

◆ to_merger_json()

List[Dict[str, Any]] user_input_translation.TrajectoryConstraint.to_merger_json ( self,
Dict[str, Set[str]] candidate_appear_in_nodes )
Converts an constraint in input format to a list of mathematical formulations for the C++ merger
Skips the candidate when the candidate is not present in the node.

Member Data Documentation

◆ candidates

dict user_input_translation.TrajectoryConstraint.candidates
static
Initial value:
= Field(
alias=InKeys.constraints_candidates_key()
)

◆ nodes

dict user_input_translation.TrajectoryConstraint.nodes
static
Initial value:
= Field(
alias=InKeys.constraints_nodes_key()
)

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