Gerenciamento de Cenários da API Aimsun Next¶
Funções relacionadas a Objetos ANG, Replicação, Experimento e Informações de Cenário¶
Obter Identificador de Replicação ANG¶
Em C++ e Python¶
Explicação¶
Obtenha o identificador de replicação.
Formato¶
unsigned int ANGConnGetReplicationId ();
Parâmetros¶
Nenhum.
Saída¶
- > 0: Identificador de replicação.
- = 0: Erro.
Obter Identificador de Experimento ANG¶
Em C++ e Python¶
Explicação¶
Obtenha o identificador do experimento.
Formato¶
unsigned int ANGConnGetExperimentId ();
Parâmetros¶
Nenhum.
Saída¶
- > 0: Identificador do experimento.
- = 0: Erro.
Obter Identificador de Cenário ANG¶
Em C++ e Python¶
Explicação¶
Obtenha o identificador do cenário.
Formato¶
unsigned int ANGConnGetScenarioId ();
Parâmetros: Nenhum.¶
Saída¶
- > 0: Identificador do cenário.
- = 0: Erro.
Obter Data Simulada e Hora Inicial do Cenário ANG¶
Em C++ e Python¶
Explicação¶
Obtenha a Data Simulada e a Hora Inicial do cenário.
Formato¶
const char * ANGConnGetScenarioTime();
Parâmetros¶
Nenhum.
Saída¶
- ≠ NULL: Retorna uma string com a data e hora do cenário usando o formato ISO 8601 estendido (YYYY-MM-DDTHH:MM:SS), ou uma string vazia se nenhuma informação estiver disponível. Não exclua esta string.
- = NULL: Erro.
Funções relacionadas à Conexão de Objetos ANG¶
Obter ID do Objeto ANG¶
Em C++ e Python¶
Explicação¶
Obtenha o ID de qualquer objeto pelo nome.
Formato¶
int ANGConnGetObjectId( const unsigned short * name, bool deleteUShortName ); // Deprecated
int ANGConnGetObjectIdByType( const unsigned short * name, const unsigned short * typeName, bool deleteUShortName );
Parâmetros¶
- name: O nome do objeto.
- typeName: Filtra a busca pelo nome do tipo do objeto. Quando NULL, retorna o primeiro objeto que corresponde ao nome.
- deleteUShortName: verdadeiro se o nome deve ser excluído automaticamente.
Saída¶
- > 0: ID do objeto.
- < 0: o objeto não existe.
Obter Atributo do Objeto ANG¶
Em C++ e Python¶
Explicação¶
Obtenha um ponteiro para um atributo de um objeto ANG. Este ponteiro pode ser usado para modificar ou ler o valor do atributo de diferentes objetos, usando as funções ANGConnSetAttributeValue ou ANGConnGetAttributeValue. No Aimsun Next, os nomes internos dos atributos de cada tipo de objeto podem ser exibidos selecionando Window / Type no menu principal.
Formato¶
void * ANGConnGetAttribute(const unsigned short * internalAttrName );
Parâmetros¶
- internalAttrName: O nome interno do atributo.
Saída¶
- ≠ NULL: ponteiro para o atributo.
- = NULL: Erro.
Criar Atributo do Objeto ANG¶
Em C++ e Python¶
Explicação¶
Crie um atributo de um objeto ANG. Este ponteiro pode ser usado para modificar ou ler o valor do atributo de diferentes objetos, usando as funções ANGConnSetAttributeValue ou ANGConnGetAttributeValue. Os nomes internos dos atributos de cada tipo de objeto podem ser exibidos selecionando Window / Type no menu principal.
Formato¶
void * ANGConnCreateAttribute(const unsigned short * typeName, const unsigned short * internalAttrName, const unsigned short * externalAttrName, int attrType, int columnType);
Parâmetros¶
- typeName: Nome do objeto ANG.
- internalAttrName: Nome interno do atributo.
- externalAttrName: Nome externo do atributo (como exibido nos editores do objeto).
- attrType: INTEGER_TYPE como inteiro, DOUBLE_TYPE como double ou STRING_TYPE como uma string.
- columnType: Define a forma de armazenar a coluna como EXTERNAL_TEMPORAL, INTERNAL ou EXTERNAL.
Saída¶
- ≠ NULL: ponteiro para o atributo.
- = NULL: Erro.
Criar Atributo de Série Temporal do Objeto ANG¶
Em C++ e Python¶
Explicação¶
Crie um atributo de série temporal de um objeto ANG. Este ponteiro pode ser usado para modificar ou ler o valor do atributo de diferentes objetos, usando as funções ANGConnSetTimeSeriesValue ou ANGConnGetTimeSeriesValue. Os nomes internos dos atributos de cada tipo de objeto podem ser exibidos selecionando Window / Type no menu principal.
Formato¶
void * ANGConnCreateTimeSerieAttribute( const unsigned short* typeName, const unsigned short* internalAttrName, const unsigned short* externalAttrName, int aggregationType );
Parâmetros¶
- typeName: Nome do objeto ANG.
- internalAttrName: Nome interno do atributo.
- externalAttrName: Nome externo do atributo (como exibido nos editores do objeto).
- aggregationType: Define o tipo de agregação da série temporal. AGGREGATION_UNDEFINED, AGGREGATION_DEFAULT, AGGREGATION_MEAN, AGGREGATION_SUM, AGGREGATION_CUSTOM, AGGREGATION_MAX, AGGREGATION_MIN, AGGREGATION_STDDEV, AGGREGATION_MEDIAN, AGGREGATION_HMEAN
Saída¶
- ≠ NULL: ponteiro para o atributo.
- = NULL: Erro.
Definir valor para Atributo do Objeto ANG¶
Em C++ e Python¶
Explicação¶
Defina o valor para um atributo de um objeto ANG. Versão UNICODE.
Formato¶
void ANGConnSetAttributeValueString( void * attr, unsigned int objectId, const unsigned short * value ); // versão Unicode. Não disponível em Python.
void ANGConnSetAttributeValueStringA( void * attr, unsigned int objectId, const char * value ); // versão Ascii.
void ANGConnSetAttributeValueInt ( void * attr, unsigned int objectId, int value );
void ANGConnSetAttributeValueDouble ( void * attr, unsigned int objectId, double value );
Parâmetros¶
- attr: Ponteiro para o atributo, obtido chamando ANGConnGetAttribute ou ANGConnCreateAttribute.
- objectId: Identificador do objeto.
- value: Novo valor a ser atribuído.
Saída¶
Nenhum.
Obter valor de Atributo do Objeto ANG¶
Em C++ e Python¶
Explicação¶
Obtenha o valor de um atributo de um objeto ANG.
Formato¶
const unsigned short * ANGConnGetAttributeValueString(void * attr, unsigned int objectId); // versão Unicode. Não disponível em Python.
const char * ANGConnGetAttributeValueStringA(void * attr, unsigned int objectId); // versão Ascii.
int ANGConnGetAttributeValueInt( void * attr, unsigned int objectId );
double ANGConnGetAttributeValueDouble( void * attr, unsigned int objectId );
Parâmetros¶
- attr: Ponteiro do atributo, obtido chamando ANGConnGetAttribute ou ANGConnCreateAttribute.
- objectId: Identificador do objeto.
Saída¶
Retorna o valor, de acordo com o tipo do atributo (inteiro, double ou string).
Obter número de valores em um Atributo de Série Temporal do Objeto ANG¶
Em C++ e Python¶
Explicação¶
Obtenha o número de valores de um atributo de série temporal de um objeto ANG.
Formato¶
int ANGConnGetTimeSeriesSize( void * attr, unsigned int objectId );
Parâmetros¶
- attr: Ponteiro do atributo, obtido chamando ANGConnGetAttribute ou ANGConnCreateAttribute.
- objectId: Identificador do objeto.
Saída¶
Retorna o número de valores.
Obter valor em um Atributo de Série Temporal do Objeto ANG¶
Em C++ e Python¶
Explicação¶
Obtenha um valor de um atributo de série temporal de um objeto ANG.
Formato¶
double ANGConnGetTimeSeriesValue( void * attr, unsigned int objectId, unsigned int pos );
Parâmetros¶
- attr: Ponteiro do atributo, obtido chamando ANGConnGetAttribute ou ANGConnCreateTimeSerieAttribute.
- objectId: Identificador do objeto.
- pos: Posição do valor no atributo de Série Temporal (de 0 a (ANGConnGetTimeSeriesSize(attr, objectId )-1).
Saída¶
Retorna o valor.
Definir valor em um Atributo de Série Temporal do Objeto ANG¶
Em C++ e Python¶
Explicação¶
Defina o valor de um objeto ANG para um índice de série temporal.
Formato¶
void ANGConnSetTimeSeriesValue(void* attr, unsigned int objectId, unsigned int pos, double value, double deviation, double lowerValue);
Parâmetros¶
- attr: Ponteiro do atributo, obtido chamando ANGConnGetAttribute ou ANGConnCreateTimeSerieAttribute.
- objectId: Identificador do objeto.
- pos: Posição do valor no atributo de Série Temporal (de 0 a (ANGConnGetTimeSeriesSize(attr, objectId )-1).
- value: Valor a ser atribuído.
- deviation: Desvio ou valor do limite superior. Pode ser -1 para desvios NULL.
- lowerValue: Valor do limite inferior. Pode ser -1 para não definição de limites.